IFilterGraphabstract
Defines the Interface used to connect Filters to each other. More...
Inheritance diagram for IFilterGraph:
Public Types | |
| 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 | |
| using | IString = adtf::base::IString |
| used type for IString | |
| typedef IFilter::tFilterState | tFilterGraphState |
| specifies the several types of filter states More... | |
 Public Types inherited from IFilter | |
| enum class | tFilterState : uint8_t { State_Shutdown = 0 , State_Constructed = 1 , State_Initialized = 2 , State_Ready = 3 , State_Running = 4 } |
| specifies the several types of filter states More... | |
| Public Types inherited from 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 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 | |
| UCOM_RESOLVE (adtf::ucom::ant::IObject, IGraph) | |
| internal object resolver | |
| virtual tResult | AddConnection (const char *strName, const char *strSourceName, const char *strSourceConnector, const char *strDestinationName, const char *strDestinationConnector, int32_t ui32OrderNumber, bool bSync)=0 |
| Adds a connection between the filtergraph elements. More... | |
| Public Member Functions inherited from IFilter | |
| ADTF_IID (IFilter, "filter.ant.streaming.adtf.iid") | |
| definiton of interface id | |
| virtual tResult | SetState (tFilterState eFilterState)=0 |
| Sets the state of the filter. More... | |
| virtual tFilterState | GetState () const =0 |
| Retrieves the state of the filter. More... | |
| Public Member Functions inherited from INamedGraphObject | |
| ADTF_IID (INamedGraphObject, "namedgraphobject.ant.streaming.adtf.iid") | |
| defintion of interface id | |
| virtual tResult | GetName (base::ant::IString &&strName) const =0 |
Gets the Name of the object to the IString rvalue reference strName. More... | |
| virtual tResult | SetName (const char *strName)=0 |
| Sets the Name of the object. More... | |
| virtual tResult | SetParent (const ucom::ant::IObject *oParentObject)=0 |
| Sets the Parent of the object. More... | |
| virtual tResult | GetParent (const ucom::ant::IObject *&poParentObject) const =0 |
| Retrieves the Parent of the object. 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... | |
| Public Member Functions inherited from 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 |
| Returns the current Pins (only const access). More... | |
| virtual tResult | FindPin (const char *strName, ucom::ant::iobject_ptr< ucom::ant::IObject > &pPin) const =0 |
Find a Pin with the name of strName (only const access) More... | |
| Public Member Functions inherited from IRuntimeBehaviour | |
| ADTF_IID (IRuntimeBehaviour, "runtime_behaviour.ant.streaming.adtf.iid") | |
| defintion of interface id. | |
| virtual tResult | GetRunners (iobject_list< IRunner > &lstRunners) const =0 |
| Returns the current Runners. More... | |
| virtual tResult | FindRunner (const char *strName, iobject_ptr< adtf::ucom::ant::IObject > &pRunner) const =0 |
Find a Runner with the name of strName (only const access) More... | |
| virtual tResult | GetInnerPipes (iobject_list< ITriggerPipe > &lstInnerTriggerPipes) const =0 |
| Returns the current internal TriggerPipes. More... | |
| Public Member Functions inherited from IInterfaceBinding | |
| ADTF_IID (IInterfaceBinding, "interface_binding.ant.streaming.adtf.iid") | |
| definition of interface id | |
| virtual tResult | GetBindingObjects (iobject_list< IBindingObject > &lstBindingObject)=0 |
Return a list of all Binding Objects on lstBindingObject. More... | |
| virtual tResult | GetBindingObjects (iobject_list< const IBindingObject > &lstBindingObject) const =0 |
Return a list of all Binding Objects on lstBindingObject. More... | |
| virtual tResult | FindBindingObject (const char *strName, iobject_ptr< adtf::ucom::ant::IObject > &pIBindingObject)=0 |
This Function will search a binding object with the given strName and return it on pIBindingObject. More... | |
| virtual tResult | FindBindingObject (const char *strName, iobject_ptr< const adtf::ucom::ant::IObject > &pIBindingObject) const =0 |
This Function will search a binding object with the given strName and return it on pIBindingObject. More... | |
| Public Member Functions inherited from 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 |
Gets a registered graph object by strName. More... | |
| virtual tResult | GetNamedGraphObjects (ucom::ant::iobject_list< INamedGraphObject > &lstItems) const =0 |
| Gets a every registered graph objects. More... | |
Protected Member Functions | |
| ~IFilterGraph ()=default | |
| not desstructable | |
| Protected Member Functions inherited from IFilter | |
| ~IFilter ()=default | |
| not destructable | |
| Protected Member Functions inherited from INamedGraphObject | |
| ~INamedGraphObject ()=default | |
| not destructable | |
| Protected Member Functions inherited from IObject | |
| ~IObject ()=default | |
| Protected destructor --> Use implemented Destroy() instead of delete! | |
| Protected Member Functions inherited from IDataBinding | |
| ~IDataBinding ()=default | |
| not destructable | |
| Protected Member Functions inherited from IRuntimeBehaviour | |
| ~IRuntimeBehaviour ()=default | |
| not destructable | |
| Protected Member Functions inherited from IInterfaceBinding | |
| ~IInterfaceBinding ()=default | |
| not destructable | |
| Protected Member Functions inherited from 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.
Definition at line 22 of file filtergraph_intf.h.
Member Typedef Documentation
◆ tFilterGraphState
specifies the several types of filter states
- See also
- IFilter::tFilterState
Definition at line 48 of file filtergraph_intf.h.
Member Function Documentation
◆ AddConnection()
|
pure virtual |
Adds a connection between the filtergraph elements.
See Connections within the Filter Graph 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 Connections within the Filter Graph for valid connections)