IActiveRunner

The Interface defines an Active Runner Intem which can be part of the IFilterGraph. More...

#include <runner_intf.h>

Inheritance diagram for IActiveRunner:

Public Member Functions
	ADTF_IID (IActiveRunner, "active_runner.ant.streaming.adtf.iid")
	Definition of the interface identifier.
	UCOM_RESOLVE (adtf::ucom::ant::IObject, INamedGraphObject)
virtual tResult	Activate ()=0
	The Activate call is to create the Timer or Thread or other running internals of the Runner.
virtual tResult	Deactivate ()=0
	The Deactivate call is to stop and destroy the Timer or Thread or other running internals of the Runner.
virtual bool	IsActivated () const=0
	Return the Activatation State of the Runner.
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.
virtual tResult	UnregisterSubItem (const adtf::ucom::ant::iobject_ptr< ITriggerPipeItem > &pSubRun)=0
	Unregisters the pSubRun from the source.
virtual tResult	ChangePriority (const adtf::ucom::ant::iobject_ptr< ITriggerPipeItem > &pSubRun, tPriority ui32Prio)=0
	Changes the priority of the pSubRun.
virtual tResult	GetSubItems (adtf::ucom::ant::iobject_enum< const ITriggerPipeItem > &lstSubItems) const =0
	Retrieves a list of the registered Items.
Public Member Functions inherited from IObject
	ADTF_IID (IObject, "object.ant.ucom.adtf.iid")
	Marks the IObject to be castable with the ucom_cast()
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.
virtual tResult	SetName (const char *strName)=0
	Sets the Name of the object.
virtual tResult	SetParent (const ucom::ant::IObject *oParentObject)=0
	Sets the Parent of the object.
virtual tResult	GetParent (const ucom::ant::IObject *&poParentObject) const =0
	Retrieves the Parent of the object.

Protected Member Functions
virtual	~IActiveRunner ()=default
	is not destructable
Protected Member Functions inherited from ITriggerPipeSource
	~ITriggerPipeSource ()=default
	not destructable
Protected Member Functions inherited from IObject
	~IObject ()=default
	Protected destructor --> Only the final implementation can be destroyed!
Protected Member Functions inherited from INamedGraphObject
	~INamedGraphObject ()=default
	not destructable

Additional Inherited Members
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

The Interface defines an Active Runner Intem which can be part of the IFilterGraph.

Alias moving IActiveRunner into scope.

An Active Runner is able to create an Run call on registered ITriggerPipeItem.

The IActiveRunner is a special part of the IFilterGraph. The IFilterGraph will activate the IActiveRunner only AFTER every single IFilter are already in IFilter::tFilterState::State_Running !

See also

IRunner, ITriggerPipeItem

Definition at line 44 of file runner_intf.h.

Member Function Documentation

Activate()

virtual tResult Activate ( )

pure virtual

The Activate call is to create the Timer or Thread or other running internals of the Runner.

Warning

Before the Activate function is called it is prohibited to run the registered ITriggerPipeItem!

Returns

Standard Result Code

Deactivate()

virtual tResult Deactivate ( )

pure virtual

The Deactivate call is to stop and destroy the Timer or Thread or other running internals of the Runner.

Warning

The Deactivate call must return also if the registered ITriggerPipeItems are not reacting!

Returns

Standard Result Code

IsActivated()

virtual bool IsActivated ( ) const

pure virtual

Return the Activatation State of the Runner.

Return values

true	The IActiveRunner is still running.
false	The IActiveRunner is not running or the internal runner stopped exectution.