SST  12.0.1
StructuralSimulationToolkit
SST::StopAction Class Reference

Action which causes the Simulation to end. More...

#include <stopAction.h>

Inheritance diagram for SST::StopAction:
SST::Action SST::Activity SST::Core::Serialization::serializable

Public Member Functions

 StopAction (const std::string &msg)
 Create a new StopAction which includes a message to be printed when it fires.
 
void execute () override
 Function which will be called when the time for this Activity comes to pass. More...
 
void print (const std::string &header, Output &out) const override
 Generic print-print function for this Activity. More...
 
- Public Member Functions inherited from SST::Activity
void setDeliveryTime (SimTime_t time)
 Set the time for which this Activity should be delivered.
 
SimTime_t getDeliveryTime () const
 Return the time at which this Activity will be delivered.
 
int getPriority () const
 Return the Priority of this Activity.
 
void setOrderTag (uint32_t tag)
 Sets the order tag.
 
uint32_t getOrderTag () const
 Return the order tag associated with this activity.
 
uint64_t getQueueOrder () const
 Returns the queue order associated with this activity.
 
virtual std::string toString () const
 Get a string represenation of the event. More...
 
- Public Member Functions inherited from SST::Core::Serialization::serializable
virtual const char * cls_name () const =0
 
virtual uint32_t cls_id () const =0
 
virtual std::string serialization_name () const =0
 

Additional Inherited Members

- Static Public Attributes inherited from SST::Core::Serialization::serializable
static constexpr uint32_t NullClsId = std::numeric_limits<uint32_t>::max()
 
- Protected Types inherited from SST::Core::Serialization::serializable
enum  cxn_flag_t { ConstructorFlag }
 
- Protected Member Functions inherited from SST::Action
void endSimulation ()
 Called to signal to the Simulation object to end the simulation.
 
void endSimulation (SimTime_t end)
 
- Protected Member Functions inherited from SST::Activity
void setPriority (uint64_t priority)
 Set the priority of the Activity.
 
std::string getDeliveryTimeInfo () const
 Gets the delivery time info as a string. More...
 
void serialize_order (SST::Core::Serialization::serializer &ser) override
 
void setQueueOrder (uint64_t order)
 Set a new Queue order.
 
- Static Protected Member Functions inherited from SST::Core::Serialization::serializable
static void serializable_abort (uint32_t line, const char *file, const char *func, const char *obj)
 

Detailed Description

Action which causes the Simulation to end.

Member Function Documentation

void SST::StopAction::execute ( )
inlineoverridevirtual

Function which will be called when the time for this Activity comes to pass.

Implements SST::Activity.

References SST::Action::endSimulation().

void SST::StopAction::print ( const std::string &  header,
Output out 
) const
inlineoverridevirtual

Generic print-print function for this Activity.

Subclasses should override this function.

Reimplemented from SST::Activity.

References SST::Activity::getDeliveryTime(), and SST::Output::output().


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