adtf::base::ant::configuration< Interface > Class Template Reference

#include <configuration.h>

Inherits adtf::ucom::catwo::object< IConfiguration, IConfiguration >, and adtf::base::ant::IMemberPropertyUnregister.

Inherited by adtf::filter::ant::cTriggerFunctionBase, adtf::filter::flash::cTriggerFunction, and adtf::filter::hollow::cTriggerFunction.

Public Member Functions
	configuration ()
	CTOR.
virtual	~configuration ()=default
	DTOR.
tResult	GetProperties (adtf::ucom::ant::iobject_ptr< const IProperties > &pProperties) const override
tResult	GetProperties (adtf::ucom::ant::iobject_ptr< IProperties > &pProperties) override
tResult	AttachConfiguration (const char *strName, IConfiguration &pAttachedConfiguration) override
tResult	DetachConfiguration (const char *strName) override
tResult	RegisterPropertyVariable (const char *strName, cPropertyVariable &oPropertyVariable)
tResult	UnregisterPropertyVariable (cPropertyVariable &oPropertyVariable)
Public Member Functions inherited from adtf::ucom::catwo::object< IConfiguration, IConfiguration >
tResult	GetInterface (const char *i_strIID, void *&o_pInterface) override
	Query interfaces on an object.
tResult	GetInterface (const char *i_strIID, const void *&o_pInterface) const override
	Provides const correct interface querying.
void	Destroy () const override
	Switch from non-virtual destructor to virtual destructor.
tResult	GetInterface (const char *i_strIID, void *&o_pInterface) override
	Query interfaces on an object.
tResult	GetInterface (const char *i_strIID, const void *&o_pInterface) const override
	Provides const correct interface querying.
void	Destroy () const override
	Switch from non-virtual destructor to virtual destructor.
tResult	GetInterface (const char *i_strIID, void *&o_pInterface) override
	Query interfaces on an object.
tResult	GetInterface (const char *i_strIID, const void *&o_pInterface) const override
	Provides const correct interface querying.
void	Destroy () const override
	Switch from non-virtual destructor to virtual destructor.
Public Member Functions inherited from adtf::ucom::ant::IObject
	ADTF_IID (IObject, "object.ant.ucom.adtf.iid")

Protected Attributes
adtf::ucom::object_ptr< spider::cProperties >	m_pProperties = nullptr
	the current runtiem property set

Additional Inherited Members
Protected Member Functions inherited from adtf::ucom::ant::IObject
	~IObject ()=default
	Protected destructor --> Only the final implementation can be destroyed!

Detailed Description

template<typename Interface = IConfiguration>
class adtf::base::ant::configuration< Interface >

Implementation helper template to enriches an implementation with the default implementation of IConfiguration.

Template Parameters

Interface

The interface type which derives from IConfiguration

Member Function Documentation

GetProperties() [1/2]

template<typename Interface = IConfiguration>

tResult adtf::base::ant::configuration< Interface >::GetProperties ( adtf::ucom::ant::iobject_ptr< const IProperties > & pProperties ) const

inlineoverride

Gets the configuration with only read access.

Parameters

pProperties

[in, out] object_ptr to the filter configuration.

GetProperties() [2/2]

template<typename Interface = IConfiguration>

tResult adtf::base::ant::configuration< Interface >::GetProperties ( adtf::ucom::ant::iobject_ptr< IProperties > & pProperties )

inlineoverride

Gets the properties of configuration with only read/write access.

Parameters

pProperties

[in, out] object_ptr to the filter configuration.

UnregisterPropertyVariable()

template<typename Interface = IConfiguration>

tResult adtf::base::ant::configuration< Interface >::UnregisterPropertyVariable ( cPropertyVariable & oPropertyVariable )

inlinevirtual

Callback to unregister the given property variable from observed properties set.

Parameters

[in]

oPropertyVariable

The property variable to unregister.

Returns

Standard result.

Implements adtf::base::ant::IMemberPropertyUnregister.

---

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

• src/libraries/base/include/adtfbase/configuration.h