SST::Core::OneShot Class Reference
Inheritance diagram for SST::Core::OneShot:
Public Types | |
| using | HandlerBase = SSTHandlerBase<void, void> |
| Base handler for OneShot callbacks. | |
| template<typename classT, auto funcT, typename dataT = void> | |
| using | Handler = SSTHandler<void, void, classT, dataT, funcT> |
| Used to create checkpointable handlers for OneShot. | |
| using | HandlerList_t = std::vector<OneShot::HandlerBase*> |
Public Member Functions | |
| OneShot (TimeStamp_t time, OneShotManager *manager, HandlerList_t &handlers) | |
| void | execute () override |
| Function which will be called when the time for this Activity comes to pass. | |
| Public Member Functions inherited from SST::Action | |
| bool | isEvent () const override final |
| bool | isAction () const 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. | |
| virtual void | copyAllDeliveryInfo (const Activity *act) |
| 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 |
Data Fields | |
| OneShotManager * | manager |
| HandlerList_t & | handlers |
| TimeStamp_t | time |
Additional Inherited Members | |
| 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::Action | |
| void | endSimulation () |
| Called to signal to the Simulation object to end the simulation. | |
| void | endSimulation (SimTime_t end) |
| Called to signal to the Simulation object to end the simulation. | |
| void | serialize_order (SST::Core::Serialization::serializer &ser) override |
| 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. | |
| void | serialize_order (SST::Core::Serialization::serializer &ser) override |
| 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) |
Member Typedef Documentation
◆ Handler
template<typename classT, auto funcT, typename dataT = void>
| using SST::Core::OneShot::Handler = SSTHandler<void, void, classT, dataT, funcT> |
Used to create checkpointable handlers for OneShot.
The callback function is expected to be in the form of:
void func()
In which case, the class is created with:
new OneShot::Handler<classname, &classname::function_name>(this)
Or, to add static data, the callback function is:
void func(dataT data)
and the class is created with:
new OneShot::Handler<classname, &classname::function_name, dataT>(this, data)
Member Function Documentation
◆ execute()
|
overridevirtual |
Function which will be called when the time for this Activity comes to pass.
Implements SST::Activity.
The documentation for this class was generated from the following files:
- src/sst/core/impl/oneshotManager.h
- src/sst/core/impl/oneshotManager.cc
