ADTF  3.15.3
ITriggerPipeSourceabstract

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

Inheritance diagram for ITriggerPipeSource:
[legend]

Public Types

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...
 

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
 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 IObject
 ADTF_IID (IObject, "object.ant.ucom.adtf.iid")
 Marks the IObject to be castable with the ucom_cast() More...
 

Protected Member Functions

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

Detailed Description

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

See also
Trigger Pipe

Definition at line 25 of file triggerpipe_intf.h.

Member Enumeration Documentation

◆ tPriority

enum 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.

Definition at line 36 of file triggerpipe_intf.h.

Member Function Documentation

◆ ChangePriority()

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

Changes the priority of the pSubRun.

Parameters
[in]pSubRunTriggerPipeItem to register.
[in]ui32PrioPriority of Run call.
Returns
Standard Result Code.

◆ GetSubItems()

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

Retrieves a list of the registered Items.

Parameters
[in]lstSubItemsenumeration interface where to push the object references to.
Returns
Standard Result Code.

◆ RegisterSubItem()

virtual tResult 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]pSubRunTriggerPipeItem to register.
[in]ui32PrioPriority of Run call.
Returns
Standard Result Code.

◆ UnregisterSubItem()

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

Unregisters the pSubRun from the source.

Parameters
[in]pSubRunTriggerPipeItem to unregister.
Returns
Standard Result Code.