Interface for a Filtergraph Runner Port that provides a IRunner as connectable item. More...

Inheritance diagram for IFilterGraphRunnerPort:

Public Member Functions
	ADTF_IID (IFilterGraphRunnerPort, "filtergraphrunnerport.ant.streaming.adtf.iid")
	Definition of interface id.

	UCOM_RESOLVE (ucom::ant::IObject, IFilterGraphPort)
	Resolve IObject ucom_cast.

virtual tResult	InnerRegisterSubItem (const ucom::ant::iobject_ptr< IRunner > &pRunner)=0
	Registers the internal IRunner which is provided by the graphs IRuntimeBehaviour. More...

virtual tResult	InnerUnregisterSubItem (const ucom::ant::iobject_ptr< IRunner > &pRunner)=0
	Registers the internal IRunner which is provided by the graphs IRuntimeBehaviour. More...

Public Member Functions inherited from IFilterGraphPort
	ADTF_IID (IFilterGraphPort, "filtergraphport.ant.streaming.adtf.iid")
	Definition of interface id.

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 IRunner
	ADTF_IID (IRunner, "runner.ant.streaming.adtf.iid")
	Definition of the interface identifier.

	UCOM_RESOLVE (adtf::ucom::ant::IObject, INamedGraphObject)

Public Member Functions inherited from ITriggerPipeItem
	ADTF_IID (ITriggerPipeItem, "trigger_pipe_item.ant.streaming.adtf.iid")
	Definition of interface ID.

Public Member Functions inherited from IRunnable
	ADTF_IID (IRunnable, "runnable.ant.base.adtf.iid")
	defintion of interface id

virtual tResult	Run (tTimeStamp tmTimeofActivation, tActivationType ui32ActivationType, const void *pvUserData, size_t nUserDataSize)=0
	The Run method to set the component in running state. More...

virtual tActivationType	GetActivationType () const
	Gets the activation code of the runnable it reacts to. More...

Public Member Functions inherited from ITriggerPipeSource
	ADTF_IID (ITriggerPipeSource, "trigger_pipe_source.ant.streaming.adtf.iid")
	definiton of interface id

virtual tResult	RegisterSubItem (const adtf::ucom::ant::iobject_ptr< ITriggerPipeItem > &pSubRun, tPriority ui32Prio)=0
	Registers the `pSubRun` as SubItem of the source. More...

virtual tResult	UnregisterSubItem (const adtf::ucom::ant::iobject_ptr< ITriggerPipeItem > &pSubRun)=0
	Unregisters the `pSubRun` from the source. More...

virtual tResult	ChangePriority (const adtf::ucom::ant::iobject_ptr< ITriggerPipeItem > &pSubRun, tPriority ui32Prio)=0
	Changes the priority of the `pSubRun`. More...

virtual tResult	GetSubItems (adtf::ucom::ant::iobject_enum< const ITriggerPipeItem > &lstSubItems) const =0
	Retrieves a list of the registered Items. 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...

Protected Member Functions
	~IFilterGraphRunnerPort ()=default
	not destructable

Protected Member Functions inherited from IFilterGraphPort
	~IFilterGraphPort ()=default
	not destructable

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

Protected Member Functions inherited from IRunner
virtual	~IRunner ()=default
	is not destructable

Protected Member Functions inherited from ITriggerPipeItem
	~ITriggerPipeItem ()=default
	not destructable

Protected Member Functions inherited from IRunnable
	~IRunnable ()=default
	not destructable

Protected Member Functions inherited from ITriggerPipeSource
	~ITriggerPipeSource ()=default
	not destructable

Protected Member Functions inherited from INamedGraphObject
	~INamedGraphObject ()=default
	not destructable

Additional Inherited Members
Public Types inherited from IRunnable
enum	tActivationType : uint32_t { RUN_UNSPECIFIED = 0 , RUN_TIMER = 1 , RUN_SIGNAL = 2 , RUN_EXCEPTION = 3 , RUN_MESSAGE = 5 , RUN_THREAD = 6 , RUN_JOB = 7 , RUN_TRIGGER = 8 , RUN_PUSH = 9 , RUN_USER = 0x1000 }
	Enumeration of the possible activation types to set a component in running state. More...

typedef std::function< tResult(tTimeStamp)>	tRunFunction
	Type defintion of the function used to implement Run.

Public Types inherited from ITriggerPipeSource
enum	tPriority : uint32_t { Invalid = 0 , Lowest = 1 , Lower = 30 , BelowNormal = 40 , Normal = 50 , AboveNormal = 60 , Higher = 70 , Highest = 100 }
	Priority used for the order of ITriggerPipeItem::Run calls. More...

Detailed Description

Interface for a Filtergraph Runner Port that provides a IRunner as connectable item.

It will provide the IRuntimeBehaviour of the IFiltergraph

Warning: : This interface is only used internally by the filtergraph implementation!

Definition at line 43 of file filtergraphport_intf.h.

Member Function Documentation

◆ InnerRegisterSubItem()

virtual tResult InnerRegisterSubItem ( const ucom::ant::iobject_ptr< IRunner > & pRunner )

pure virtual

Registers the internal IRunner which is provided by the graphs IRuntimeBehaviour.

Parameters

[in] pRunner Runner to register

Returns: Standard Result Code.

Return values

ERR_NOERROR The registration succeeded.

◆ InnerUnregisterSubItem()

virtual tResult InnerUnregisterSubItem ( const ucom::ant::iobject_ptr< IRunner > & pRunner )