adtf::streaming::ITriggerPipeSource Class Reference

bring latest ant::ITriggerPipeSource to users scope More...

#include <triggerpipe_intf.h>

Inherits adtf::ucom::ant::IObject.

Inherited by adtf::streaming::ant::IActiveRunner, and adtf::streaming::ant::ITriggerPipeItem.

Public Types
enum	tPriority : uint32_t {   Invalid = 0 , Lowest = 1 , Lower = 30 , BelowNormal = 40 ,   Normal = 50 , AboveNormal = 60 , Higher = 70 , Highest = 100 }

Public Member Functions
	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")

Protected Member Functions
	~ITriggerPipeSource ()=default
	not destructable
Protected Member Functions inherited from adtf::ucom::ant::IObject
	~IObject ()=default
	Protected destructor --> Only the final implementation can be destroyed!

Detailed Description

bring latest ant::ITriggerPipeSource to users scope

Interface that defines a TriggerPipeSource, which is able to send a Run (RUN::TIrgger) call to the registered TriggerPipeItems.

See also

trigger pipe

Member Enumeration Documentation

tPriority

enum adtf::streaming::ant::ITriggerPipeSource::tPriority : uint32_t

Priority used for the order of ITriggerPipeItem::Run calls.

See also

RegisterSubItem and ChangePriority.

Enumerator
Invalid	Invalid Priority.
Lowest	Lowest Priority.
Lower	Lower Priority.
BelowNormal	Below Normal Priority.
Normal	Normal Priority.
AboveNormal	Above Normal Priority.
Higher	Higher Priority.
Highest	Highest Priority.

Member Function Documentation

ChangePriority()

virtual tResult adtf::streaming::ant::ITriggerPipeSource::ChangePriority ( const adtf::ucom::ant::iobject_ptr< ITriggerPipeItem > & pSubRun, tPriority ui32Prio )

pure virtual

Changes the priority of the pSubRun.

Parameters

[in]	pSubRun	TriggerPipeItem to register.
[in]	ui32Prio	Priority of Run call.

Returns

Standard Result Code.

GetSubItems()

virtual tResult adtf::streaming::ant::ITriggerPipeSource::GetSubItems ( adtf::ucom::ant::iobject_enum< const ITriggerPipeItem > & lstSubItems ) const

pure virtual

Retrieves a list of the registered Items.

Parameters

[in]

lstSubItems

enumeration interface where to push the object references to.

Returns

Standard Result Code.

RegisterSubItem()

virtual tResult adtf::streaming::ant::ITriggerPipeSource::RegisterSubItem ( const adtf::ucom::ant::iobject_ptr< ITriggerPipeItem > & pSubRun, tPriority ui32Prio )

pure virtual

Registers the pSubRun as SubItem of the source. The source will forward a Run call to every registered ITriggerPipeItem in order of ui32Prio.

Parameters

[in]	pSubRun	TriggerPipeItem to register.
[in]	ui32Prio	Priority of Run call.

Returns

Standard Result Code.

UnregisterSubItem()

virtual tResult adtf::streaming::ant::ITriggerPipeSource::UnregisterSubItem ( const adtf::ucom::ant::iobject_ptr< ITriggerPipeItem > & pSubRun )

pure virtual

Unregisters the pSubRun from the source.

Parameters

[in]

pSubRun

TriggerPipeItem to unregister.

Returns

Standard Result Code.

---

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

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