Base class abstracting DDS communication code. More...
#include <ddsSubscriberIf.hpp>
Public Member Functions | |
| DdsSubscriberIf () | |
| virtual | ~DdsSubscriberIf () noexcept |
| virtual std::error_code | TakeSamples (std::vector< std::vector< const rtctk::AgnosticTopic * >> &samples, std::chrono::nanoseconds timeout) const noexcept=0 |
| Retrieves the buffers for the next data samples received from DDS. More... | |
| virtual std::error_code | ReturnSamples (const std::vector< const rtctk::AgnosticTopic * > &samples) const noexcept=0 |
| Releases buffers for previously retrieved data samples. More... | |
| virtual size_t | GetNumberOfTopics () const noexcept=0 |
| Returns the number of configured topics. More... | |
| virtual const std::string & | GetTopicName (size_t index) const noexcept=0 |
| Returns a string containing the name of a configured topic. More... | |
Detailed Description
Base class abstracting DDS communication code.
Constructor & Destructor Documentation
◆ DdsSubscriberIf()
|
inline |
◆ ~DdsSubscriberIf()
|
inlinevirtualnoexcept |
Member Function Documentation
◆ GetNumberOfTopics()
|
pure virtualnoexcept |
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.
Implemented in rtctk::telSub::DdsSubscriber.
◆ GetTopicName()
|
pure virtualnoexcept |
Returns a string containing the name of a configured topic.
This returns the name of a configured DDS topic as a string. The topic name is associated with the index'th DDS reader and will also identify the topic for samples[index], which is the output parameter vector filled by TakeSamples containing newly arrived DDS samples for the index'th DDS reader.
- Parameters
-
[in] index This selects which topic name to fetch. The value must be in the range 0 <= index and index < GetNumberOfTopics().
- Returns
- The index'th topic name.
Implemented in rtctk::telSub::DdsSubscriber.
◆ ReturnSamples()
|
pure virtualnoexcept |
Releases buffers for previously retrieved data samples.
This method must be called to release any internal resources allocated, that are associated with the samples previously returned by a call to TakeSamples. It is allowed to call this method on subsets of the AgnosticTopic pointers returned by TakeSamples over multiple invocations. In the extreme case one can call ReturnSamples on individual AgnosticTopic pointers. However, it will be more efficient to batch the calls as much as possible.
An empty / zero error code is returned if the resources were successfully released. Otherwise an appropriate error code is returned if the resources could not be released.
- Parameters
-
[in] samples Contains a vector of AgnosticTopic pointers previously returned by a call to TakeSamples.
- Returns
- An error code indicating the success or failure of the operation.
The following is a list of possible error codes returned:
0- Resources were successfully released.
std::errc::protocol_error- A call to the RTI DDS API failed.
std::errc::bad_address- Could not find associated resourced for a sample given in the
samplesvector.
Implemented in rtctk::telSub::DdsSubscriber.
◆ TakeSamples()
|
pure virtualnoexcept |
Retrieves the buffers for the next data samples received from DDS.
The method waits for new DDS samples to become available on one or more of the DDS topic readers. For any samples received the output samples parameter structure is filled with pointers to the AgnosticTopic structures received from DDS. An empty / zero error code is returned if the operation completed successfully, meaning at least on sample for any DDS topic reader has been received. If no samples were available within the timeout period then a std::errc::timed_out error code is returned. If some other error occurred, an appropriate error code is returned.
- Parameters
-
[out] samples This should be a vector of vectors prepared by the caller that will be filled with AgnosticTopic pointers corresponding to samples received from DDS. The first dimension of the double vector structure corresponds to the configured DDS topics, i.e. samples[n] will contain all the samples received for the n'th topic and n'th reader. Individual topic names can be fetched with GetTopicName. It is possible that no samples were received for a particular topic, e.g. samples[i], in which case the vector will be empty, i.e. samples[i].empty() == true. [in] timeout The maximum amount of time to wait for this operation to complete, measured in nanoseconds.
- Returns
- An error code indicating success, failure or timeout of the operation.
The following is the list of possible error codes returned:
0- At least one samples was successfully returned.
std::errc::timed_out- The operation timed out while waiting for DDS samples.
std::errc::protocol_error- A call to the RTI DDS API failed.
std::errc::bad_address- Could not identify the associated topic reader for a sample.
- Precondition
samples.size()== GetNumberOfTopics().
- Note
- All AgnosticTopic pointers received by the caller in
samplesmust eventually be returned with a call to ReturnSamples to release the underlying RTI DDS buffers.
Implemented in rtctk::telSub::DdsSubscriber.
The documentation for this class was generated from the following file:
- reusableComponents/telSub/library/src/include/rtctk/telSub/ddsSubscriberIf.hpp
