adtf::streaming::ant::cInPin Class Reference

#include <pin.h>

Inherits adtf::streaming::trigger_pipe_item< INamedGraphObject, IPin, IInPin >.

Public Member Functions
	cInPin ()
	private dPointer
	cInPin (const char *strName)
virtual	~cInPin ()
	DTOR.
tResult	GetType (ucom::ant::iobject_ptr< const IStreamType > &pStreamType) const override
bool	IsConnected () const override
tResult	SetActive () override
tResult	SetInactive () override
tResult	Disconnect () override
tResult	GetSampleStream (ucom::ant::iobject_ptr< ISampleStream > &pSampleStream) const override
tResult	Connect (const ucom::ant::iobject_ptr< ISampleStream > &pSampleStream) override
tResult	RegisterStreamer (ISampleReader &pStreamReader)
tResult	UnregisterStreamer (ISampleStreamer &pStreamReader)
Public Member Functions inherited from adtf::streaming::trigger_pipe_item< INamedGraphObject, IPin, IInPin >
	trigger_pipe_item ()=default
	CTOR.
	trigger_pipe_item (const char *strName)
	trigger_pipe_item (const char *strName, adtf::base::ant::IRunnable &oRunnable)
void	SetRunnable (adtf::base::ant::IRunnable &oRunnable)
void	SetRunnable (adtf::base::flash::IRunnable &oRunnable)
void	SetCallable (CALLABLE &&callable)
tResult	RegisterSubItem (const adtf::ucom::ant::iobject_ptr< ITriggerPipeItem > &pSubRun, ITriggerPipeItem::tPriority ui32Prio) override
tResult	UnregisterSubItem (const adtf::ucom::ant::iobject_ptr< ITriggerPipeItem > &pSubRun) override
tResult	ChangePriority (const adtf::ucom::ant::iobject_ptr< ITriggerPipeItem > &pSubRun, ITriggerPipeItem::tPriority ui32Prio) override
tResult	GetSubItems (adtf::ucom::ant::iobject_enum< const ITriggerPipeItem > &lstSubItems) const override
tResult	Run (tTimeStamp tmTimeofActivation, adtf::base::ant::IRunnable::tActivationType ui32ActivationType, const void *pvUserData, size_t nUserDataSize) override
tResult	Run (adtf::base::flash::tNanoSeconds tmTimeofActivation, adtf::base::ant::IRunnable::tActivationType ui32ActivationType, const void *pvUserData, size_t nUserDataSize) override
tResult	RegisterTriggerParent (const ant::ITriggerPipeSource *pParent) override
tResult	UnregisterTriggerParent (const ant::ITriggerPipeSource *pParent) override
tResult	GetTriggerParents (const ucom::nitro::ifunction< tResult(const ant::ITriggerPipeSource *)> &fnCallback) const override
tResult	GetName (base::ant::IString &&strName) const
tResult	SetName (const char *strName)
tResult	SetParent (const ucom::ant::IObject *oParentObject)
tResult	GetParent (const ucom::ant::IObject *&poParentObject) const
Public Member Functions inherited from adtf::ucom::catwo::object< base::ant::IRunnable, base::flash::IRunnable, ant::ITriggerPipeSource, ant::ITriggerPipeItem, quiet::ITriggerPipeHierachy, INTERFACES... >
tResult	GetInterface (const char *i_strIID, void *&o_pInterface) override
	Query interfaces on an object.
tResult	GetInterface (const char *i_strIID, const void *&o_pInterface) const override
	Provides const correct interface querying.
void	Destroy () const override
	Switch from non-virtual destructor to virtual destructor.
tResult	GetInterface (const char *i_strIID, void *&o_pInterface) override
	Query interfaces on an object.
tResult	GetInterface (const char *i_strIID, const void *&o_pInterface) const override
	Provides const correct interface querying.
void	Destroy () const override
	Switch from non-virtual destructor to virtual destructor.
tResult	GetInterface (const char *i_strIID, void *&o_pInterface) override
	Query interfaces on an object.
tResult	GetInterface (const char *i_strIID, const void *&o_pInterface) const override
	Provides const correct interface querying.
void	Destroy () const override
	Switch from non-virtual destructor to virtual destructor.
Public Member Functions inherited from adtf::ucom::ant::IObject
	ADTF_IID (IObject, "object.ant.ucom.adtf.iid")

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

Detailed Description

The cInputPin class implements basic functionality specified by the IInPin interface.

Constructor & Destructor Documentation

cInPin() [1/2]

adtf::streaming::ant::cInPin::cInPin

(

)

private dPointer

CTOR

cInPin() [2/2]

adtf::streaming::ant::cInPin::cInPin

(

const char *

strName

)

CTOR with name

Parameters

[in]

strName

Name of the pin

Member Function Documentation

RegisterStreamer()

tResult adtf::streaming::ant::cInPin::RegisterStreamer

(

ISampleReader &

pStreamReader

)

Registers a Streamer to the Pin. Every registered ISampleStreamer will retrieve a ISampleStreamer::BeginStreaming call, while the Pin is connected via connect call. If pin is already connected a ISampleStreamer::BeginStreaming is immediatelly made.

Remarks

Make sure the instance of pStreamReader will live as long as the Pin or unregister it on destroy.

Parameters

[in]

pStreamReader

The Streamer to register.

Returns

Standard Result Code

UnregisterStreamer()

tResult adtf::streaming::ant::cInPin::UnregisterStreamer

(

ISampleStreamer &

pStreamReader

)

Unregisters a registered Streamer from the Pin. Every registered ISampleStreamer will retrieve a ISampleStreamer::BeginStreaming call, while the Pin is connected via Connect call. While unregistering from a connected pin a ISampleStreamer::EndStreaming call is made.

Remarks

Make sure the instance of pStreamReader will live as long as the Pin or unregister it on destroy.

Parameters

[in]

pStreamReader

The Streamer to unregister.

Returns

Standard Result Code

Return values

ERR_NOT_FOUND

The Streamer is not registered.

---

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

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