SST 15.0
Structural Simulation Toolkit
SST::SSTHandlerBase< void, argT > Class Template Referenceabstract

Base template for handlers which take an class defined argument. More...

#include <ssthandler.h>

Inheritance diagram for SST::SSTHandlerBase< void, argT >:
SST::Core::Serialization::serializable SST::Core::Serialization::serializable SST::Core::Serialization::serializable_base SST::Core::Serialization::serializable_base

Data Structures

class  AttachPoint
 Attach Point to get notified when a handler starts and stops. More...
 
class  InterceptPoint
 Attach Point to intercept the data being delivered by a Handler. More...
 

Public Member Functions

void operator() (argT arg)
 
void attachTool (AttachPoint *tool, const AttachPointMetaData &mdata)
 Attaches a tool to the AttachPoint.
 
void detachTool (AttachPoint *tool)
 Remove an attached tool.
 
void attachInterceptTool (InterceptPoint *tool, const AttachPointMetaData &mdata)
 Attaches a tool to the AttachPoint.
 
void detachInterceptTool (InterceptPoint *tool)
 Remove an attached tool.
 
void transferAttachedToolInfo (SSTHandlerBase *handler)
 Transfers attached tools from existing handler.
 
void operator() (argT arg)
 
void attachTool (AttachPoint *tool, const AttachPointMetaData &mdata)
 Attaches a tool to the AttachPoint.
 
void detachTool (AttachPoint *tool)
 Remove an attached tool.
 
void transferAttachedToolInfo (SSTHandlerBase *handler)
 Transfers attached tools from existing handler.
 
- 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
 

Protected Member Functions

virtual void operator_impl (argT)=0
 
void serialize_order (SST::Core::Serialization::serializer &ser) override
 
virtual void operator_impl (argT)=0
 
void serialize_order (SST::Core::Serialization::serializer &ser) override
 

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 }
 
- 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

template<typename argT>
class SST::SSTHandlerBase< void, argT >

Base template for handlers which take an class defined argument.

This expansion covers the case of void return type. This version supports intercepts.

Member Function Documentation

◆ attachInterceptTool()

template<typename argT>
void SST::SSTHandlerBase< void, argT >::attachInterceptTool ( InterceptPoint * tool,
const AttachPointMetaData & mdata )
inline

Attaches a tool to the AttachPoint.

Parameters
toolTool to attach
mdataMetadata to pass to the tool

References SST::SSTHandlerBase< void, argT >::InterceptPoint::registerHandlerIntercept().

◆ attachTool() [1/2]

void SST::SSTHandlerBase< void, argT >::attachTool ( AttachPoint * tool,
const AttachPointMetaData & mdata )
inline

Attaches a tool to the AttachPoint.

Parameters
toolTool to attach
mdataMetadata to pass to the tool

◆ attachTool() [2/2]

template<typename argT>
void SST::SSTHandlerBase< void, argT >::attachTool ( AttachPoint * tool,
const AttachPointMetaData & mdata )
inline

Attaches a tool to the AttachPoint.

Parameters
toolTool to attach
mdataMetadata to pass to the tool

References SST::SSTHandlerBase< void, argT >::AttachPoint::registerHandler().

◆ detachInterceptTool()

template<typename argT>
void SST::SSTHandlerBase< void, argT >::detachInterceptTool ( InterceptPoint * tool)
inline

Remove an attached tool.

Parameters
toolTool to remove. If tool doesn't exist, then no action is taken

◆ detachTool() [1/2]

void SST::SSTHandlerBase< void, argT >::detachTool ( AttachPoint * tool)
inline

Remove an attached tool.

Parameters
toolTool to remove. If tool doesn't exist, then no action is taken

◆ detachTool() [2/2]

template<typename argT>
void SST::SSTHandlerBase< void, argT >::detachTool ( AttachPoint * tool)
inline

Remove an attached tool.

Parameters
toolTool to remove. If tool doesn't exist, then no action is taken

◆ serialize_order() [1/2]

void SST::SSTHandlerBase< void, argT >::serialize_order ( SST::Core::Serialization::serializer & ser)
inlineoverrideprotectedvirtual

◆ serialize_order() [2/2]

template<typename argT>
void SST::SSTHandlerBase< void, argT >::serialize_order ( SST::Core::Serialization::serializer & ser)
inlineoverrideprotectedvirtual

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