SST 15.0
Structural Simulation Toolkit
SST::TimeLord Class Reference

Class for creating and managing TimeConverter objects. More...

#include <timeLord.h>

Public Member Functions

TimeConvertergetTimeConverter (const std::string &ts)
 Create a new TimeConverter object using specified SI Units.
 
TimeConvertergetTimeConverter (const UnitAlgebra &ts)
 Create a new TimeConverter object using the specified units.
 
UnitAlgebra getTimeBase () const
 
TimeConvertergetNano ()
 
TimeConvertergetMicro ()
 
TimeConvertergetMilli ()
 
SimTime_t getSimCycles (const std::string &timeString, const std::string &where)
 Not a Public API.
 

Friends

class SST::Simulation
 
class SST::Simulation_impl
 
class SST::Link
 
class SST::BaseComponent
 

Detailed Description

Class for creating and managing TimeConverter objects.

Member Function Documentation

◆ getMicro()

TimeConverter * SST::TimeLord::getMicro ( )
inline
Returns
TimeConverter which represents Microseconds

◆ getMilli()

TimeConverter * SST::TimeLord::getMilli ( )
inline
Returns
TimeConverter which represents Milliseconds

◆ getNano()

TimeConverter * SST::TimeLord::getNano ( )
inline
Returns
TimeConverter which represents Nanoseconds

◆ getSimCycles()

SimTime_t SST::TimeLord::getSimCycles ( const std::string & timeString,
const std::string & where )

Not a Public API.

Returns the number of raw simulation cycles given by a specified time string

References SST::TimeConverter::getFactor(), and getTimeConverter().

Referenced by SST::Link::addRecvLatency(), and SST::Link::addSendLatency().

◆ getTimeBase()

◆ getTimeConverter() [1/2]

TimeConverter * SST::TimeLord::getTimeConverter ( const std::string & ts)

Create a new TimeConverter object using specified SI Units.

For example, "1 Ghz" (1 Gigahertz), "2.5 ns" (2.5 nanoseconds).

Parameters
tsString indicating the base unit for this object. The string should be a floating point number followed by a prefix, and then frequency (i.e. Hz) or time unit (s). Allowable seconds prefixes are: 'f' (fempto), 'p' (pico), 'n' (nano), 'u' (micro), 'm' (milli). Allowable frequency prefixes are 'k' (kilo), 'M' (mega), and 'G' (giga).

References getTimeConverter().

Referenced by SST::Link::getDefaultTimeBase(), SST::Link::getDefaultTimeBase(), getSimCycles(), SST::InteractiveConsole::getTimeConverter(), getTimeConverter(), getTimeConverter(), and SST::Simulation_impl::minPartToTC().

◆ getTimeConverter() [2/2]

TimeConverter * SST::TimeLord::getTimeConverter ( const UnitAlgebra & ts)

The documentation for this class was generated from the following files: