ADTF: IPin

Pin Interface for the IDataBinding. More...

Inheritance diagram for IPin:

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

	UCOM_RESOLVE (adtf::ucom::ant::IObject, INamedGraphObject)
	resolver

virtual tResult	GetType (ucom::ant::iobject_ptr< const IStreamType > &pStreamType) const =0
	Retrieves the Type of the Pin if set. More...

virtual bool	IsConnected () const =0
	Retrieves the state of the Pin is either connected to a SampleStream or not. More...

virtual tResult	SetActive ()=0
	Activates the pin. More...

virtual tResult	SetInactive ()=0
	Deactivates the pin. More...

virtual tResult	Connect (const ucom::ant::iobject_ptr< ISampleStream > &pSampleStream)=0
	Connects the Pin to the SampleStream. More...

virtual tResult	Disconnect ()=0
	Disonnects the Pin from a SampleStream. More...

virtual tResult	GetSampleStream (ucom::ant::iobject_ptr< ISampleStream > &pSampleStream) const =0
	Retrieves the connected SampleStream. More...

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

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

virtual tResult	Run (tTimeStamp tmTimeofActivation, tActivationType ui32ActivationType, const void *pvUserData, size_t nUserDataSize)=0
	The Run method to set the component in running state. More...

virtual tActivationType	GetActivationType () const
	Gets the activation code of the runnable it reacts to. More...

Public Member Functions inherited from 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
	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...

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

virtual tResult	GetName (base::ant::IString &&strName) const =0
	Gets the Name of the object to the IString rvalue reference `strName`. More...

virtual tResult	SetName (const char *strName)=0
	Sets the Name of the object. More...

virtual tResult	SetParent (const ucom::ant::IObject *oParentObject)=0
	Sets the Parent of the object. More...

virtual tResult	GetParent (const ucom::ant::IObject *&poParentObject) const =0
	Retrieves the Parent of the object. More...

Protected Member Functions
	~IPin ()=default
	not destructable

Protected Member Functions inherited from ITriggerPipeItem
	~ITriggerPipeItem ()=default
	not destructable

Protected Member Functions inherited from IRunnable
	~IRunnable ()=default
	not destructable

Protected Member Functions inherited from ITriggerPipeSource
	~ITriggerPipeSource ()=default
	not destructable

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

Protected Member Functions inherited from INamedGraphObject
	~INamedGraphObject ()=default
	not destructable

Additional Inherited Members
Public Types inherited from 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 }
	Enumeration of the possible activation types to set a component in running state. More...

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

Public Types inherited from ITriggerPipeSource
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...

Detailed Description

Pin Interface for the IDataBinding.

The Pin itself can be part of an Trigger Pipe.

See also: ITriggerPipe; ITriggerPipeItem

Definition at line 23 of file pin_intf.h.

Member Function Documentation

◆ Connect()

virtual tResult 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 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 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 GetType ( ucom::ant::iobject_ptr< const IStreamType > & pStreamType ) const

pure virtual

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

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ Connect()

◆ Disconnect()

◆ GetSampleStream()

◆ GetType()

◆ IsConnected()

◆ SetActive()

◆ SetInactive()