adtf::streaming::IActiveRunner Class Reference

Alias moving ant::IActiveRunner into scope. More...

#include <runner_intf.h>

Inherits adtf::streaming::ant::ITriggerPipeSource, and adtf::streaming::ant::INamedGraphObject.

Inherited by adtf::streaming::spider::IActiveRunner.

Public Member Functions
	ADTF_IID (IActiveRunner, "active_runner.ant.streaming.adtf.iid")
	Definition of the interface identifier.
virtual tResult	Activate ()=0
virtual tResult	Deactivate ()=0
virtual bool	IsActivated () const=0
Public Member Functions inherited from adtf::streaming::ant::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
virtual tResult	UnregisterSubItem (const adtf::ucom::ant::iobject_ptr< ITriggerPipeItem > &pSubRun)=0
virtual tResult	ChangePriority (const adtf::ucom::ant::iobject_ptr< ITriggerPipeItem > &pSubRun, tPriority ui32Prio)=0
virtual tResult	GetSubItems (adtf::ucom::ant::iobject_enum< const ITriggerPipeItem > &lstSubItems) 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::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

Protected Member Functions
virtual	~IActiveRunner ()=default
	is not destructable
Protected Member Functions inherited from adtf::streaming::ant::ITriggerPipeSource
	~ITriggerPipeSource ()=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::INamedGraphObject
	~INamedGraphObject ()=default
	not destructable

Additional Inherited Members
Public Types inherited from adtf::streaming::ant::ITriggerPipeSource
enum	tPriority : uint32_t {   Invalid = 0 , Lowest = 1 , Lower = 30 , BelowNormal = 40 ,   Normal = 50 , AboveNormal = 60 , Higher = 70 , Highest = 100 }

Detailed Description

Alias moving ant::IActiveRunner into scope.

The Interface defines an Active Runner Intem which can be part of the IFilterGraph. 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

Member Function Documentation

Activate()

virtual tResult adtf::streaming::ant::IActiveRunner::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 adtf::streaming::ant::IActiveRunner::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 adtf::streaming::ant::IActiveRunner::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.

---

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

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