esp::core::AbstractManagedObject class
#include <esp/core/managedContainers/AbstractManagedObject.h>

This abstract base class provides the interface of expected functionality for an object to be manageable by esp::core::ManagedContainer class template specializations. Any class that inherits from this class properly can be managed by a esp::core::ManagedContainer specilization.

Contents

Derived classes

template<class T>
class esp::physics::AbstractManagedPhysicsObject
Base class template for wrapper for physics objects of all kinds to enable Managed Container access.
template<class T>
class esp::physics::AbstractManagedPhysicsObject
Base class template for wrapper for physics objects of all kinds to enable Managed Container access.
class AbstractFileBasedManagedObject
template<class T>
class esp::physics::AbstractManagedPhysicsObject
Base class template for wrapper for physics objects of all kinds to enable Managed Container access.

Constructors, destructors, conversion operators

~AbstractManagedObject() defaulted virtual

Public functions

auto getClassKey() const -> std::string pure virtual
Get the instancing class of the ManagedObject instance. Should only be set from implementer's constructor. Used as key in constructor function pointer maps in esp::core::ManagedContainer.
void setHandle(const std::string& handle) pure virtual
Set this ManagedObject name/origin. Some ManagedObject derive their own names based on their state, such as esp::metadata::attributes::AbstractPrimitiveAttributes; in such cases this should be overridden with NOP.
auto getHandle() const -> std::string pure virtual
Retrieve this object's unique handle.
void setID(int ID) pure virtual
Set the unique ID referencing ManagedObject.
auto getID() const -> int pure virtual
Retrieve this object's unique ID.
auto getObjectInfo() const -> std::string pure virtual
Retrieve a comma-separated informational string about the contents of this managed object.
auto getObjectInfoHeader() const -> std::string pure virtual
Retrieve a comma-separated list of the values the getObjectInfo method returns.

Protected functions

void setClassKey(const std::string&) pure virtual

Function documentation

void esp::core::AbstractManagedObject::setHandle(const std::string& handle) pure virtual

Set this ManagedObject name/origin. Some ManagedObject derive their own names based on their state, such as esp::metadata::attributes::AbstractPrimitiveAttributes; in such cases this should be overridden with NOP.

Parameters
handle the handle to set.

std::string esp::core::AbstractManagedObject::getHandle() const pure virtual

Retrieve this object's unique handle.

Returns The handle of the object

void esp::core::AbstractManagedObject::setID(int ID) pure virtual

Set the unique ID referencing ManagedObject.

Parameters
ID the ID for this object.

int esp::core::AbstractManagedObject::getID() const pure virtual

Retrieve this object's unique ID.

Returns Unique ID for this object.