ADTF  3.14.3
sample_writer< DATA_TYPE, BASE >

Specialized Sample Writer to write data of a given type DATA_TYPE. More...

Inheritance diagram for sample_writer< DATA_TYPE, BASE >:
[legend]

Public Member Functions

 sample_writer ()
 Default CTOR.
 
tResult Write (const DATA_TYPE &oSampleData)
 Writes Data of the given DATA_TYPE. More...
 
tResult Write (tTimeStamp tmTime, const DATA_TYPE &oSampleData)
 
tResult Write (base::flash::tNanoSeconds tmTime, const DATA_TYPE &oSampleData)
 
tResult Transmit (const DATA_TYPE &oSampleData)
 
tResult Transmit (tTimeStamp tmTime, const DATA_TYPE &oSampleData)
 
tResult Transmit (base::flash::tNanoSeconds tmTime, const DATA_TYPE &oSampleData)
 
- Public Member Functions inherited from cSampleWriter
void SetName (const char *strName) override
 Sets the name of the streamer. More...
 
tResult GetName (base::ant::IString &&strName) override
 Retrieves the name of the streamer. More...
 
tResult SetType (const ucom::ant::iobject_ptr< const ant::IStreamType > &pStreamType) override
 Sets the initial stream type of a streamer. More...
 
tResult GetType (ucom::ant::iobject_ptr< const ant::IStreamType > &pStreamType) const override
 Returns the initial stream type of the streamer. More...
 
tResult BeginStreaming (ISampleStream &oSampleStream) override
 Begin streaming on the given sample stream. More...
 
tResult EndStreaming () override
 End streaming. More...
 
tResult SetStreamerPin (const ucom::ant::iobject_ptr< IStreamerPin > &pStreamerPin) override
 Sets the pin that the streamer is associated with. More...
 
tResult Write (const ucom::ant::iobject_ptr< const ant::ISample > &pSample) override
 Writes a sample to the connected sample stream. More...
 
virtual tResult Transmit (const ucom::ant::iobject_ptr< const ant::ISample > &pSample)
 For compatibility purposes, call Write() instead. More...
 
tResult ChangeType (const ucom::ant::iobject_ptr< const ant::IStreamType > &pType) override
 Communicates a type change for all following samples. More...
 
tResult Flush () override
 Flushes the writer. More...
 
tResult SetStreamError (tResult oError) override
 Reports and handles an error via the sample stream. More...
 
tResult ManualTrigger (base::flash::tNanoSeconds tmActivationTime=base::flash::tNanoSeconds {-1}) override
 Calls all connected runners synchronously in this call. More...
 

Protected Attributes

ucom::ant::object_ptr< services::flash::IReferenceClockm_pClock
 
- Protected Attributes inherited from cSampleWriter
std::unique_ptr< cImplementation > m_pImplementation
 

Detailed Description

template<typename DATA_TYPE, typename BASE = cSampleWriter>
class adtf::streaming::flash::sample_writer< DATA_TYPE, BASE >

Specialized Sample Writer to write data of a given type DATA_TYPE.

The operator << will be overloaded to write data.

Template Parameters
DATA_TYPEthe type which is written. This Sample content is created and written at Write call.
BASEthe base adtf::streaming::flash::ISampleWriter Implementation (default is adtf::streaming::flash::cSampleWriter).

Definition at line 444 of file samplewriter.h.

Member Function Documentation

◆ Write()

tResult Write ( const DATA_TYPE &  oSampleData)
inline

Writes Data of the given DATA_TYPE.

The Sample Time of the created Sample is retrieved from the IReferenceClock (if any exists).

Parameters
oSampleDatareference to the data of DATA_TYPE (important, these are plain-types or old fashioned c-struct type)
Returns
tResult

Definition at line 463 of file samplewriter.h.


Copyright © Audi Electronics Venture GmbH. All rights reserved. (Generated on Thu Jun 9 2022 by doxygen 1.9.1)