SST::Clock::HandlerBase Class Reference

Base classes for clock handlers. More...

#include <clock.h>

Inheritance diagram for SST::Clock::HandlerBase:

Public Member Functions
void	serialize_order (SST::Core::Serialization::serializer &ser) override
	ImplementVirtualSerializable (HandlerBase)
TimeConverter	getClockPeriod ()
	Get the period of the associated clock as a SimTime_t in units of the core atomic timebase.
int	getClockPriority ()
	Get the priority of the associated clock as a SimTime_t in units of the core atomic timebase.
bool	isActive ()
	Query whether handler is currently active.
Cycle_t	activate ()
	Activate this Clock Handler.
void	deactivate ()
	Deactivate this Clock Handler.
Public Member Functions inherited from SST::SSTHandlerBase< bool, Cycle_t >
bool	operator() (Cycle_t 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

Friends
class	BaseComponent
class	Clock

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::SSTHandlerBase< bool, Cycle_t >
virtual bool	operator_impl (Cycle_t)=0
void	serialize_order (SST::Core::Serialization::serializer &ser) override
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

Base classes for clock handlers.

There are three classes:

HandlerBase: This is a publicly available class that is the base class that contains the API used by elements, including checking active status and starting and stopping the handler.

Member Function Documentation

activate()

Cycle_t SST::Clock::HandlerBase::activate ( )

inline

Activate this Clock Handler.

Returns

Time of next time clock handler will fire

getClockPeriod()

TimeConverter SST::Clock::HandlerBase::getClockPeriod ( )

inline

Get the period of the associated clock as a SimTime_t in units of the core atomic timebase.

References SST::TimeConverter::getPeriod().

isActive()

bool SST::Clock::HandlerBase::isActive ( )

inline

Query whether handler is currently active.

Referenced by SST::Clock::registerHandler(), SST::Clock::registerHandler_restart(), and SST::Clock::unregisterHandler().

serialize_order()

void SST::Clock::HandlerBase::serialize_order ( SST::Core::Serialization::serializer & ser )

inlineoverridevirtual

Implements SST::Core::Serialization::serializable_base.

---

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

• src/sst/core/clock.h