SST  14.1.0
StructuralSimulationToolkit
SST::RealTimeAction Class Referenceabstract

An event to trigger at a real-time interval. More...

#include <realtimeAction.h>

Inheritance diagram for SST::RealTimeAction:
SST::AlrmSignalAction SST::CheckpointRealTimeAction SST::ComponentStatusRealTimeAction SST::CoreStatusRealTimeAction SST::ExitCleanRealTimeAction SST::ExitEmergencyRealTimeAction SST::HeartbeatRealTimeAction

Public Member Functions

virtual void begin (time_t UNUSED(scheduled_time))
 
virtual void execute ()=0
 
virtual bool canInitiateCheckpoint ()
 Let's the core know if this action may trigger a checkpoint so that all the checkpoint infrastructure can be initialized.
 
UnitAlgebra getCoreTimeBase () const
 Get the core timebase.
 
SimTime_t getCurrentSimCycle () const
 Return the current simulation time as a cycle count.
 
UnitAlgebra getElapsedSimTime () const
 Return the elapsed simulation time as a time.
 
SimTime_t getEndSimCycle () const
 Return the end simulation time as a cycle count.
 
UnitAlgebra getEndSimTime () const
 Return the end simulation time as a time.
 
RankInfo getRank () const
 Get this instance's parallel rank.
 
RankInfo getNumRanks () const
 Get the number of parallel ranks in the simulation.
 
Output & getSimulationOutput () const
 Return the base simulation Output class instance.
 
uint64_t getTimeVortexMaxDepth () const
 Return the max depth of the TimeVortex.
 
uint64_t getSyncQueueDataSize () const
 Return the size of the SyncQueue - per-rank.
 
void getMemPoolUsage (int64_t &bytes, int64_t &active_entries)
 Return MemPool usage information - per-rank.
 
void simulationPrintStatus (bool component_status)
 Invokes printStatus on the simulation instance component_status indicates whether printStatus should also be called on all components.
 
void simulationSignalShutdown (bool abnormal)
 Inform the simulation that a signal requires a shutdown abnormal indicates whether emergencyShutdown() should be called.
 
void simulationCheckpoint ()
 Generate a checkpoint.
 
void initiateInteractive (const std::string &msg)
 

Detailed Description

An event to trigger at a real-time interval.


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