adtf::streaming::ant::IFilterGraph Class Reference

#include <filtergraph_intf.h>

Inherits adtf::streaming::ant::IFilter, and adtf::streaming::ant::IGraph.

Inherited by adtf::streaming::zebra::IFilterGraph.

Public Types
template<typename T>
using	iobject_list = adtf::ucom::ant::iobject_list<T>
	internal object resolver
template<typename T>
using	iobject_ptr = adtf::ucom::ant::iobject_ptr<T>
	used type for iobject_ptr
using	IString = adtf::base::IString
	used type for IString
typedef IFilter::tFilterState	tFilterGraphState
Public Types inherited from adtf::streaming::ant::IFilter
enum class	tFilterState : uint8_t {   State_Shutdown = 0 , State_Constructed = 1 , State_Initialized = 2 , State_Ready = 3 ,   State_Running = 4 }
Public Types inherited from adtf::streaming::ant::IRuntimeBehaviour
template<typename T>
using	iobject_ptr = adtf::ucom::ant::iobject_ptr < T >
	used iobject_ptr
template<typename T>
using	iobject_list = adtf::ucom::ant::iobject_list < T >
	used iobject_list
Public Types inherited from adtf::streaming::ant::IInterfaceBinding
template<typename T>
using	iobject_list = adtf::ucom::ant::iobject_list < T >
	used type for iobject_list
template<typename T>
using	iobject_ptr = adtf::ucom::ant::iobject_ptr < T >
	used type for iobject_ptr

Public Member Functions
	ADTF_IID (IFilterGraph, "filtergraph.ant.streaming.adtf.iid")
	definition of interface id
virtual tResult	AddConnection (const char *strName, const char *strSourceName, const char *strSourceConnector, const char *strDestinationName, const char *strDestinationConnector, int32_t ui32OrderNumber, bool bSync)=0
Public Member Functions inherited from adtf::streaming::ant::IFilter
	ADTF_IID (IFilter, "filter.ant.streaming.adtf.iid")
	definiton of interface id
virtual tResult	SetState (tFilterState eFilterState)=0
virtual tFilterState	GetState () const =0
Public Member Functions inherited from adtf::streaming::ant::INamedGraphObject
	ADTF_IID (INamedGraphObject, "namedgraphobject.ant.streaming.adtf.iid")
	defintion of interface id
virtual tResult	GetName (base::ant::IString &&strName) const =0
virtual tResult	SetName (const char *strName)=0
virtual tResult	SetParent (const ucom::ant::IObject *oParentObject)=0
virtual tResult	GetParent (const ucom::ant::IObject *&poParentObject) const =0
Public Member Functions inherited from adtf::ucom::ant::IObject
	ADTF_IID (IObject, "object.ant.ucom.adtf.iid")
Public Member Functions inherited from adtf::streaming::ant::IDataBinding
	ADTF_IID (IDataBinding, "data_binding.ant.streaming.adtf.iid")
	defintion of interface id
virtual tResult	GetPins (ucom::ant::iobject_list< IPin > &lstPins) const =0
virtual tResult	FindPin (const char *strName, ucom::ant::iobject_ptr< ucom::ant::IObject > &pPin) const =0
Public Member Functions inherited from adtf::streaming::ant::IRuntimeBehaviour
	ADTF_IID (IRuntimeBehaviour, "runtime_behaviour.ant.streaming.adtf.iid")
	defintion of interface id.
virtual tResult	GetRunners (iobject_list< IRunner > &lstRunners) const =0
virtual tResult	FindRunner (const char *strName, iobject_ptr< adtf::ucom::ant::IObject > &pRunner) const =0
virtual tResult	GetInnerPipes (iobject_list< ITriggerPipe > &lstInnerTriggerPipes) const =0
Public Member Functions inherited from adtf::streaming::ant::IInterfaceBinding
	ADTF_IID (IInterfaceBinding, "interface_binding.ant.streaming.adtf.iid")
	definition of interface id
virtual tResult	GetBindingObjects (iobject_list< IBindingObject > &lstBindingObject)=0
virtual tResult	GetBindingObjects (iobject_list< const IBindingObject > &lstBindingObject) const =0
virtual tResult	FindBindingObject (const char *strName, iobject_ptr< adtf::ucom::ant::IObject > &pIBindingObject)=0
virtual tResult	FindBindingObject (const char *strName, iobject_ptr< const adtf::ucom::ant::IObject > &pIBindingObject) const =0
Public Member Functions inherited from adtf::streaming::ant::IGraph
	ADTF_IID (IGraph, "graph.ant.streaming.adtf.iid")
	definition of interface id
virtual tResult	GetNamedGraphObject (const char *strName, ucom::ant::iobject_ptr< IObject > &pObject) const =0
virtual tResult	GetNamedGraphObjects (ucom::ant::iobject_list< INamedGraphObject > &lstItems) const =0

Protected Member Functions
	~IFilterGraph ()=default
	not desstructable
Protected Member Functions inherited from adtf::streaming::ant::IFilter
	~IFilter ()=default
	not destructable
Protected Member Functions inherited from adtf::streaming::ant::INamedGraphObject
	~INamedGraphObject ()=default
	not destructable
Protected Member Functions inherited from adtf::ucom::ant::IObject
	~IObject ()=default
	Protected destructor --> Only the final implementation can be destroyed!
Protected Member Functions inherited from adtf::streaming::ant::IDataBinding
	~IDataBinding ()=default
	not destructable
Protected Member Functions inherited from adtf::streaming::ant::IRuntimeBehaviour
	~IRuntimeBehaviour ()=default
	not destructable
Protected Member Functions inherited from adtf::streaming::ant::IInterfaceBinding
	~IInterfaceBinding ()=default
	not destructable
Protected Member Functions inherited from adtf::streaming::ant::IGraph
	~IGraph ()=default
	not desstructable

Detailed Description

Defines the Interface used to connect Filters to each other. The FilterGraph has the same states and interfaces published as a Filter. See filter graph for more information.

Member Typedef Documentation

iobject_list

template<typename T>

using adtf::streaming::ant::IFilterGraph::iobject_list = adtf::ucom::ant::iobject_list<T>

internal object resolver

used type for iobject_list

tFilterGraphState

typedef IFilter::tFilterState adtf::streaming::ant::IFilterGraph::tFilterGraphState

specifies the several types of filter states

See also

IFilter::tFilterState

Member Function Documentation

AddConnection()

virtual tResult adtf::streaming::ant::IFilterGraph::AddConnection ( const char * strName, const char * strSourceName, const char * strSourceConnector, const char * strDestinationName, const char * strDestinationConnector, int32_t ui32OrderNumber, bool bSync )

pure virtual

Adds a connection between the filtergraph elements. See filter graph_connections which connections are valid.

Parameters

[in]	strName	Name of the connection (mind also connections are named graph objects!)
[in]	strSourceName	Name of the source
[in]	strSourceConnector	Name of the source connector if any (pin, binding object, etc.)
[in]	strDestinationName	Name of the destination
[in]	strDestinationConnector	Name of the destination connector if any (pin, binding object, etc.)
[in]	ui32OrderNumber	Order number of the new conenction
[in]	bSync	synchronously or asynchronously

Return values

ERR_NOERROR	Connection is valid. Either the connection is established or will be established within a later filtergraph state.
ERR_NOT_FOUND	Destination or Destination not found
ERR_INVALID_ARG	Items are not connectable (see filter graph_connections for valid connections)

---

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

• src/libraries/streaming3/include/adtfstreaming3/filtergraph_intf.h