SST  15.1.0
StructuralSimulationToolkit
Public Member Functions
SST::Profile::ClockHandlerProfileToolCount Class Reference

Profile tool that will count the number of times a handler is called. More...

#include <clockHandlerProfileTool.h>

Inheritance diagram for SST::Profile::ClockHandlerProfileToolCount:
SST::Profile::ClockHandlerProfileTool SST::Profile::ProfileTool SST::SSTHandlerBase< returnT, argT >::AttachPoint

Public Member Functions

uintptr_t registerHandler (const AttachPointMetaData &mdata) override
 Function that will be called when a handler is registered with the tool implementing the attach point. More...
 
void beforeHandler (uintptr_t key, const Cycle_t &cycle) override
 
void outputData (FILE *fp) override
 
- Public Member Functions inherited from SST::Profile::ClockHandlerProfileTool
 SST_ELI_DOCUMENT_PARAMS ({ "level", "Level at which to track profile (global, type, component, subcomponent)", "type" },) enum class Profile_Level
 
 ClockHandlerProfileTool (const std::string &name, Params &params)
 
void beforeHandler (uintptr_t UNUSED(key), const Cycle_t &UNUSED(cycle)) override
 
void afterHandler (uintptr_t UNUSED(key), const bool &UNUSED(remove)) override
 
- Public Member Functions inherited from SST::Profile::ProfileTool
std::string getName ()
 
- Public Member Functions inherited from SST::SSTHandlerBase< returnT, argT >::AttachPoint
virtual void beforeHandler (uintptr_t key, std::conditional_t< std::is_pointer_v< argT >, const std::remove_pointer_t< argT > *, const argT &> arg)=0
 Function to be called before the handler is called. More...
 
virtual void afterHandler (uintptr_t key, std::conditional_t< std::is_pointer_v< returnT >, const std::remove_pointer_t< returnT > *, const returnT &> ret_value)=0
 Function to be called after the handler is called. More...
 
virtual void serializeHandlerAttachPointKey (SST::Core::Serialization::serializer &UNUSED(ser), uintptr_t &UNUSED(key))
 Function that will be called to handle the key returned from registerHandler, if the AttachPoint tool is serializable. More...
 

Additional Inherited Members

- Protected Member Functions inherited from SST::Profile::ClockHandlerProfileTool
std::string getKeyForHandler (const AttachPointMetaData &mdata)
 
- Protected Attributes inherited from SST::Profile::ClockHandlerProfileTool
Profile_Level profile_level_
 
- Protected Attributes inherited from SST::Profile::ProfileTool
const std::string name
 

Detailed Description

Profile tool that will count the number of times a handler is called.

Member Function Documentation

◆ registerHandler()

uintptr_t SST::Profile::ClockHandlerProfileToolCount::registerHandler ( const AttachPointMetaData &  mdata)
overridevirtual

Function that will be called when a handler is registered with the tool implementing the attach point.

The metadata passed in will be dependent on what type of tool this is attached to. The uintptr_t returned from this function will be passed into the beforeHandler() and afterHandler() functions.

Parameters
mdataMetadata to be passed into the tool
Returns
Opaque key that will be passed back into beforeHandler() and afterHandler() to identify the source of the calls

Implements SST::SSTHandlerBase< returnT, argT >::AttachPoint.

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