cConfigurableFilter

Enriches the adtf::streaming::ant::cFilterBase class with the configuration. More...

Inheritance diagram for cConfigurableFilter:

Public Types
typedef base::ant::configuration	base_type_conf
	used base type
typedef streaming::ant::cFilterBase	base_type_filter

Public Member Functions
tResult	GetProperties (ucom::ant::iobject_ptr< const base::ant::IProperties > &pProperties) const override
	Gets the properties with read access. More...
tResult	GetProperties (ucom::ant::iobject_ptr< base::ant::IProperties > &pProperties) override
	Gets the properties with read access. More...
tResult	AttachConfiguration (const char *strName, base::ant::IConfiguration &oAttachedConfiguration) override
	Attaches the given configuration and its properties as property tree item of this. More...
tResult	DetachConfiguration (const char *strName) override
	Detaches a configuration with the specified name. More...
Public Member Functions inherited from object< streaming::ant::cFilterBase, base::ant::configuration<> >
tResult	GetInterface (const char *i_strIID, void *&o_pInterface) override
	Query interfaces on an object. More...
tResult	GetInterface (const char *i_strIID, const void *&o_pInterface) const override
	Provides const correct interface querying. More...
void	Destroy () const override
	Destruct and deallocate instantiations of type IObject. More...
Public Member Functions inherited from IObject
	ADTF_IID (IObject, "object.ant.ucom.adtf.iid")
	Marks the IObject to be castable with the ucom_cast() More...

Protected Member Functions
	cConfigurableFilter ()=default
	CTOR.
virtual	~cConfigurableFilter ()=default
	DTOR.
Protected Member Functions inherited from IObject
	~IObject ()=default
	Protected destructor --> Use implemented Destroy() instead of delete!

Detailed Description

Enriches the adtf::streaming::ant::cFilterBase class with the configuration.

This is the base class for filters those have properties.

Definition at line 32 of file filtersdk/include/adtffiltersdk/filter.h.

Member Function Documentation

AttachConfiguration()

tResult AttachConfiguration ( const char *  strName, base::ant::IConfiguration &  oAttachedConfiguration  )

inlineoverride

Attaches the given configuration and its properties as property tree item of this.

Parameters

[in]	strName	name of the tree item.
[in]	oAttachedConfiguration	configuration which properties are attached.

Returns

Standard Result Code

Definition at line 60 of file filtersdk/include/adtffiltersdk/filter.h.

DetachConfiguration()

tResult DetachConfiguration ( const char *  strName )

inlineoverride

Detaches a configuration with the specified name.

Parameters

[in]

strName

name of the tree item.

Returns

Standard Result Code

Return values

ERR_NOT_FOUND

The tree item with strName was not found.

Definition at line 65 of file filtersdk/include/adtffiltersdk/filter.h.

GetProperties() [1/2]

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

inlineoverride

Gets the properties with read access.

Parameters

[in,out]

pProperties

object_ptr to the objects properties.

Returns

Standard Result Code

Definition at line 55 of file filtersdk/include/adtffiltersdk/filter.h.

GetProperties() [2/2]

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

inlineoverride

Gets the properties with read access.

Parameters

[in,out]

pProperties

object_ptr to the objects properties.

Returns

Standard Result Code

Definition at line 50 of file filtersdk/include/adtffiltersdk/filter.h.

References configuration< Interface >::GetProperties().