cOutPin

The cOutPin class implements basic functionality specified by the IOutPin interface. More...

#include <pin.h>

Inheritance diagram for cOutPin:

Public Member Functions
	cOutPin ()
	private dPointer
	cOutPin (const char *strName)
	CTOR with name.
virtual	~cOutPin ()
	DTOR.
tResult	GetType (ucom::ant::iobject_ptr< const IStreamType > &pStreamType) const override
bool	IsConnected () const override
tResult	SetActive () override
tResult	SetInactive () override
tResult	Disconnect ()
tResult	GetSampleStream (ucom::ant::iobject_ptr< ISampleStream > &pSampleStream) const override
tResult	Connect (const ucom::ant::iobject_ptr< ISampleStream > &pSampleStream) override
tResult	RegisterStreamer (ISampleWriter &pStreamWriter)
	Registers a Streamer to the Pin.
tResult	UnregisterStreamer (ISampleStreamer &pStreamWriter)
	Unregisters a registered Streamer from the Pin.
Public Member Functions inherited from object< IPin, named_graph_object< trigger_pipe_item< IOutPin > > >
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 IObject
	ADTF_IID (IObject, "object.ant.ucom.adtf.iid")
	Marks the IObject to be castable with the ucom_cast()

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

Detailed Description

The cOutPin class implements basic functionality specified by the IOutPin interface.

Definition at line 95 of file pin.h.

Constructor & Destructor Documentation

cOutPin() [1/2]

cOutPin

(

)

private dPointer

CTOR

cOutPin() [2/2]

cOutPin

(

const char *

strName

)

CTOR with name.

Parameters

[in]

strName

Name of the pin

Member Function Documentation

RegisterStreamer()

tResult RegisterStreamer

(

ISampleWriter &

pStreamWriter

)

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]

pStreamWriter

The Streamer to register.

Returns

Standard Result Code

UnregisterStreamer()

tResult UnregisterStreamer

(

ISampleStreamer &

pStreamWriter

)

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]

pStreamWriter

The Streamer to unregister.

Returns

Standard Result Code

Return values

ERR_NOT_FOUND

The Streamer is not registered.