SST::RealTimeAction Class Reference

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

#include <realtimeAction.h>

Inheritance diagram for SST::RealTimeAction:

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.
virtual bool	canInitiateInteractive ()
	Lets the core know if this action may trigger an interactive console.
virtual bool	isValidSigalrmAction ()
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.

Member Function Documentation

canInitiateCheckpoint()

virtual bool SST::RealTimeAction::canInitiateCheckpoint ( )

inlinevirtual

Let's the core know if this action may trigger a checkpoint so that all the checkpoint infrastructure can be initialized.

Reimplemented in SST::CheckpointRealTimeAction, and SST::InteractiveRealTimeAction.

Referenced by SST::RealTimeManager::registerSignal().

canInitiateInteractive()

virtual bool SST::RealTimeAction::canInitiateInteractive ( )

inlinevirtual

Lets the core know if this action may trigger an interactive console.

Reimplemented in SST::InteractiveRealTimeAction.

Referenced by SST::RealTimeManager::registerSignal().

getCoreTimeBase()

UnitAlgebra SST::RealTimeAction::getCoreTimeBase

(

)

const

Get the core timebase.

References SST::Simulation::getSimulation(), SST::TimeLord::getTimeBase(), and SST::Simulation::getTimeLord().

getCurrentSimCycle()

SimTime_t SST::RealTimeAction::getCurrentSimCycle

(

)

const

Return the current simulation time as a cycle count.

References SST::Simulation::getCurrentSimCycle(), and SST::Simulation::getSimulation().

getElapsedSimTime()

UnitAlgebra SST::RealTimeAction::getElapsedSimTime

(

)

const

Return the elapsed simulation time as a time.

References SST::Simulation::getElapsedSimTime(), and SST::Simulation::getSimulation().

getEndSimCycle()

SimTime_t SST::RealTimeAction::getEndSimCycle

(

)

const

Return the end simulation time as a cycle count.

References SST::Simulation::getEndSimCycle(), and SST::Simulation::getSimulation().

getEndSimTime()

UnitAlgebra SST::RealTimeAction::getEndSimTime

(

)

const

Return the end simulation time as a time.

References SST::Simulation::getEndSimTime(), and SST::Simulation::getSimulation().

getNumRanks()

RankInfo SST::RealTimeAction::getNumRanks

(

)

const

Get the number of parallel ranks in the simulation.

References SST::Simulation::getNumRanks(), and SST::Simulation::getSimulation().

getRank()

RankInfo SST::RealTimeAction::getRank

(

)

const

Get this instance's parallel rank.

References SST::Simulation::getRank(), and SST::Simulation::getSimulation().

getSimulationOutput()

Output & SST::RealTimeAction::getSimulationOutput

(

)

const

Return the base simulation Output class instance.

References SST::Simulation::getSimulation(), and SST::Simulation::getSimulationOutput().

getSyncQueueDataSize()

uint64_t SST::RealTimeAction::getSyncQueueDataSize

(

)

const

Return the size of the SyncQueue - per-rank.

References SST::Simulation::getSimulation().

getTimeVortexMaxDepth()

uint64_t SST::RealTimeAction::getTimeVortexMaxDepth

(

)

const

Return the max depth of the TimeVortex.

References SST::Simulation::getSimulation().

simulationCheckpoint()

void SST::RealTimeAction::simulationCheckpoint

(

)

Generate a checkpoint.

References SST::Simulation::getSimulation().

simulationPrintStatus()

void SST::RealTimeAction::simulationPrintStatus

(

bool

component_status

)

Invokes printStatus on the simulation instance component_status indicates whether printStatus should also be called on all components.

References SST::Simulation::getSimulation(), and SST::Simulation::printStatus().

simulationSignalShutdown()

void SST::RealTimeAction::simulationSignalShutdown

(

bool

abnormal

)

Inform the simulation that a signal requires a shutdown abnormal indicates whether emergencyShutdown() should be called.

References SST::Simulation::getSimulation(), and SST::Simulation::signalShutdown().

---

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

• src/sst/core/realtimeAction.h
• src/sst/core/realtime.cc