SST 16.0.0
Structural Simulation Toolkit
SST::Core::Serialization::ObjectMapContainer< T > Class Template Reference

Class used to map containers. More...

#include <objectMap.h>

Inheritance diagram for SST::Core::Serialization::ObjectMapContainer< T >:
SST::Core::Serialization::ObjectMapWithChildren SST::Core::Serialization::ObjectMap

Public Member Functions

 ObjectMapContainer (T *addr)
bool isContainer () const final override
 Check to see if this ObjectMap represents a container.
std::string getType () const override
 Get the type of the variable represented by the ObjectMap.
void * getAddr () const override
 Get the address of the variable represented by the ObjectMap.
void refresh () override
 Refresh the ObjectMap, reconstructing children.
Public Member Functions inherited from SST::Core::Serialization::ObjectMapWithChildren
 ~ObjectMapWithChildren () override
 Destructor.
 ObjectMapWithChildren (const ObjectMapWithChildren &)=delete
 Disallow copying and assignment.
ObjectMapWithChildrenoperator= (const ObjectMapWithChildren &)=delete
void addVariable (const std::string &name, ObjectMap *obj) final override
 Adds a variable to this ObjectMap.
void removeVariable (const std::string &name) final override
 Removes a variable from this ObjectMap.
const ObjectMultimap & getVariables () const final override
 Get the list of child variables contained in this ObjectMap.
void refresh () override
 Refresh the children.
Public Member Functions inherited from SST::Core::Serialization::ObjectMap
 ObjectMap ()=default
 Default constructor primarily used for the "top" object in the hierarchy.
bool isReadOnly () const
 Check to see if this object is read-only.
void setReadOnly (bool state=true)
 Set the read-only state of the object.
virtual bool checkValue (const std::string &UNUSED(value)) const
 Check if value string is valid for this type.
std::string getName () const
 Get the name of the variable represented by this ObjectMap.
std::string getFullName () const
 Get the full hierarchical name of the variable represented by this ObjectMap, based on the path taken to get to this object.
void incRefCount ()
 Increment the reference counter for this ObjectMap.
void decRefCount ()
 Decrement the reference counter for this ObjectMap.
size_t getRefCount () const
 Get the current reference count.
virtual ObjectMapComparisongetComparison (const std::string &UNUSED(name), ObjectMapComparison::Op UNUSED(op), const std::string &UNUSED(value)) const
 Get a watch point for this object.
virtual ObjectMapComparisongetComparisonVar (const std::string &UNUSED(name), ObjectMapComparison::Op UNUSED(op), const std::string &UNUSED(name2), ObjectMap *UNUSED(var2)) const
virtual ObjectBuffergetObjectBuffer (const std::string &UNUSED(name), size_t UNUSED(sz))
ObjectMapselectParent ()
 Get the parent for this ObjectMap.
ObjectMapselectVariable (std::string name, bool &loop_detected, bool confirm=false)
 Get the ObjectMap for the specified variable.
virtual void addVariable (const std::string &UNUSED(name), ObjectMap *UNUSED(obj))
 Adds a variable to this ObjectMap.
virtual void removeVariable (const std::string &UNUSED(name))
 Removes a variable from this ObjectMap.
virtual std::string get () const
 Get the value of the variable as a string.
void set (const std::string &value)
 Sets the value of the variable represented by the ObjectMap to the specified value, which is represented as a string.
virtual std::string get (const std::string &var)
 Gets the value of the specified variable as a string.
virtual void set (const std::string &var, const std::string &value, bool &found, bool &read_only)
 Sets the value of the specified variable to the specified value, which is represented as a string.
virtual bool isFundamental () const
 Check to see if this ObjectMap represents a fundamental or a class treated as a fundamental.
virtual ~ObjectMap ()=default
 Destructor.
 ObjectMap (const ObjectMap &)=delete
 Disallow copying and assignment.
ObjectMapoperator= (const ObjectMap &)=delete
virtual std::string listVariable (std::string name, bool &found, int recurse=0)
 Create a string that lists information for the specified variable.
virtual std::string list (int recurse=0)
 Create a string that lists information for the current object.
ObjectMapfindVariable (const std::string &name, bool confirm=false) const
 Find a variable in this object map.

Protected Attributes

T * addr_
Protected Attributes inherited from SST::Core::Serialization::ObjectMapWithChildren
ObjectMultimap variables_
 Map that child ObjectMaps are stored in.
Protected Attributes inherited from SST::Core::Serialization::ObjectMap
ObjectMapMetaDatamdata_ = nullptr
 Metadata object for walking the object hierarchy.
bool read_only_ = false
 Indicates whether or not the variable is read-only.

Additional Inherited Members

Static Public Member Functions inherited from SST::Core::Serialization::ObjectMap
static std::string demangle_name (const char *name)
 Static function to demangle type names returned from typeid(T).name().
Protected Member Functions inherited from SST::Core::Serialization::ObjectMapWithChildren
 ObjectMapWithChildren ()=default
 Default constructor.
Protected Member Functions inherited from SST::Core::Serialization::ObjectMap
virtual void set_impl (const std::string &UNUSED(value))
 Function implemented by derived classes to implement set().
virtual void activate_callback ()
 Function that will get called when this object is selected.
virtual void deactivate_callback ()
 Function that will get called when this object is deactivated (i.e selectParent() is called).

Detailed Description

template<class T>
class SST::Core::Serialization::ObjectMapContainer< T >

Class used to map containers.

Member Function Documentation

◆ getAddr()

template<class T>
void * SST::Core::Serialization::ObjectMapContainer< T >::getAddr ( ) const
inlineoverridevirtual

Get the address of the variable represented by the ObjectMap.

Returns
Address of variable

Implements SST::Core::Serialization::ObjectMap.

◆ getType()

template<class T>
std::string SST::Core::Serialization::ObjectMapContainer< T >::getType ( ) const
inlineoverridevirtual

Get the type of the variable represented by the ObjectMap.

Returns
Type of variable

Implements SST::Core::Serialization::ObjectMap.

References SST::Core::Serialization::ObjectMap::demangle_name().

◆ isContainer()

template<class T>
bool SST::Core::Serialization::ObjectMapContainer< T >::isContainer ( ) const
inlinefinaloverridevirtual

Check to see if this ObjectMap represents a container.

Returns
true if this ObjectMap represents a container, false otherwise

Reimplemented from SST::Core::Serialization::ObjectMap.

◆ refresh()

template<class T>
void SST::Core::Serialization::ObjectMapContainer< T >::refresh ( )
inlineoverridevirtual

Refresh the ObjectMap, reconstructing children.

Reimplemented from SST::Core::Serialization::ObjectMap.

References SST::Core::Serialization::ObjectMapWithChildren::variables_.


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