RTC Toolkit  2.0.0
Public Member Functions | List of all members
rtctk::telSub::SeqLoanerIf Class Referenceabstract

Loaner interface. More...

#include <agnosticDataSamples.hpp>

Inheritance diagram for rtctk::telSub::SeqLoanerIf:
rtctk::telSub::DdsWaitSet rtctk::telSub::FakeDdsSubscriber

Public Member Functions

virtual std::error_code ReturnLoan (std::uint8_t idx, DdsSampleSeq &samples, DdsInfoSeq &infos) RTCTK_NOEXCEPT=0
 Returns loaned sample sequence. More...
 

Detailed Description

Loaner interface.

Member Function Documentation

◆ ReturnLoan()

virtual std::error_code rtctk::telSub::SeqLoanerIf::ReturnLoan ( std::uint8_t  idx,
DdsSampleSeq samples,
DdsInfoSeq infos 
)
pure virtual

Returns loaned sample sequence.

After invoking this method successfully the provided sequences will be emptied.

Postcondition
samples.length() == 0u && infos.length() == 0
Parameters
idxTopic index.
samplesSample sequence.
infosSample information sequence.

Implemented in rtctk::telSub::DdsWaitSet, and rtctk::telSub::FakeDdsSubscriber.


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