configuration< Interface >

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

#include <configuration.h>

Inheritance diagram for configuration< Interface >:

Public Member Functions
	configuration ()
	CTOR.
virtual	~configuration ()=default
	DTOR.
tResult	GetProperties (adtf::ucom::ant::iobject_ptr< const IProperties > &pProperties) const override
	Gets the configuration with only read access.
tResult	GetProperties (adtf::ucom::ant::iobject_ptr< IProperties > &pProperties) override
	Gets the properties of configuration with only read/write access.
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 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 IObject
	ADTF_IID (IObject, "object.ant.ucom.adtf.iid")
	Marks the IObject to be castable with the ucom_cast()

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

Additional Inherited Members
Protected Member Functions inherited from 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

Definition at line 199 of file configuration.h.

Constructor & Destructor Documentation

configuration()

template<typename Interface = IConfiguration>

configuration ( )

inline

CTOR.

Definition at line 207 of file configuration.h.

References m_pProperties, and adtf::ucom::make_object_ptr().

Member Function Documentation

AttachConfiguration()

template<typename Interface = IConfiguration>

tResult AttachConfiguration ( const char * strName, IConfiguration & pAttachedConfiguration )

inlineoverride

Definition at line 235 of file configuration.h.

DetachConfiguration()

template<typename Interface = IConfiguration>

tResult DetachConfiguration ( const char * strName )

inlineoverride

Definition at line 246 of file configuration.h.

GetProperties() [1/2]

template<typename Interface = IConfiguration>

tResult 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.

Definition at line 218 of file configuration.h.

References m_pProperties, iobject_ptr_base< T >::Reset(), and RETURN_NOERROR.

Referenced by cConfigurableFilter::GetProperties(), and cConfigurableFilter::GetProperties().

GetProperties() [2/2]

template<typename Interface = IConfiguration>

tResult 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.

Definition at line 228 of file configuration.h.

References m_pProperties, iobject_ptr_base< T >::Reset(), and RETURN_NOERROR.

RegisterPropertyVariable()

template<typename Interface>

tResult RegisterPropertyVariable	(	const char *	strName,
		cPropertyVariable &	oPropertyVariable )

Definition at line 711 of file configuration.h.

UnregisterPropertyVariable()

template<typename Interface = IConfiguration>

tResult UnregisterPropertyVariable ( cPropertyVariable & oPropertyVariable )

inlinevirtual

Implements IMemberPropertyUnregister.

Definition at line 255 of file configuration.h.

Member Data Documentation

m_pProperties

template<typename Interface = IConfiguration>

adtf::ucom::object_ptr<spider::cProperties> m_pProperties = nullptr

protected

the current runtiem property set

Definition at line 203 of file configuration.h.

Referenced by configuration(), GetProperties(), and GetProperties().