SST  13.1.0
Structural Simulation Toolkit
SST::Event Class Reference

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::MemPoolItem SST::Core::Serialization::serializable SST::CoreTest::MessageMesh::MessageEvent SST::CoreTestComponent::coreTestComponentEvent SST::CoreTestMemPoolTest::MemPoolTestEvent1 SST::CoreTestMemPoolTest::MemPoolTestEvent2 SST::CoreTestMemPoolTest::MemPoolTestEvent3 SST::CoreTestMemPoolTest::MemPoolTestEvent4 SST::CoreTestMemPoolTest::MemPoolTestPerformanceEvent SST::CoreTestMessageGeneratorComponent::coreTestMessage SST::EmptyEvent SST::Interfaces::StringEvent SST::Interfaces::TestEvent SST::NullEvent

Public Types

using HandlerBase = SSTHandlerBase< void, Event * >
 Base handler for event delivery.
 
template<typename classT , typename dataT = void>
using Handler = SSTHandler< void, Event *, classT, dataT >
 Used to create handlers for event delivery. More...
 
typedef std::pair< uint64_t, int > id_type
 Type definition of unique identifiers.
 

Public Member Functions

virtual Eventclone ()
 Clones the event in for the case of a broadcast.
 
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 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.
 
std::string toString () const override
 Get a string represenation of the event. More...
 
- Public Member Functions inherited from SST::Core::MemPoolItem
void * operator new (std::size_t size) noexcept
 Allocates memory from a memory pool for a new Activity.
 
void operator delete (void *ptr)
 Returns memory for this Activity to the appropriate memory pool. More...
 
virtual void print (const std::string &header, Output &out) const
 
- 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)
 Constant, default value for id_types.
 
- Static Public Attributes inherited from SST::Core::Serialization::serializable
static constexpr uint32_t NullClsId = std::numeric_limits<uint32_t>::max()
 

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 (uint64_t priority)
 Set the priority of the Activity.
 
std::string getDeliveryTimeInfo () const
 Gets the delivery time info as a string. More...
 
 ImplementVirtualSerializable (SST::Activity) void setQueueOrder(uint64_t order)
 Set a new Queue order.
 

Friends

class Link
 
class NullEvent
 
class RankSync
 
class ThreadSync
 

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 Typedef Documentation

◆ Handler

template<typename classT , typename dataT = void>
using SST::Event::Handler = SSTHandler<void, Event*, classT, dataT>

Used to create handlers for event delivery.

The callback function is expected to be in the form of:

void func(Event* event)

In which case, the class is created with:

new Event::Handler<classname>(this, &classname::function_name)

Or, to add static data, the callback function is:

void func(Event* event, dataT data)

and the class is created with:

new Event::Handler<classname, dataT>(this, &classname::function_name, data)


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