C++ group Util::Helper::ObjectExtensions
ObjectExtensions

Description

ObjectExtensions can be used to dynamically extend objects inheriting from AttributeProvider with data and functionality at runtime. Internally, it is a unified interface for several different GenericAttributes. There are two types of extensions: 1. non polymorphic and 2. polymorphic.

class MyExtension{
        PROVIDES_TYPE_NAME_NV(MyExtension)
        int someValue;
    public:
        MyExtension(int _someValue) : someValue(_someValue){}
        int getValue()const {   return someValue;   }
}
...
MyObject * a = new MyObject; // MyObject---|>AttributeProvider
Util::addObjectExtension<MyExtension>(42);
...
Util::requireObjectExtension<MyExtension>(a)->getValue();

Functions

Documentation

function
addObjectExtension

Create and add an extension of type extension_t to the givenobject.

• Additional parameters are passed to the extension’s constructor.

• The extension’s name is inquired by calling extension_t::getObjectExtensionName() or extension_t::getClassId()

• The created extension is returned.

_{Defined in Util/ObjectExtension.h:167}

function
addObjectExtension

Create and add an extension of type extension_t to the givenobjectnamedextName.

See also: addObjectExtension (obj, params…)

_{Defined in Util/ObjectExtension.h:175}

function
getObjectExtension

If the givenobjecthas a extension of type extension_t, it is returned; nullptr otherwise.

• The extension’s name is inquired by calling extension_t::getObjectExtensionName() or extension_t::getClassId()

_{Defined in Util/ObjectExtension.h:182}

function
getObjectExtension

If the givenobjecthas a extension of type extension_t namedextName, it is returned; nullptr otherwise.

See also: getObjectExtension(obj)

_{Defined in Util/ObjectExtension.h:189}

function
requireObjectExtension

If the givenobjecthas a extension of type extension_t, it is returned; otherwise, an exception is thrown.

• The extension’s name is inquired by calling extension_t::getObjectExtensionName() or extension_t::getClassId().

_{Defined in Util/ObjectExtension.h:196}

function
requireObjectExtension

If the givenobjecthas a extension of type extension_t namedextName, it is returned; otherwise, an exception is thrown.

• The extension’s name is inquired by calling extension_t::getObjectExtensionName() or extension_t::getClassId().

_{Defined in Util/ObjectExtension.h:203}

function
hasObjectExtension

Returns true iff theobjecthas a extension of type extension_t.

• The extension’s name is inquired by calling extension_t::getObjectExtensionName() or extension_t::getClassId().

_{Defined in Util/ObjectExtension.h:212}

function
hasObjectExtension

Returns true iff theobjecthas a extension of type extension_t namedextName.

_{Defined in Util/ObjectExtension.h:217}