ADTF  3.18.2
cFilterGraph

A Filter Graph that supports properties and property links. More...

Inheritance diagram for cFilterGraph:
[legend]

Public Member Functions

 cFilterGraph ()
 CTOR.
 
 ~cFilterGraph () override
 DTOR.
 
tResult AddNamedGraphObject (const ucom::ant::iobject_ptr< INamedGraphObject > &pItem, int32_t ui32OrderNumber) override
 
tResult GetProperties (ucom::ant::iobject_ptr< const base::ant::IProperties > &pProperties) const override
 Retrieves readable properties object of a Filter Graph. More...
 
tResult GetProperties (ucom::ant::iobject_ptr< base::ant::IProperties > &pProperties) override
 Retrieves writeable properties object of a Filter Graph. More...
 
tResult AttachConfiguration (const char *strName, base::ant::IConfiguration &oAttachedConfiguration) override
 Attaches a configuration to the Filter Graph under a specified name. More...
 
tResult DetachConfiguration (const char *strName) override
 Detaches a configuration attached with AttachConfiguration. More...
 
tResult AddPropertyLink (const char *strSourcePropertyName, const char *strTargetObject, const char *strTargetProperty)
 Adds a link between a graph property and a property of a graph component. More...
 
void DisableObjectInitializationUponAdd ()
 Disables modification of the state when adding objects. More...
 
- Public Member Functions inherited from object< ant::cFilterGraph, base::ant::IConfiguration >
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 Attributes

std::unique_ptr< cImplementation > m_pImplementation
 

Additional Inherited Members

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

Detailed Description

A Filter Graph that supports properties and property links.

See also
sec_filter_graph

Definition at line 221 of file filtergraph.h.

Member Function Documentation

◆ AddPropertyLink()

tResult AddPropertyLink ( const char *  strSourcePropertyName,
const char *  strTargetObject,
const char *  strTargetProperty 
)

Adds a link between a graph property and a property of a graph component.

Parameters
[in]strSourcePropertyNameThe name of the graph property.
[in]strTargetObjectThe name of the target object.
[in]strTargetPropertyThe name of the target property.
Returns
Standard result.

◆ AttachConfiguration()

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

Attaches a configuration to the Filter Graph under a specified name.

Parameters
strNamename of the configiration to attach
oAttachedConfigurationthe configiration to attach
Returns
tResult

◆ DetachConfiguration()

tResult DetachConfiguration ( const char *  strName)
override

Detaches a configuration attached with AttachConfiguration.

Parameters
strNamename of the configiration to deattach
Returns
tResult

◆ DisableObjectInitializationUponAdd()

void DisableObjectInitializationUponAdd ( )

Disables modification of the state when adding objects.

Use SetState() later on.

◆ GetProperties() [1/2]

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

Retrieves writeable properties object of a Filter Graph.

Parameters
pPropertiesthe properties object of the Filter Graph
Returns
tResult

◆ GetProperties() [2/2]

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

Retrieves readable properties object of a Filter Graph.

Parameters
pPropertiesthe properties object of the Filter Graph
Returns
tResult