rtctk::telSub::FakeDdsSubscriber Class Reference

Fake DDS subscriber. More...

Inheritance diagram for rtctk::telSub::FakeDdsSubscriber:

Public Member Functions
	FakeDdsSubscriber (uint8_t num_topics, uint8_t batch_size)
AgnosticDataSamples &	GetSamples () noexcept override
	Returns reference to data structure holding taken data samples.
void	CheckDdsConnections () override
std::optional< DdsWaitSetError >	Take (std::chrono::nanoseconds timeout) noexcept override
	Fakes taking new samples.
size_t	GetNumberOfTopics () const noexcept override
	Returns the number of configured topics.
std::error_code	ReturnLoan (const std::string &topic, DdsSampleSeq &samples, DdsInfoSeq &infos) noexcept override
	Returns loaned sample sequence.
Public Member Functions inherited from rtctk::telSub::DdsWaitSetIf
	DdsWaitSetIf () RTCTK_NOEXCEPT
virtual	~DdsWaitSetIf () RTCTK_NOEXCEPT

Detailed Description

Fake DDS subscriber.

Constructor & Destructor Documentation

FakeDdsSubscriber()

rtctk::telSub::FakeDdsSubscriber::FakeDdsSubscriber ( uint8_t num_topics, uint8_t batch_size )

inline

Member Function Documentation

CheckDdsConnections()

void rtctk::telSub::FakeDdsSubscriber::CheckDdsConnections ( )

inlineoverridevirtual

Implements rtctk::telSub::DdsWaitSetIf.

GetNumberOfTopics()

size_t rtctk::telSub::FakeDdsSubscriber::GetNumberOfTopics ( ) const

inlineoverridevirtualnoexcept

Returns the number of configured topics.

This returns the number of topics that were configured during construction of the subscriber object. This corresponds to the size of the DdsParams::m_topics vector passed to the constructor.

Returns

The number of configured topics.

Implements rtctk::telSub::DdsWaitSetIf.

GetSamples()

AgnosticDataSamples & rtctk::telSub::FakeDdsSubscriber::GetSamples ( )

inlineoverridevirtualnoexcept

Returns reference to data structure holding taken data samples.

To update structure with new samples TakeSamples() must be used.

See also

TakeSamples()

Implements rtctk::telSub::DdsWaitSetIf.

ReturnLoan()

std::error_code rtctk::telSub::FakeDdsSubscriber::ReturnLoan ( const std::string & topic, DdsSampleSeq & samples, DdsInfoSeq & infos )

inlineoverridevirtualnoexcept

Returns loaned sample sequence.

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

Postcondition

Empty() == true

Parameters

topic	Topic name.
samples	Sample sequence.
infos	Sample information sequence.

Implements rtctk::telSub::SeqLoanerIf.

Take()

std::optional< DdsWaitSetError > rtctk::telSub::FakeDdsSubscriber::Take ( std::chrono::nanoseconds timeout )

inlineoverridevirtualnoexcept

Fakes taking new samples.

All it does is to update sample ids to be consecutive and return success.

Implements rtctk::telSub::DdsWaitSetIf.

---

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

• reusableComponents/telSub/bench/src/main.cpp