SST  11.1.0
StructuralSimulationToolkit
SST::Activity Class Referenceabstract

Base class for all Activities in the SST Event Queue. More...

#include <activity.h>

Inheritance diagram for SST::Activity:
SST::Core::Serialization::serializable SST::Action SST::Event SST::Clock SST::Exit SST::OneShot SST::SimulatorHeartbeat SST::StopAction SST::SyncManager SST::CoreTestComponent::coreTestComponentEvent SST::CoreTestMessageGeneratorComponent::coreTestMessage SST::Interfaces::StringEvent SST::Interfaces::TestEvent SST::NullEvent

Data Structures

class  less_priority
 Comparator class to use with STL container classes. More...
 
class  less_priority_order
 To use with STL container classes. More...
 
class  less_time
 Comparator class to use with STL container classes. More...
 
class  less_time_priority
 Comparator class to use with STL container classes. More...
 
class  less_time_priority_order
 To use with STL container classes. More...
 
class  pq_less_priority
 To use with STL priority queues, that order in reverse. More...
 
class  pq_less_priority_order
 To use with STL priority queues, that order in reverse. More...
 
class  pq_less_time_priority
 To use with STL priority queues, that order in reverse. More...
 
class  pq_less_time_priority_order
 To use with STL priority queues, that order in reverse. More...
 

Public Member Functions

virtual void execute (void)=0
 Function which will be called when the time for this Activity comes to pass. More...
 
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.
 
std::string getDeliveryTimeInfo () const
 
virtual std::string toString () const
 Get a string represenation of the event. More...
 
virtual void print (const std::string &header, Output &out) const
 Generic print-print function for this Activity. More...
 
void setQueueOrder (uint64_t order)
 Set a new Queue order.
 
uint64_t getQueueOrder ()
 
int32_t getEnforceLinkOrder ()
 
- 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
 

Protected Member Functions

void setPriority (int priority)
 Set the priority of the Activity.
 
void serialize_order (SST::Core::Serialization::serializer &ser) override
 

Protected Attributes

int32_t enforce_link_order
 

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 }
 
- 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

Base class for all Activities in the SST Event Queue.

Member Function Documentation

virtual void SST::Activity::execute ( void  )
pure virtual

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

Implemented in SST::NullEvent, SST::SyncManager, SST::Event, SST::Exit, and SST::StopAction.

virtual void SST::Activity::print ( const std::string &  header,
Output out 
) const
inlinevirtual

Generic print-print function for this Activity.

Subclasses should override this function.

Reimplemented in SST::SyncManager, SST::OneShot, SST::Exit, and SST::StopAction.

References SST::Output::output(), and toString().

virtual std::string SST::Activity::toString ( ) const
inlinevirtual

Get a string represenation of the event.

The default version will just use the name of the class, retrieved through the cls_name() function inherited from the serialzable class, which will return the name of the last class to call one of the serialization macros (ImplementSerializable(), ImplementVirtualSerializable(), or NotSerializable()). Subclasses can override this function if they want to add additional information.

Reimplemented in SST::Clock.

Referenced by print().


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