esp::metadata::managers::SensorAttributesManager class

#include <esp/metadata/managers/SensorAttributesManager.h>

Base classes

template<class T, ManagedObjectAccess Access>

class AbstractAttributesManager<attributes::AbstractSensorAttributes, ManagedObjectAccess::Copy>

Class template defining responsibilities and functionality for managing esp::metadata::attributes::AbstractAttributes constructs.

Public static variables

static const std::map<sensor::SensorSubType, const std::string> SenssorAttrsTypeNamesMap

Constant Map holding names of concrete SensorAttributes classes, keyed by SensorSubtype enum values used to denote them.

Constructors, destructors, conversion operators

SensorAttributesManager()

Public functions

template<typename T>

auto createAttributesFromSensorSpec(const sensor::SensorSpec::ptr& sensorSpec, bool registerTemplate = true) -> std::shared_ptr<T>

Create an attributes from a SensorSpec.

auto createObject(const std::string& sensorClassName, bool registerTemplate = true) -> attributes::AbstractSensorAttributes::ptr override

Should only be called internally. Creates an instance of a sensor attributes template described by the passed string.

auto buildObjectFromJSONDoc(const std::string& filename, const io::JsonGenericValue& jsonConfig) -> attributes::AbstractSensorAttributes::ptr override

Parse passed JSON Document specifically for esp::metadata::attributes::AbstractSensorAttributes object. It always returns a valid esp::metadata::attributes::AbstractSensorAttributes shared_ptr object.

void setValsFromJSONDoc(attributes::AbstractSensorAttributes::ptr attribs, const io::JsonGenericValue& jsonConfig) override

Method to take an existing attributes and set its values from passed json config file.

void finalizeAttrPathsBeforeRegister(const attributes::AbstractSensorAttributes::ptr& attributes) const override

This function will be called to finalize attributes' paths before registration, moving fully qualified paths to the appropriate hidden attribute fields. This can also be called without registration to make sure the paths specified in an attributes are properly configured.

Protected types

using Map_Of_SensorTypeCtors = std::unordered_map<std::string, attributes::AbstractSensorAttributes::ptr(SensorAttributesManager::*)()>

Define a map type referencing function pointers to createSensorAttributes() keyed by esp::sensor::SensorSubType corresponding to sensor classes being instanced,.

Protected functions

auto createAttributesFromSensorSpecInternal(const sensor::SensorSpec::ptr& sensorSpec, bool registerTemplate) -> attributes::AbstractSensorAttributes::ptr

Internal only. Create an attributes from a SensorSpec.

auto initNewObjectInternal(const std::string& handleName, bool builtFromConfig) -> attributes::AbstractSensorAttributes::ptr override

Used Internally. Create and configure newly-created attributes with any default values, before any specific values are set.

template<typename T>

auto createSensorAttributes() -> attributes::AbstractSensorAttributes::ptr

Build a shared pointer to the appropriate attributes for passed object type as defined in PrimObjTypes, where each entry except PrimObjTypes::END_PRIM_OBJ_TYPES corresponds to a Magnum Primitive type.

void deleteObjectInternalFinalize(int templateID, const std::string& templateHandle) override

This method will perform any necessary updating that is AbstractAttributesManager-specific upon template removal, such as removing a specific template handle from the list of file-based template handles in ObjectAttributesManager. This should only be called esp::core::managedContainers::ManagedContainerBase.

auto preRegisterObjectFinalize(attributes::AbstractSensorAttributes::ptr object, const std::string& objectHandle, bool forceRegistration) -> core::managedContainers::ManagedObjectPreregistration override

This method will perform any essential updating to the managed object before registration is performed. If this updating fails, registration will also fail. In the case of SensorAttributes, it will verify the handle syntax and uniqueness.

void postRegisterObjectHandling(int objectID, const std::string& objectHandle) override

Not required for this manager.

void resetFinalize() override

Any AbstractSensorAttributes-attributes-specific resetting that needs to happen on ManagedContainerBase::reset().

Protected variables

Map_Of_SensorTypeCtors sensorTypeConstructorMap_

Map of function pointers to instantiate a sennsor attributes object,.

Function documentation