ADTF  3.18.2
cLegacyOutputPin

This class helps when porting ADTF 2 Filters to ADTF 3. More...

Inheritance diagram for cLegacyOutputPin:
[legend]

Public Member Functions

tResult Create (const char *strName, const ucom::iobject_ptr< const adtf::streaming::IStreamType > &pStreamType)
 Initializes an instance of an Output Pin. More...
 
tResult Create (const char *strName, const ucom::iobject_ptr< adtf::streaming::IStreamType > &pStreamType)
 Initializes an instance of an Output Pin. More...
 
void SetManualTriggerRequired (bool bManualTriggerRequired)
 For internal use only. More...
 
tResult Transmit (const ucom::iobject_ptr< const adtf::streaming::ISample > &pSample) override
 Transmits a sample via an Output Pin. More...
 
- Public Member Functions inherited from cSampleWriter
 cSampleWriter ()
 CTOR.
 
virtual ~cSampleWriter ()
 DTOR.
 
 cSampleWriter (const char *strName, const ucom::ant::iobject_ptr< const IStreamType > &pStreamType)
 CTOR with name and type. More...
 
tResult BeginStreaming (ISampleStream &oSampleStream) override
 BeginStreaming will open the given Sample Stream for Writing while a connection is establishing. More...
 
tResult EndStreaming () override
 Sample Stream disconnected. More...
 
virtual tResult ChangeType (const ucom::ant::iobject_ptr< const IStreamType > &pType)
 Changes and writes a stream type reference to the opened ISampleOutStream. More...
 
virtual tResult Flush ()
 Flushes a the opened ISampleOutStream. More...
 
virtual tResult SetStreamError (tResult oErr)
 Writes an error to the opened ISampleOutStream. More...
 
tResult ManualTrigger ()
 This is to Run a trigger call manually. More...
 
- Public Member Functions inherited from sample_streamer< ISampleWriter, cOutPin >
 sample_streamer ()=default
 CTOR.
 
 sample_streamer (const char *strName, const ucom::ant::iobject_ptr< const IStreamType > &pStreamType)
 CTOR initializer. More...
 
virtual ~sample_streamer ()
 DTOR.
 
void SetName (const char *strName)
 Sets the name of the streamer. More...
 
void ResetPin (ucom::ant::object_ptr< cOutPin > &pPin)
 Resets the pin reference This is only internaly used. More...
 
void ResetPin ()
 Resets the pin reference to nullptr. More...
 
tResult GetName (base::ant::IString &&strName) const
 Gets the name of the streamer. More...
 
tResult SetType (const ucom::ant::iobject_ptr< const IStreamType > &pStreamType)
 Sets the StreamType of the streamer. More...
 
tResult GetType (ucom::ant::iobject_ptr< const IStreamType > &pStreamType) const override
 
tResult EndStreaming () override
 

Private Attributes

bool m_bManualTriggerRequired = false
 

Additional Inherited Members

- Public Types inherited from sample_streamer< ISampleWriter, cOutPin >
typedef cOutPin pin_type
 
- Protected Types inherited from cSampleWriter
typedef sample_streamer< ISampleWriter, cOutPinbase_type
 base type
 
- Protected Member Functions inherited from sample_streamer< ISampleWriter, cOutPin >
 sample_streamer (const sample_streamer &)=delete
 deleted copy CTOR
 
 sample_streamer (sample_streamer &&)=delete
 deleted move CTOR
 
sample_streameroperator= (const sample_streamer &)=delete
 deleted copy operator
 
sample_streameroperator= (sample_streamer &&)=delete
 deleted move operator
 
- Protected Member Functions inherited from ISampleWriter
 ~ISampleWriter ()=default
 not destructable
 
- Protected Member Functions inherited from ISampleStreamer
 ~ISampleStreamer ()=default
 not destructable
 
- Protected Attributes inherited from cSampleWriter
ucom::object_ptr< ISampleOutStreamm_pOutStream
 The SampleOutStream which is opened while BeginStreaming.
 
ucom::object_ptr< adtf::services::IReferenceClock_clock
 
- Protected Attributes inherited from sample_streamer< ISampleWriter, cOutPin >
adtf_util::cString m_strName
 name of the streamer (used i.e. to create the pins name)
 
ucom::object_ptr< const IStreamTypem_pStreamType
 stream type of the streamer
 
ucom::object_ptr< cOutPinm_poPin
 pin reference reading/writing from
 

Detailed Description

This class helps when porting ADTF 2 Filters to ADTF 3.

Use it instead of the old cOutputPin classes. See

See also
page_legacy_filter for an example of such a ported Filter.

Definition at line 60 of file legacy_filter.h.

Member Function Documentation

◆ Create() [1/2]

tResult Create ( const char *  strName,
const ucom::iobject_ptr< adtf::streaming::IStreamType > &  pStreamType 
)
inline

Initializes an instance of an Output Pin.

Parameters
[in]strNameThe name of the Pin.
[in]pStreamTypeThe Type of the Pin.
Returns
Standard result.

Definition at line 86 of file legacy_filter.h.

◆ Create() [2/2]

tResult Create ( const char *  strName,
const ucom::iobject_ptr< const adtf::streaming::IStreamType > &  pStreamType 
)
inline

Initializes an instance of an Output Pin.

Parameters
[in]strNameThe name of the Pin.
[in]pStreamTypeThe Type of the Pin.
Returns
Standard result.

Definition at line 73 of file legacy_filter.h.

◆ SetManualTriggerRequired()

void SetManualTriggerRequired ( bool  bManualTriggerRequired)
inline

For internal use only.

Parameters
[in]bManualTriggerRequiredFor internal use only.

Definition at line 97 of file legacy_filter.h.

Referenced by cLegacyStreamingSource::RegisterPin().

◆ Transmit()

tResult Transmit ( const ucom::iobject_ptr< const adtf::streaming::ISample > &  pSample)
inlineoverridevirtual

Transmits a sample via an Output Pin.

Parameters
[in]pSampleThe sample to transmit.
Returns
Standard result.

Reimplemented from cSampleWriter.

Definition at line 107 of file legacy_filter.h.

References cSampleWriter::ManualTrigger(), RETURN_IF_FAILED, RETURN_NOERROR, and cSampleWriter::Transmit().