ADTF  3.14.3
writer_with_request_broker< BaseWriter >

Template that will register a request broker (an implementation of IStreamingRequests) at the connected Sample Stream. More...

Inheritance diagram for writer_with_request_broker< BaseWriter >:
[legend]

Public Member Functions

void SetBroker (const ucom::ant::iobject_ptr< IStreamingRequests > &pBroker)
 Use this to set the broker instance after the writer has been created. More...
 
tResult BeginStreaming (streaming::ant::ISampleStream &oSampleStream) override
 Begin streaming on the given sample stream. More...
 
tResult EndStreaming () override
 End streaming. More...
 
- 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...
 

Private Attributes

ucom::ant::object_ptr< IStreamingRequestsm_pBroker
 
ucom::ant::object_ptr< ant::IBindingProxym_pProxy
 

Additional Inherited Members

- Protected Attributes inherited from cSampleWriter
std::unique_ptr< cImplementation > m_pImplementation
 

Detailed Description

template<typename BaseWriter = adtf::streaming::cSampleWriter>
class adtf::streaming::hollow::writer_with_request_broker< BaseWriter >

Template that will register a request broker (an implementation of IStreamingRequests) at the connected Sample Stream.

Definition at line 78 of file requestable_writer.h.

Member Function Documentation

◆ BeginStreaming()

tResult BeginStreaming ( streaming::ant::ISampleStream pStream)
inlineoverridevirtual

Begin streaming on the given sample stream.

Parameters
[in]pStreamthe sample stream.
Returns
Standard result.

Implements ISampleStreamer.

Definition at line 91 of file requestable_writer.h.

References RETURN_IF_FAILED.

◆ EndStreaming()

tResult EndStreaming ( )
inlineoverridevirtual

End streaming.

Returns
Standard result.

Implements ISampleStreamer.

Definition at line 102 of file requestable_writer.h.

◆ SetBroker()

void SetBroker ( const ucom::ant::iobject_ptr< IStreamingRequests > &  pBroker)
inline

Use this to set the broker instance after the writer has been created.

Parameters
[in]pBrokerThe broker.

Definition at line 86 of file requestable_writer.h.

Referenced by requestable_writer< BaseWriter >::requestable_writer().


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