SST  11.0.0
StructuralSimulationToolkit
SST::Clock::Handler< classT, argT > Class Template Reference

Event Handler class with user-data argument. More...

#include <clock.h>

Inheritance diagram for SST::Clock::Handler< classT, argT >:
SST::Clock::HandlerBase

Public Member Functions

 Handler (classT *const object, PtrMember member, argT data)
 Constructor. More...
 
bool operator() (Cycle_t cycle) override
 Calls underlying handler function, passing in the current cycle count and additional metadata supplied by the user. More...
 

Detailed Description

template<typename classT, typename argT = void>
class SST::Clock::Handler< classT, argT >

Event Handler class with user-data argument.

Template Parameters
classTType of the Object
argTType of the argument

Constructor & Destructor Documentation

template<typename classT , typename argT = void>
SST::Clock::Handler< classT, argT >::Handler ( classT *const  object,
PtrMember  member,
argT  data 
)
inline

Constructor.

Parameters
object- Pointer to Object upon which to call the handler
member- Member function to call as the handler
data- Additional argument to pass to handler

Member Function Documentation

template<typename classT , typename argT = void>
bool SST::Clock::Handler< classT, argT >::operator() ( Cycle_t  cycle)
inlineoverridevirtual

Calls underlying handler function, passing in the current cycle count and additional metadata supplied by the user.

If the hander function returns true, the handler will be removed from the clock list.

Implements SST::Clock::HandlerBase.


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