SST 16.0.0
Structural Simulation Toolkit
SST::Interfaces::StringEvent Class Reference

Simple event to pass strings between components. More...

#include <stringEvent.h>

Inheritance diagram for SST::Interfaces::StringEvent:
SST::Event SST::Activity SST::Core::MemPoolItem SST::Core::Serialization::serializable SST::Core::Serialization::serializable_base

Public Member Functions

 StringEvent (const std::string &str)
 Create a new StringEvent.
virtual Event * clone () override
 Clone a StringEvent.
const std::string & getString ()
 Returns the contents of this Event.
void serialize_order (SST::Core::Serialization::serializer &ser) override
 ImplementSerializable (SST::Interfaces::StringEvent)
Public Member Functions inherited from SST::Event
bool isEvent () const override final
bool isAction () const override final
void copyAllDeliveryInfo (const Activity *act) override final
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.
void setQueueOrder (uint64_t order)
 Set a new Queue order.
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.
virtual void print (const std::string &header, Output &out) const
Public Member Functions inherited from SST::Core::Serialization::serializable_base
virtual const char * cls_name () const =0
virtual uint32_t cls_id () const =0
virtual std::string serialization_name () const =0

Additional Inherited Members

Public Types inherited from SST::Event
using HandlerBase = SSTHandlerBase<void, Event*>
 Base handler for event delivery.
template<typename classT, auto funcT, typename dataT = void>
using Handler = SSTHandler<void, Event*, classT, dataT, funcT>
 Used to create handlers for event delivery.
using id_type = std::pair<uint64_t, int>
 Type definition of unique identifiers.
Static Public Attributes inherited from SST::Event
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()
Static Public Attributes inherited from SST::Core::Serialization::serializable_base
static constexpr uint32_t NullClsId = std::numeric_limits<uint32_t>::max()
Protected Types inherited from SST::Core::Serialization::serializable_base
enum  cxn_flag_t { ConstructorFlag }
Protected Member Functions inherited from SST::Event
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.
 ImplementVirtualSerializable (SST::Activity)
Static Protected Member Functions inherited from SST::Core::Serialization::serializable_base
static void serializable_abort (uint32_t line, const char *file, const char *func, const char *obj)

Detailed Description

Simple event to pass strings between components.

Constructor & Destructor Documentation

◆ StringEvent()

SST::Interfaces::StringEvent::StringEvent ( const std::string & str)
inlineexplicit

Create a new StringEvent.

Parameters
str- The String contents of this event

Member Function Documentation

◆ clone()

virtual Event * SST::Interfaces::StringEvent::clone ( )
inlineoverridevirtual

Clone a StringEvent.

Reimplemented from SST::Event.

◆ serialize_order()

void SST::Interfaces::StringEvent::serialize_order ( SST::Core::Serialization::serializer & ser)
inlineoverridevirtual

Reimplemented from SST::Event.


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