adtf::streaming::ITriggerPipe Class Reference

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

#include <triggerpipe_intf.h>

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

Public Member Functions
	ADTF_IID (ITriggerPipe, "trigger_pipe.ant.streaming.adtf.iid")
	Definiton of interface id.
virtual tResult	GetFirstItem (adtf::ucom::ant::iobject_ptr< const ITriggerPipeSource > &pSubRu) const=0
virtual tResult	Open ()=0
virtual tResult	Close ()=0
virtual tResult	GetName (adtf::base::ant::IString &&strName) const=0
Public Member Functions inherited from adtf::ucom::ant::IObject
	ADTF_IID (IObject, "object.ant.ucom.adtf.iid")

Protected Member Functions
	~ITriggerPipe ()=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::ITriggerPipe to users scope

Interface a Trigger Pipe. A RunnerPipe is usually implemented as composition tree with the root item can be obtained by GetFirstItem. To create a pipe see adtf::streaming::ant::create_trigger_pipe .

See also

create_trigger_pipe

Member Function Documentation

Close()

virtual tResult adtf::streaming::ant::ITriggerPipe::Close ( )

pure virtual

Close and unregister every pipe item from its ITriggerPipeSource.

Returns

Standard Result Code.

GetFirstItem()

virtual tResult adtf::streaming::ant::ITriggerPipe::GetFirstItem ( adtf::ucom::ant::iobject_ptr< const ITriggerPipeSource > & pSubRu ) const

pure virtual

Retrieves the first source item of the defined Trigger Pipe.

Parameters

[in,out]

pSubRu

Object Reference to retrieve the first pipe source item.

Returns

Standard Result Code.

Return values

ERR_NOT_INITIALIZED

The first item is not set and the trigger pipe is empty.

GetName()

virtual tResult adtf::streaming::ant::ITriggerPipe::GetName ( adtf::base::ant::IString && strName ) const

pure virtual

Gets the name of the Pipe.

Parameters

[out]

strName

name returned

Returns

The result of the IString::Set call.

Open()

virtual tResult adtf::streaming::ant::ITriggerPipe::Open ( )

pure virtual

Opens and register every added pipe items.

See also

ITriggerPipeSource::RegisterSubItem.

Returns

If Failed the result is forwarded from ITriggerPipeSource::RegisterSubItem

---

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

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