ITriggerPipe

Interface a Trigger Pipe. More...

Inheritance diagram for ITriggerPipe:

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
	Retrieves the first source item of the defined Trigger Pipe. More...
virtual tResult	Open ()=0
	Opens and register every added pipe items. More...
virtual tResult	Close ()=0
	Close and unregister every pipe item from its ITriggerPipeSource. More...
virtual tResult	GetName (adtf::base::ant::IString &&strName) const =0
	Gets the name of the Pipe. 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
	~ITriggerPipe ()=default
	not destructable
Protected Member Functions inherited from IObject
	~IObject ()=default
	Protected destructor --> Use implemented Destroy() instead of delete!

Detailed Description

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

Definition at line 117 of file triggerpipe_intf.h.

Member Function Documentation

Close()

virtual tResult Close ( )

pure virtual

Close and unregister every pipe item from its ITriggerPipeSource.

Returns

Standard Result Code.

GetFirstItem()

virtual tResult 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 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 Open ( )

pure virtual

Opens and register every added pipe items.

See also

ITriggerPipeSource::RegisterSubItem.

Returns

If Failed the result is forwarded from ITriggerPipeSource::RegisterSubItem