#include <pin_intf.h>

Inherits adtf::streaming::ant::ITriggerPipeItem, and adtf::streaming::ant::INamedGraphObject.

Inherited by adtf::streaming::ant::IInPin, and adtf::streaming::ant::IOutPin.

Public Member Functions
	ADTF_IID (IPin, "pin.ant.streaming.adtf.iid")
	defintion of interface id

virtual tResult	GetType (ucom::ant::iobject_ptr< const IStreamType > &pStreamType) const =0
	resolver

virtual bool	IsConnected () const =0

virtual tResult	SetActive ()=0

virtual tResult	SetInactive ()=0

virtual tResult	Connect (const ucom::ant::iobject_ptr< ISampleStream > &pSampleStream)=0

virtual tResult	Disconnect ()=0

virtual tResult	GetSampleStream (ucom::ant::iobject_ptr< ISampleStream > &pSampleStream) const =0

Public Member Functions inherited from adtf::streaming::ant::ITriggerPipeItem
	ADTF_IID (ITriggerPipeItem, "trigger_pipe_item.ant.streaming.adtf.iid")
	Definition of interface ID.

Public Member Functions inherited from adtf::base::ant::IRunnable
	ADTF_IID (IRunnable, "runnable.ant.base.adtf.iid")
	defintion of interface id

	ADTF3_DEPRECATED ("Use adtf::base::flash::IRunnable::Run(tNanoSeconds tmTimeofActivation, ant::IRunnable::tActivationType " "ui32ActivationType, const void* pvUserData, size_t nUserDataSize) instead.") virtual tResult Run(tTimeStamp tmTimeofActivation

virtual tActivationType	GetActivationType () const

Public Member Functions inherited from adtf::streaming::ant::ITriggerPipeSource
	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")

Public Member Functions inherited from adtf::streaming::ant::INamedGraphObject
	ADTF_IID (INamedGraphObject, "namedgraphobject.ant.streaming.adtf.iid")
	defintion of interface id

virtual tResult	GetName (base::ant::IString &&strName) const =0

virtual tResult	SetName (const char *strName)=0

virtual tResult	SetParent (const ucom::ant::IObject *oParentObject)=0

virtual tResult	GetParent (const ucom::ant::IObject *&poParentObject) const =0

Protected Member Functions
	~IPin ()=default
	not destructable

Protected Member Functions inherited from adtf::streaming::ant::ITriggerPipeItem
	~ITriggerPipeItem ()=default
	not destructable

Protected Member Functions inherited from adtf::base::ant::IRunnable
	~IRunnable ()=default
	not destructable

Protected Member Functions inherited from adtf::streaming::ant::ITriggerPipeSource
	~ITriggerPipeSource ()=default
	not destructable

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

Protected Member Functions inherited from adtf::streaming::ant::INamedGraphObject
	~INamedGraphObject ()=default
	not destructable

Additional Inherited Members
Public Types inherited from adtf::base::ant::IRunnable
enum	tActivationType : uint32_t { RUN_UNSPECIFIED = 0 , RUN_TIMER = 1 , RUN_SIGNAL = 2 , RUN_EXCEPTION = 3 , RUN_MESSAGE = 5 , RUN_THREAD = 6 , RUN_JOB = 7 , RUN_TRIGGER = 8 , RUN_PUSH = 9 , RUN_USER = 0x1000 }

typedef std::function< tResult(tTimeStamp)>	tRunFunction
	Type definition of the function used to implement Run.

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

Public Attributes inherited from adtf::base::ant::IRunnable
tActivationType	ui32ActivationType

tActivationType const void *	pvUserData

tActivationType const void size_t	nUserDataSize = 0

Detailed Description

Pin Interface for the IDataBinding. The Pin itself can be part of an trigger pipe.

See also: ITriggerPipe; ITriggerPipeItem

Member Function Documentation

◆ Connect()

virtual tResult adtf::streaming::ant::IPin::Connect ( const ucom::ant::iobject_ptr< ISampleStream > & pSampleStream )

pure virtual

Connects the Pin to the SampleStream. While a pin is activated this call will fail.

If the pin is already connected it depends on the implementation either the reconnection is refused or existing connection is disconnected and the new connection is established.

See also: cOutPin, cInPin

Parameters

[in] pSampleStream SampleStream is connecting

Returns: Standard Result Code.

◆ Disconnect()

virtual tResult adtf::streaming::ant::IPin::Disconnect ( )

pure virtual

Disonnects the Pin from a SampleStream. While a pin is activated this call will fail.

Returns: Standard Result Code.

◆ GetSampleStream()

virtual tResult adtf::streaming::ant::IPin::GetSampleStream ( ucom::ant::iobject_ptr< ISampleStream > & pSampleStream ) const

pure virtual

Retrieves the connected SampleStream.

Parameters

[in] pSampleStream SampleStream is connected

Returns: Standard Result Code.

Return values

ERR_NOT_INITIALIZED pin is not connected

◆ GetType()

virtual tResult adtf::streaming::ant::IPin::GetType ( ucom::ant::iobject_ptr< const IStreamType > & pStreamType ) const

pure virtual

resolver

Retrieves the Type of the Pin if set. Usually this is the type of the connected ISampleStream ... see Connect. If not set the pin implementation will define where to get the type from.

Parameters

[in] pStreamType object reference to return the StreamType to.

Returns: Standard Result Code.

Return values

ERR_POINTER No type set.

◆ IsConnected()

virtual bool adtf::streaming::ant::IPin::IsConnected ( ) const

pure virtual

Retrieves the state of the Pin is either connected to a SampleStream or not.

Returns: true only if a SampelStream is connected.

◆ SetActive()

virtual tResult adtf::streaming::ant::IPin::SetActive ( )

pure virtual

Activates the pin. While a pin is activated every Connect or Disconnect call will fail. This is to stay rt-safe while RL_Running state.

Returns: Standard Result Code.

◆ SetInactive()

virtual tResult adtf::streaming::ant::IPin::SetInactive ( )

pure virtual

Deactivates the pin. While a pin is activated every Connect or Disconnect call will fail. This is to stay rt-safe while RL_Running state.

Returns: Standard Result Code.

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

src/libraries/streaming3/include/adtfstreaming3/pin_intf.h

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ Connect()

◆ Disconnect()

◆ GetSampleStream()

◆ GetType()

◆ IsConnected()

◆ SetActive()

◆ SetInactive()