SST  14.0.0
StructuralSimulationToolkit
Public Member Functions | Friends
SST::TimeConverter Class Reference

A class to convert between a component's view of time and the core's view of time. More...

#include <timeConverter.h>

Public Member Functions

SimTime_t convertToCoreTime (SimTime_t time) const
 Converts from the component's view to the core's view of time. More...
 
SimTime_t convertFromCoreTime (SimTime_t time) const
 Converts from the core's view to the components's view of time. More...
 
SimTime_t getFactor () const
 
UnitAlgebra getPeriod () const
 

Friends

class TimeLord
 

Detailed Description

A class to convert between a component's view of time and the core's view of time.

Member Function Documentation

◆ convertFromCoreTime()

SimTime_t SST::TimeConverter::convertFromCoreTime ( SimTime_t  time) const
inline

Converts from the core's view to the components's view of time.

The result is truncated, not rounded.

Parameters
timetime to convert from core time

Referenced by SST::BaseComponent::getCurrentSimTime(), SST::BaseComponent::getCurrentSimTimeMicro(), SST::BaseComponent::getCurrentSimTimeMilli(), and SST::BaseComponent::getCurrentSimTimeNano().

◆ convertToCoreTime()

SimTime_t SST::TimeConverter::convertToCoreTime ( SimTime_t  time) const
inline

Converts from the component's view to the core's view of time.

Parameters
timetime to convert to core time

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

◆ getFactor()

SimTime_t SST::TimeConverter::getFactor ( ) const
inline
Returns
The factor used for conversions with Core Time

Referenced by SST::SimulatorHeartbeat::execute(), SST::Simulation_impl::getNextClockCycle(), SST::TimeLord::getSimCycles(), SST::OneShot::print(), SST::Simulation_impl::reregisterClock(), SST::Clock::schedule(), SST::Link::setDefaultTimeBase(), SST::Clock::toString(), SST::Simulation_impl::unregisterClock(), and SST::Clock::updateCurrentCycle().

◆ getPeriod()

UnitAlgebra SST::TimeConverter::getPeriod ( ) const
Returns
The period represented by this TimeConverter as a UnitAlgebra

References SST::TimeLord::getTimeBase(), and SST::Simulation_impl::getTimeLord().

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