SST::Clock Class Reference

A Clock class. More...

#include <clock.h>

Inheritance diagram for SST::Clock:

Data Structures
class	Handler
	Event Handler class with user-data argument. More...
class	Handler< classT, void >
	Event Handler class without user-data. More...
class	HandlerBase
	Functor classes for Clock handling. More...

Public Member Functions
	Clock (TimeConverter *period, int priority=CLOCKPRIORITY)
	Create a new clock with a specified period.
void	schedule ()
	Activates this clock object, by inserting into the simulation's timeVortex for future execution.
Cycle_t	getNextCycle ()
	Return the time of the next clock tick.
bool	registerHandler (Clock::HandlerBase *handler)
	Add a handler to be called on this clock's tick.
bool	unregisterHandler (Clock::HandlerBase *handler, bool &empty)
	Remove a handler from the list of handlers to be called on the clock tick.
void	print (const std::string &header, Output &out) const override
	Generic print-print function for this Activity. More...
Public Member Functions inherited from SST::Activity
void	setDeliveryTime (SimTime_t time)
	Set the time for which this Activity should be delivered.
SimTime_t	getDeliveryTime () const
	Return the time at which this Activity will be delivered.
int	getPriority () const
	Return the Priority of this Activity.
void	setQueueOrder (uint64_t order)
	Set a new Queue order.
Public Member Functions inherited from SST::Core::Serialization::serializable
virtual const char *	cls_name () const =0
virtual uint32_t	cls_id () const =0
virtual std::string	serialization_name () const =0

Additional Inherited Members
Static Public Attributes inherited from SST::Core::Serialization::serializable
static constexpr uint32_t	NullClsId = std::numeric_limits<uint32_t>::max()
Protected Types inherited from SST::Core::Serialization::serializable
enum	cxn_flag_t { ConstructorFlag }
Protected Member Functions inherited from SST::Action
void	endSimulation ()
	Called to signal to the Simulation object to end the simulation.
void	endSimulation (SimTime_t end)
Protected Member Functions inherited from SST::Activity
void	setPriority (int priority)
	Set the priority of the Activity.
void	serialize_order (SST::Core::Serialization::serializer &ser) override
Static Protected Member Functions inherited from SST::Core::Serialization::serializable
static void	serializable_abort (uint32_t line, const char *file, const char *func, const char *obj)
Protected Attributes inherited from SST::Activity
int32_t	enforce_link_order

Detailed Description

A Clock class.

Calls callback functions (handlers) on a specified period

Member Function Documentation

void SST::Clock::print ( const std::string &  header, Output &  out  ) const

overridevirtual

Generic print-print function for this Activity.

Subclasses should override this function.

Reimplemented from SST::Action.

References SST::Activity::getDeliveryTime(), SST::TimeConverter::getFactor(), SST::Activity::getPriority(), and SST::Output::output().

---

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

• src/sst/core/clock.h
• src/sst/core/clock.cc