esp/core/managedContainers/ManagedContainer.h file

Class Template esp::core::managedContainers::ManagedContainer : container functionality to manage esp::core::managedContainers::AbstractManagedObject objects.

Namespaces

namespace esp
Root namespace.
namespace esp::core
Core Habitat functionality.
namespace esp::core::managedContainers

Classes

template<class T, ManagedObjectAccess Access>
class esp::core::managedContainers::ManagedContainer
Class template defining responsibilities and functionality for managing esp::core::managedContainers::AbstractManagedObject constructs.

Enums

enum class ManagedObjectPreregistration { Failed, Success, Success_Use_Object_Handle }
This enum describes the return status from preregistration conditioning of attributes. Preregistration is performed by preRegisterObjectFinalize , which will conduct any type-specific initialization and/or validation that might be required before an object is registered (i.e. saved in the ManagedContainer). The return status of this preregistration specifies how the registration proceess should proceed.
enum class ManagedObjectAccess { Copy, Share }
This enum describes how objects held in the ManagedConatainer are accessed.

Enum documentation

enum class ManagedObjectPreregistration

This enum describes the return status from preregistration conditioning of attributes. Preregistration is performed by preRegisterObjectFinalize , which will conduct any type-specific initialization and/or validation that might be required before an object is registered (i.e. saved in the ManagedContainer). The return status of this preregistration specifies how the registration proceess should proceed.

Enumerators
Failed

The preregistration processing failed for some reason, and the managed object will not be registered.

Success

The preregistration succeeded, the object can be registered with the given handle.

Success_Use_Object_Handle

The preregistration succeeded, but the object has a self-derived registration handle that must be used. (i.e. PrimitiveAttributes)

enum class ManagedObjectAccess

This enum describes how objects held in the ManagedConatainer are accessed.

Enumerators
Copy

When an object is requested to be retrieved, a copy is made and returned. Modifications to this object will only take place if the object is registered.

Share

When an object is requested to be retrieved, a reference to the object itself is returned, and all changes will be tracked without registration.