SST::SimulatorHeartbeat Class Reference

An optional heartbeat to show progress in a simulation. More...

#include <heartbeat.h>

Inheritance diagram for SST::SimulatorHeartbeat:

Public Member Functions
	SimulatorHeartbeat (Config *cfg, int this_rank, Simulation *sim, TimeConverter period)
	Create a new heartbeat object for the simulation core to show progress.
void	schedule ()
void	serialize_order (SST::Core::Serialization::serializer &ser) override
ImplementSerializable(SST::SimulatorHeartbeat) private	SimulatorHeartbeat (const SimulatorHeartbeat &)=delete
SimulatorHeartbeat &	operator= (const SimulatorHeartbeat &)=delete
void	execute () override
	Function which will be called when the time for this Activity comes to pass.
Public Member Functions inherited from SST::Action
bool	isEvent () const override final
bool	isAction () const override final
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	setOrderTag (uint32_t tag)
	Sets the order tag.
uint32_t	getOrderTag () const
	Return the order tag associated with this activity.
uint64_t	getQueueOrder () const
	Returns the queue order associated with this activity.
std::string	toString () const override
	Get a string represenation of the event.
void	setQueueOrder (uint64_t order)
	Set a new Queue order.
virtual void	copyAllDeliveryInfo (const Activity *act)
Public Member Functions inherited from SST::Core::MemPoolItem
void *	operator new (std::size_t size) noexcept
	Allocates memory from a memory pool for a new Activity.
void	operator delete (void *ptr)
	Returns memory for this Activity to the appropriate memory pool.
virtual void	print (const std::string &header, Output &out) const
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

Data Fields
int	rank
TimeConverter	m_period
double	lastTime

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::Action
void	endSimulation ()
	Called to signal to the Simulation object to end the simulation.
void	endSimulation (SimTime_t end)
	Called to signal to the Simulation object to end the simulation.
Protected Member Functions inherited from SST::Activity
void	setPriority (uint64_t priority)
	Set the priority of the Activity.
std::string	getDeliveryTimeInfo () const
	Gets the delivery time info as a string.
	ImplementVirtualSerializable (SST::Activity)
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

An optional heartbeat to show progress in a simulation.

Member Function Documentation

execute()

void SST::SimulatorHeartbeat::execute ( )

overridevirtual

Function which will be called when the time for this Activity comes to pass.

Implements SST::Activity.

References execute(), SST::Simulation::getCurrentSimCycle(), SST::Simulation::getElapsedSimTime(), SST::Simulation::getSimulation(), SST::Simulation::getSimulationOutput(), SST::Simulation::insertActivity(), SST::Output::output(), and SST::UnitAlgebra::toStringBestSI().

Referenced by execute().

serialize_order()

void SST::SimulatorHeartbeat::serialize_order ( SST::Core::Serialization::serializer & ser )

overridevirtual

Reimplemented from SST::Action.

---

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

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