SST 16.0.0
Structural Simulation Toolkit
SST::TimeVortex Class Referenceabstract

Primary Event Queue. More...

#include <timeVortex.h>

Inheritance diagram for SST::TimeVortex:
SST::ActivityQueue SST::IMPL::TimeVortexBinnedMapBase< false > SST::IMPL::TimeVortexBinnedMapBase< true > SST::IMPL::TimeVortexPQBase< false > SST::IMPL::TimeVortexPQBase< true > SST::IMPL::TimeVortexBinnedMapBase< TS > SST::IMPL::TimeVortexPQBase< TS > SST::IMPL::TimeVortexBinnedMap SST::IMPL::TimeVortexBinnedMap_ts SST::IMPL::TimeVortexPQ SST::IMPL::TimeVortexPQ_ts

Public Member Functions

virtual bool empty () override=0
 Returns true if the queue is empty.
virtual int size () override=0
 Returns the number of activities in the queue.
virtual void insert (Activity *activity) override=0
 Insert a new activity into the queue.
virtual Activity * pop () override=0
 Remove and return the next activity.
virtual Activity * front () override=0
 Returns the next activity.
virtual void print (Output &out) const
 Print the state of the TimeVortex.
virtual uint64_t getMaxDepth () const
virtual uint64_t getCurrentDepth () const =0
virtual void dbg_print (Output &out) const
virtual void serialize_order (SST::Core::Serialization::serializer &ser)
virtual void getContents (std::vector< Activity * > &activities) const =0
 Get a copy of the contents of the TimeVortex.

Protected Attributes

uint64_t max_depth

Detailed Description

Primary Event Queue.

Member Function Documentation

◆ empty()

virtual bool SST::TimeVortex::empty ( )
overridepure virtual

Returns true if the queue is empty.

Implements SST::ActivityQueue.

Implemented in SST::IMPL::TimeVortexBinnedMapBase< TS >, SST::IMPL::TimeVortexBinnedMapBase< false >, SST::IMPL::TimeVortexBinnedMapBase< true >, SST::IMPL::TimeVortexPQBase< TS >, SST::IMPL::TimeVortexPQBase< false >, and SST::IMPL::TimeVortexPQBase< true >.

◆ front()

virtual Activity * SST::TimeVortex::front ( )
overridepure virtual

Returns the next activity.

Implements SST::ActivityQueue.

Implemented in SST::IMPL::TimeVortexBinnedMapBase< TS >, SST::IMPL::TimeVortexBinnedMapBase< false >, SST::IMPL::TimeVortexBinnedMapBase< true >, SST::IMPL::TimeVortexPQBase< TS >, SST::IMPL::TimeVortexPQBase< false >, and SST::IMPL::TimeVortexPQBase< true >.

◆ getContents()

virtual void SST::TimeVortex::getContents ( std::vector< Activity * > & activities) const
pure virtual

Get a copy of the contents of the TimeVortex.

Returns
vector with a copy of the contents

Implemented in SST::IMPL::TimeVortexPQBase< TS >, SST::IMPL::TimeVortexPQBase< false >, and SST::IMPL::TimeVortexPQBase< true >.

Referenced by print().

◆ insert()

virtual void SST::TimeVortex::insert ( Activity * activity)
overridepure virtual

Insert a new activity into the queue.

Implements SST::ActivityQueue.

Implemented in SST::IMPL::TimeVortexBinnedMapBase< TS >, SST::IMPL::TimeVortexBinnedMapBase< false >, SST::IMPL::TimeVortexBinnedMapBase< true >, SST::IMPL::TimeVortexPQBase< TS >, SST::IMPL::TimeVortexPQBase< false >, and SST::IMPL::TimeVortexPQBase< true >.

◆ pop()

virtual Activity * SST::TimeVortex::pop ( )
overridepure virtual

Remove and return the next activity.

Implements SST::ActivityQueue.

Implemented in SST::IMPL::TimeVortexBinnedMapBase< TS >, SST::IMPL::TimeVortexBinnedMapBase< false >, SST::IMPL::TimeVortexBinnedMapBase< true >, SST::IMPL::TimeVortexPQBase< TS >, SST::IMPL::TimeVortexPQBase< false >, and SST::IMPL::TimeVortexPQBase< true >.

◆ print()

void SST::TimeVortex::print ( Output & out) const
virtual

Print the state of the TimeVortex.

Reimplemented in SST::IMPL::TimeVortexBinnedMapBase< TS >, SST::IMPL::TimeVortexBinnedMapBase< false >, and SST::IMPL::TimeVortexBinnedMapBase< true >.

References getContents().

◆ size()

virtual int SST::TimeVortex::size ( )
overridepure virtual

Returns the number of activities in the queue.

Implements SST::ActivityQueue.

Implemented in SST::IMPL::TimeVortexBinnedMapBase< TS >, SST::IMPL::TimeVortexBinnedMapBase< false >, SST::IMPL::TimeVortexBinnedMapBase< true >, SST::IMPL::TimeVortexPQBase< TS >, SST::IMPL::TimeVortexPQBase< false >, and SST::IMPL::TimeVortexPQBase< true >.

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