SST  7.2.0
StructuralSimulationToolkit
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::Core::Serialization::serializable_type< StringEvent > SST::Activity SST::Core::Serialization::serializable

Public Member Functions

 StringEvent (const std::string &str)
 Create a new StringEvent. More...
 
 StringEvent (const StringEvent &me)
 Copies an existing StringEvent.
 
 StringEvent (const StringEvent *me)
 Copies an existing StringEvent.
 
const std::string & getString (void)
 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
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...
 
- 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
 

Additional Inherited Members

- Public Types inherited from SST::Event
typedef std::pair< uint64_t, int > id_type
 Type definition of unique identifiers.
 
- Static Public Attributes inherited from SST::Event
static const id_type NO_ID = std::make_pair(0, -1)
 Constatn, default value for id_types.
 
- Protected Types inherited from SST::Core::Serialization::serializable
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 (int priority)
 Set the priority of the Activity.
 
- 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)
 
- Protected Attributes inherited from SST::Event
Linkdelivery_link
 Link used for delivery.
 
- Protected Attributes inherited from SST::Activity
int32_t enforce_link_order
 

Detailed Description

Simple event to pass strings between components.

Constructor & Destructor Documentation

◆ StringEvent()

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

Create a new StringEvent.

Parameters
str- The String contents of this event

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