cTriggerPipeSourceImpl

Default implementation for a ITriggerPipeSource. More...

Inheritance diagram for cTriggerPipeSourceImpl:

Public Member Functions
	cTriggerPipeSourceImpl ()
	CTOR.
virtual	~cTriggerPipeSourceImpl ()=default
	DTOR.
tResult	RegisterSubItem (const adtf::ucom::ant::iobject_ptr< ITriggerPipeItem > &pSubRun, ITriggerPipeItem::tPriority ui32Prio)
	Registers the pSubRun as SubItem of the source. More...
tResult	UnregisterSubItem (const adtf::ucom::ant::iobject_ptr< ITriggerPipeItem > &pSubRun)
	Unregisters the pSubRun from the source. More...
tResult	ChangePriority (const adtf::ucom::ant::iobject_ptr< ITriggerPipeItem > &pSubRun, ITriggerPipeItem::tPriority ui32Prio)
	Changes the priority of the pSubRun. More...
tResult	GetSubItems (adtf::ucom::ant::iobject_enum< const ITriggerPipeItem > &lstSubItems) const
	Retrieves a list of the registered Items. More...
tResult	RunSubs (tTimeStamp tmTimeofActivation, adtf::base::ant::IRunnable::tActivationType ui32ActivationType, const void *pvUserData, size_t nUserDataSize)
	Then the Registered subitems will be called in order of ITriggerPipeItem::tPriority. More...
tResult	RunSubs (base::flash::tNanoSeconds tmTimeofActivation, adtf::base::ant::IRunnable::tActivationType ui32ActivationType, const void *pvUserData, size_t nUserDataSize)

Static Protected Attributes
static adtf::base::IRunnable *	m_pNothingToDoRunnable
	internal runnable implementation to prevent nullpointer checks

Private Member Functions
	A_UTILS_D (cTriggerPipeSourceImpl)
	private dpointer
	cTriggerPipeSourceImpl (const cTriggerPipeSourceImpl &)=delete
	deleted copy CTOR
cTriggerPipeSourceImpl &	operator= (const cTriggerPipeSourceImpl &)=delete
	deleted copy operator
	cTriggerPipeSourceImpl (cTriggerPipeSourceImpl &&)=delete
	deleted move CTOR
cTriggerPipeSourceImpl &	operator= (cTriggerPipeSourceImpl &&)=delete
	deleted move operator

Detailed Description

Default implementation for a ITriggerPipeSource.

Definition at line 27 of file triggerpipe.h.

Member Function Documentation

ChangePriority()

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

Changes the priority of the pSubRun.

Parameters

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

Returns

Standard Result Code.

Referenced by trigger_pipe_source< INTERFACE >::ChangePriority().

GetSubItems()

tResult GetSubItems

(

adtf::ucom::ant::iobject_enum< const ITriggerPipeItem > &

lstSubItems

)

const

Retrieves a list of the registered Items.

Parameters

[in]

lstSubItems

enumeration interface where to push the object references to.

Returns

Standard Result Code.

Referenced by trigger_pipe_source< INTERFACE >::GetSubItems().

RegisterSubItem()

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

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.

Referenced by trigger_pipe_source< INTERFACE >::RegisterSubItem().

RunSubs()

tResult RunSubs	(	tTimeStamp	tmTimeofActivation,
		adtf::base::ant::IRunnable::tActivationType	ui32ActivationType,
		const void *	pvUserData,
		size_t	nUserDataSize
	)

Then the Registered subitems will be called in order of ITriggerPipeItem::tPriority.

Parameters

[in]	tmTimeofActivation	Time of activation.Usually this is the StreamTime.
[in]	ui32ActivationType	The activation type for running.
[in]	pvUserData	pointer to a activation structure depending on the activation type.
[in]	nUserDataSize	Size of the activation structure. (in byte)

Returns

Standard result code.

Referenced by trigger_pipe_item< INTERFACE >::Run().

UnregisterSubItem()

tResult UnregisterSubItem

(

const adtf::ucom::ant::iobject_ptr< ITriggerPipeItem > &

pSubRun

)

Unregisters the pSubRun from the source.

Parameters

[in]

pSubRun

TriggerPipeItem to unregister.

Returns

Standard Result Code.

Referenced by trigger_pipe_source< INTERFACE >::UnregisterSubItem().