iox::dds::CycloneDataReader🔗

Implementation of the DataReader abstraction using the cyclonedds implementation.

#include <cyclone_data_reader.hpp>

Public Functions🔗

	Name
	CycloneDataReader()
	CycloneDataReader(const capro::IdString_t serviceId, const capro::IdString_t instanceId, const capro::IdString_t eventId)
virtual	~CycloneDataReader()
	CycloneDataReader(const CycloneDataReader & )
CycloneDataReader &	operator=(const CycloneDataReader & )
	CycloneDataReader(CycloneDataReader && )
CycloneDataReader &	operator=(CycloneDataReader && )
virtual void	connect() override connect Connect the DataReader to the underlying DDS network.
virtual iox::cxx::optional< IoxChunkDatagramHeader >	peekNextIoxChunkDatagramHeader() override peekNextIoxChunkDatagramHeader Get the IoxChunkDatagramHeader of the next sample if one is available.
virtual bool	hasSamples() override hasSamples Checks if new samples ready to take.
virtual iox::cxx::expected< DataReaderError >	takeNext(const IoxChunkDatagramHeader datagramHeader, uint8_t const userHeaderBuffer, uint8_t const userPayloadBuffer) override take Take the next available sample from the DDS data space.
virtual capro::IdString_t	getServiceId() const override getServiceId
virtual capro::IdString_t	getInstanceId() const override getInstanceId
virtual capro::IdString_t	getEventId() const override getEventId

Additional inherited members🔗

Protected Functions inherited from iox::dds::DataReader

	Name
	DataReader() =default

Public Functions Documentation🔗

function CycloneDataReader🔗

CycloneDataReader()

function CycloneDataReader🔗

CycloneDataReader(
    const capro::IdString_t serviceId,
    const capro::IdString_t instanceId,
    const capro::IdString_t eventId
)

function ~CycloneDataReader🔗

virtual ~CycloneDataReader()

function CycloneDataReader🔗

CycloneDataReader(
    const CycloneDataReader & 
)

function operator=🔗

CycloneDataReader & operator=(
    const CycloneDataReader & 
)

function CycloneDataReader🔗

CycloneDataReader(
    CycloneDataReader && 
)

function operator=🔗

CycloneDataReader & operator=(
    CycloneDataReader && 
)

function connect🔗

virtual void connect() override

connect Connect the DataReader to the underlying DDS network.

Reimplements: iox::dds::DataReader::connect

function peekNextIoxChunkDatagramHeader🔗

virtual iox::cxx::optional< IoxChunkDatagramHeader > peekNextIoxChunkDatagramHeader() override

peekNextIoxChunkDatagramHeader Get the IoxChunkDatagramHeader of the next sample if one is available.

Return: The IoxChunkDatagramHeader of the next sample if one is available.

Reimplements: iox::dds::DataReader::peekNextIoxChunkDatagramHeader

function hasSamples🔗

virtual bool hasSamples() override

hasSamples Checks if new samples ready to take.

Return: True if new samples available.

Reimplements: iox::dds::DataReader::hasSamples

function takeNext🔗

virtual iox::cxx::expected< DataReaderError > takeNext(
    const IoxChunkDatagramHeader datagramHeader,
    uint8_t *const userHeaderBuffer,
    uint8_t *const userPayloadBuffer
) override

take Take the next available sample from the DDS data space.

Parameters:

datagramHeader with size information
userHeaderBuffer buffer for the user-header
userPayloadBuffer buffer for the user-payload

Return: Error if unsuccessful.

Reimplements: iox::dds::DataReader::takeNext

function getServiceId🔗

virtual capro::IdString_t getServiceId() const override

getServiceId

Return: The ID of the service producing the bytes

Reimplements: iox::dds::DataReader::getServiceId

function getInstanceId🔗

virtual capro::IdString_t getInstanceId() const override

getInstanceId

Return: The ID of the instance of the service producing the bytes

Reimplements: iox::dds::DataReader::getInstanceId

function getEventId🔗

virtual capro::IdString_t getEventId() const override

getEventId

Return: The ID of the event producing the data

Reimplements: iox::dds::DataReader::getEventId

Updated on 31 May 2022 at 15:29:16 CEST