SST  13.1.0
Structural Simulation Toolkit
SST::Shared::SharedObjectChangeSet Class Referenceabstract

This is the base class for holding data on changes made to the shared data on each rank. More...

#include <sharedObject.h>

Inheritance diagram for SST::Shared::SharedObjectChangeSet:
SST::Core::Serialization::serializable

Public Member Functions

 SharedObjectChangeSet (const std::string &name)
 
virtual void applyChanges (SharedObjectDataManager *UNUSED(manager))=0
 Apply the changes to the name shared data. More...
 
virtual void clear ()=0
 Clears the data. More...
 
const std::string & getName ()
 Get the name of the shared data the changeset should be applied to. More...
 
- 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
 

Protected Member Functions

void serialize_order (SST::Core::Serialization::serializer &ser) override
 
 ImplementVirtualSerializable (SharedObjectChangeSet)
 

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 }
 
- 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)
 

Detailed Description

This is the base class for holding data on changes made to the shared data on each rank.

This data will be serialized and shared with all ranks in the simulation.

Member Function Documentation

◆ applyChanges()

virtual void SST::Shared::SharedObjectChangeSet::applyChanges ( SharedObjectDataManager UNUSEDmanager)
pure virtual

Apply the changes to the name shared data.

Parameters
managerThe SharedObjectDataManager for the rank. This is used to get the named shared data.

◆ clear()

virtual void SST::Shared::SharedObjectChangeSet::clear ( )
pure virtual

Clears the data.

Used after transfering data to other ranks to prepare for the next round of init. Child classes should call this version of clear() in there implementations.

◆ getName()

const std::string& SST::Shared::SharedObjectChangeSet::getName ( )
inline

Get the name of the shared data the changeset should be applied to.

Returns
name of shared data to apply changes to

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