adtf::filter::ant::cConfigurableFilter Class Reference

#include <filter.h>

Inherits adtf::ucom::catwo::object< streaming::ant::cFilterBase, base::ant::configuration<> >.

Inherited by adtf::filter::ant::cFilter.

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
tResult	GetProperties (ucom::ant::iobject_ptr< base::ant::IProperties > &pProperties) override
tResult	AttachConfiguration (const char *strName, base::ant::IConfiguration &oAttachedConfiguration) override
tResult	DetachConfiguration (const char *strName) override
Public Member Functions inherited from adtf::ucom::catwo::object< streaming::ant::cFilterBase, base::ant::configuration<> >
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 Member Functions
	cConfigurableFilter ()=default
	CTOR.
virtual	~cConfigurableFilter ()=default
	DTOR.
Protected Member Functions inherited from adtf::ucom::ant::IObject
	~IObject ()=default
	Protected destructor --> Only the final implementation can be destroyed!

Detailed Description

Enriches the adtf::streaming::ant::cFilterBase class with the configuration. This is the base class for filters those have properties.

Member Function Documentation

AttachConfiguration()

tResult adtf::filter::ant::cConfigurableFilter::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

Deprecated

Attachments are deprecated, they suffer from issues with observers.

DetachConfiguration()

tResult adtf::filter::ant::cConfigurableFilter::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.

Deprecated

Attachments are deprecated, they suffer from issues with observers.

GetProperties() [1/2]

tResult adtf::filter::ant::cConfigurableFilter::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

GetProperties() [2/2]

tResult adtf::filter::ant::cConfigurableFilter::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

---

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

• src/libraries/filtersdk/include/adtffiltersdk/filter.h