SST  7.2.0
StructuralSimulationToolkit
SST::OneShot Class Reference

A OneShot Event class. More...

#include <oneshot.h>

Inheritance diagram for SST::OneShot:
SST::Action SST::Activity SST::Core::Serialization::serializable

Data Structures

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

Public Member Functions

 OneShot (TimeConverter *timeDelay, int priority=ONESHOTPRIORITY)
 Create a new One Shot for a specified time that will callback the handler function. More...
 
bool isScheduled ()
 Is OneShot scheduled.
 
void registerHandler (OneShot::HandlerBase *handler)
 Add a handler to be called on this OneShot Event.
 
void print (const std::string &header, Output &out) const override
 Print details about the OneShot.
 
- 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

- Protected Types inherited from SST::Core::Serialization::serializable
enum  cxn_flag_t { ConstructorFlag }
 
- Protected Member Functions inherited from SST::Action
void endSimulation ()
 Called to signal to the Simulation object to end the simulation.
 
void endSimulation (SimTime_t end)
 
- Protected Member Functions inherited from SST::Activity
void setPriority (int priority)
 Set the priority of the Activity.
 
void serialize_order (SST::Core::Serialization::serializer &ser) override
 
- 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::Activity
int32_t enforce_link_order
 

Detailed Description

A OneShot Event class.

Calls callback functions (handlers) on a specified period

Constructor & Destructor Documentation

◆ OneShot()

SST::OneShot::OneShot ( TimeConverter timeDelay,
int  priority = ONESHOTPRIORITY 
)

Create a new One Shot for a specified time that will callback the handler function.

Note: OneShot cannot be canceled, and will always callback after the timedelay.

References SST::Activity::setPriority().


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