SST  13.0.0
StructuralSimulationToolkit
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. More...
 
TimeConvertergetTimeConverter (const UnitAlgebra &ts)
 Create a new TimeConverter object using the specified units. More...
 
UnitAlgebra getTimeBase () const
 Return the Time Base of the TimeLord.
 
TimeConvertergetNano ()
 Return a TimeConverter which represents Nanoseconds.
 
TimeConvertergetMicro ()
 Return a TimeConverter which represents Microseconds.
 
TimeConvertergetMilli ()
 Return a TimeConverter which represents Milliseconds.
 
SimTime_t getSimCycles (const std::string &timeString, const std::string &where)
 Not a Public API. More...
 

Friends

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

Detailed Description

Class for creating and managing TimeConverter objects.

Member Function Documentation

◆ 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(), SST::Link::addSendLatency(), and SST::Simulation_impl::setStopAtCycle().

◆ 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).

Referenced by SST::BaseComponent::getCurrentSimTime(), SST::Link::getDefaultTimeBase(), getSimCycles(), getTimeConverter(), SST::Simulation_impl::registerClock(), and SST::BaseComponent::registerTimeBase().

◆ getTimeConverter() [2/2]

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

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