SST  14.1.0
StructuralSimulationToolkit
SST::InteractiveConsole Class Referenceabstract
Inheritance diagram for SST::InteractiveConsole:
SST::IMPL::Interactive::SimpleDebugger

Public Member Functions

 SST_ELI_DECLARE_INFO_EXTERN (ELI::ProvidesParams) InteractiveConsole()
 
Create a new checkpoint object for the simulation core to initiate checkpoints
 
virtual void execute (const std::string &msg)=0
 Called by TimeVortex to trigger checkpoint on simulation clock interval - not used in parallel simulation.
 

Protected Member Functions

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.
 
OutputgetSimulationOutput () 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.
 
TimeConvertergetTimeConverter (const std::string &time)
 Get a TimeConverter.
 
void getComponentList (std::vector< std::pair< std::string, SST::Component *>> &vec)
 Get the list of Components.
 
void simulationRun (SimTime_t time)
 Runs the simulation the specified number of core time base units. More...
 
void schedule_interactive (SimTime_t time_offset, const std::string &msg)
 Schedules the action for execution at the current simulation time plus time_offset. More...
 
SST::Core::Serialization::ObjectMapgetComponentObjectMap ()
 

Member Function Documentation

◆ schedule_interactive()

void SST::InteractiveConsole::schedule_interactive ( SimTime_t  time_offset,
const std::string &  msg 
)
protected

Schedules the action for execution at the current simulation time plus time_offset.

Parameters
time_offsetTime in units of core time base

References getCurrentSimCycle(), SST::Simulation_impl::getSimulation(), and SST::Simulation_impl::insertActivity().

◆ simulationRun()

void SST::InteractiveConsole::simulationRun ( SimTime_t  time)
protected

Runs the simulation the specified number of core time base units.

Parameters
timeTime in units of core time base

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