SST 16.0.0
Structural Simulation Toolkit
SST::SSTHandlerBase< returnT, argT > Class Template Referenceabstract

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

#include <ssthandler.h>

Inheritance diagram for SST::SSTHandlerBase< returnT, argT >:
SST::Core::Serialization::serializable SST::Core::Serialization::serializable_base SST::SSTHandler< int, int, classT, dataT, funcT > SST::SSTHandler< returnT, argT, classT, dataT, funcT > SST::SSTHandler< returnT, argT, classT, void, funcT > SST::SSTHandler< returnT, argT, classT, dataT, funcT > SST::SSTHandler< returnT, argT, classT, dataT, funcT > SST::SSTHandler< returnT, argT, classT, void, funcT >

Data Structures

class  AttachPoint
 Attach Point to get notified when a handler starts and stops. More...

Public Member Functions

returnT 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 returnT 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 returnT, typename argT>
class SST::SSTHandlerBase< returnT, argT >

Base template for handlers which take a class defined argument.

This default expansion covers the case of non-void return type. This version does not support intercepts.

Member Function Documentation

◆ attachTool()

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

Attaches a tool to the AttachPoint.

Parameters
toolTool to attach
mdataMetadata to pass to the tool

◆ detachTool()

template<typename returnT, typename argT>
void SST::SSTHandlerBase< returnT, 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()

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

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