SST  7.1.0
StructuralSimulationToolkit
SST::Event Class Referenceabstract

Base class for Events - Items sent across links to communicate between components. More...

#include <event.h>

Inheritance diagram for SST::Event:
SST::Activity SST::Core::Serialization::serializable SST::Interfaces::StringEvent SST::Interfaces::TestEvent SST::NullEvent

Data Structures

class  Handler
 Event Handler class with user-data argument. More...
 
class  Handler< classT, void >
 Event Handler class with no user-data. More...
 
class  HandlerBase
 Functor classes for Event handling. More...
 

Public Types

typedef std::pair< uint64_t, int > id_type
 Type definition of unique identifiers.
 

Public Member Functions

void execute (void) override
 Cause this event to fire.
 
virtual Eventclone ()
 Clones the event in for the case of a broadcast.
 
void setDeliveryLink (LinkId_t id, Link *link)
 Sets the link id used for delivery. More...
 
LinkgetDeliveryLink ()
 Gets the link id used for delivery. More...
 
void setRemoteEvent ()
 For use by SST Core only.
 
LinkId_t getLinkId (void) const
 Gets the link id associated with this event. More...
 
virtual void print (const std::string &header, Output &out) const override
 Virtual function to "pretty-print" this event. More...
 
void serialize_order (SST::Core::Serialization::serializer &ser) override
 
- 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 setQueueOrder (uint64_t order)
 Set a new Queue order.
 
- 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
 

Static Public Attributes

static const id_type NO_ID = std::make_pair(0, -1)
 Constatn, default value for id_types.
 

Protected Member Functions

id_type generateUniqueId ()
 Generates an ID that is unique across ranks, components and events.
 
- Protected Member Functions inherited from SST::Activity
void setPriority (int priority)
 Set the priority of the Activity.
 

Protected Attributes

Linkdelivery_link
 Link used for delivery.
 
- Protected Attributes inherited from SST::Activity
int32_t enforce_link_order
 

Additional Inherited Members

- 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 Events - Items sent across links to communicate between components.

Member Function Documentation

◆ getDeliveryLink()

Link* SST::Event::getDeliveryLink ( )
inline

Gets the link id used for delivery.

For use by SST Core only

References delivery_link.

◆ getLinkId()

◆ print()

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

Virtual function to "pretty-print" this event.

Should be implemented by subclasses.

Reimplemented from SST::Activity.

Reimplemented in SST::NullEvent.

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

◆ setDeliveryLink()

void SST::Event::setDeliveryLink ( LinkId_t  id,
Link link 
)
inline

Sets the link id used for delivery.

For use by SST Core only

References delivery_link.

Referenced by SST::Link::sendInitData(), and SST::Interfaces::StringEvent::StringEvent().


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