adtf::streaming::cSampleWriter Class Reference

#include <samplewriter.h>

Inherits adtf::streaming::flash::ISampleWriter.

Inherited by adtf::streaming::hollow::writer_with_request_broker< adtf::streaming::cSampleWriter >, adtf::mediadescription::flash::encoding_sample_writer< WriterImplementation >, adtf::mediadescription::osborn::encoding_sample_writer< WriterImplementation >, adtf::streaming::flash::sample_writer< DATA_TYPE, BASE >, adtf::streaming::hollow::writer_with_request_broker< BaseWriter >, and adtf::streaming::vision::cRequestForwardingWriter.

Public Member Functions
void	SetName (const char *strName) override
tResult	GetName (base::ant::IString &&strName) override
tResult	SetType (const ucom::ant::iobject_ptr< const ant::IStreamType > &pStreamType) override
tResult	GetType (ucom::ant::iobject_ptr< const ant::IStreamType > &pStreamType) const override
tResult	BeginStreaming (ISampleStream &oSampleStream) override
tResult	EndStreaming () override
tResult	SetStreamerPin (const ucom::ant::iobject_ptr< IStreamerPin > &pStreamerPin) override
tResult	GetStreamerPin (ucom::ant::iobject_ptr< IStreamerPin > &pStreamerPin) const
tResult	Write (const ucom::ant::iobject_ptr< const ant::ISample > &pSample) override
virtual tResult	Transmit (const ucom::ant::iobject_ptr< const ant::ISample > &pSample)
tResult	ChangeType (const ucom::ant::iobject_ptr< const ant::IStreamType > &pType) override
tResult	Flush () override
tResult	SetStreamError (tResult oError) override
tResult	ManualTrigger (base::flash::tNanoSeconds tmActivationTime=base::flash::tNanoSeconds{-1}) override
Public Member Functions inherited from adtf::streaming::flash::ISampleStreamer
virtual tResult	SetStreamerPin (const ucom::ant::iobject_ptr< flash::IStreamerPin > &pStreamerPin)=0

Detailed Description

This base implementation of a sample writer is samples and types to the given pin set at adtf::streaming::flash::cSampleWriter::SetStreamerPin.

Member Function Documentation

BeginStreaming()

tResult adtf::streaming::flash::cSampleWriter::BeginStreaming ( ISampleStream & pStream )

overridevirtual

Begin streaming on the given sample stream.

Parameters

[in]

pStream

the sample stream.

Returns

Standard result.

Implements adtf::streaming::flash::ISampleStreamer.

ChangeType()

tResult adtf::streaming::flash::cSampleWriter::ChangeType ( const ucom::ant::iobject_ptr< const ant::IStreamType > & pType )

overridevirtual

Communicates a type change for all following samples.

Parameters

[in]

pType

The new stream type

Returns

Standard result. Errors will be reported via the associated sample stream.

Implements adtf::streaming::flash::ISampleWriter.

EndStreaming()

tResult adtf::streaming::flash::cSampleWriter::EndStreaming ( )

overridevirtual

End streaming

Returns

Standard result.

Implements adtf::streaming::flash::ISampleStreamer.

Flush()

tResult adtf::streaming::flash::cSampleWriter::Flush ( )

overridevirtual

Flushes the writer.

Returns

Standard result.

Implements adtf::streaming::flash::ISampleWriter.

GetName()

tResult adtf::streaming::flash::cSampleWriter::GetName ( base::ant::IString && strName )

overridevirtual

Retrieves the name of the streamer

Parameters

[out]

strName

This will be updated with the name.

Returns

Standard result.

Implements adtf::streaming::flash::ISampleStreamer.

GetStreamerPin()

tResult adtf::streaming::flash::cSampleWriter::GetStreamerPin

(

ucom::ant::iobject_ptr< IStreamerPin > &

pStreamerPin

)

const

Returns the streamer pin set at adtf::streaming::flash::cSampleWriter::SetStreamerPin.

Parameters

[out]

pStreamerPin

the streamer pin reference to return

Returns

Standard Result Code

Return values

ERR_NOERROR

if a streamer pin is set and returned successfully

GetType()

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

overridevirtual

Returns the initial stream type of the streamer.

Parameters

[out]

pStreamType

This will reference the initial stream type.

Returns

Standard result.

Implements adtf::streaming::flash::ISampleStreamer.

ManualTrigger()

tResult adtf::streaming::flash::cSampleWriter::ManualTrigger ( base::flash::tNanoSeconds tmActivationTime = base::flash::tNanoSeconds{-1} )

overridevirtual

Calls all connected runners synchronously in this call.

Parameters

[in]

tmActivationTime

The timestamp passed to all runners. If equals -1, the current stream time is retrieved from the reference clock.

Returns

Standard result. Errors will be reported via the associated sample stream.

Implements adtf::streaming::flash::ISampleWriter.

SetName()

void adtf::streaming::flash::cSampleWriter::SetName ( const char * strName )

overridevirtual

Sets the name of the streamer. This will be used when creating pins.

Parameters

[in]

strName

The name

Implements adtf::streaming::flash::ISampleStreamer.

SetStreamError()

tResult adtf::streaming::flash::cSampleWriter::SetStreamError ( tResult oError )

overridevirtual

Reports and handles an error via the sample stream. Mind that you still need to cope with the error in the best possible manner.

Parameters

[in]

oError

The error code.

Returns

Standard result.

Implements adtf::streaming::flash::ISampleWriter.

SetType()

tResult adtf::streaming::flash::cSampleWriter::SetType ( const ucom::ant::iobject_ptr< const ant::IStreamType > & pStreamType )

overridevirtual

Sets the initial stream type of a streamer.

Parameters

[in]

pStreamType

The stream type

Returns

Standard result.

Implements adtf::streaming::flash::ISampleStreamer.

Transmit()

virtual tResult adtf::streaming::flash::cSampleWriter::Transmit ( const ucom::ant::iobject_ptr< const ant::ISample > & pSample )

virtual

For compatibility purposes, call Write() instead.

Writes a sample to the connected sample stream.

Parameters

[in]

pSample

The sample to write

Returns

Standard result. Errors will be reported via the associated sample stream.

Write()

tResult adtf::streaming::flash::cSampleWriter::Write ( const ucom::ant::iobject_ptr< const ant::ISample > & pSample )

overridevirtual

Writes a sample to the connected sample stream.

Parameters

[in]

pSample

The sample to write

Returns

Standard result. Errors will be reported via the associated sample stream.

Implements adtf::streaming::flash::ISampleWriter.

---

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

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