Skip to content

iox::dds::CycloneDataReader🔗

Implementation of the DataReader abstraction using the cyclonedds implementation. #include <iceoryx_dds/dds/cyclone_data_reader.hpp>

Inherits from iox::dds::DataReader

Public Functions🔗

Name
CycloneDataReader()
CycloneDataReader(const capro::IdString_t serviceId, const capro::IdString_t instanceId, const capro::IdString_t eventId)
Constructor to set cyclone data reader object from given IDs.
virtual ~CycloneDataReader()
CycloneDataReader(const CycloneDataReader & )
CycloneDataReader & operator=(const CycloneDataReader & )
CycloneDataReader(CycloneDataReader && )
CycloneDataReader & operator=(CycloneDataReader && )
virtual void connect() override
Connect cylcone data reader 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
Checks if new samples are 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
get ID of the service
virtual capro::IdString_t getInstanceId() const override
get ID of the instance
virtual capro::IdString_t getEventId() const override
get ID of the event

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
)

Constructor to set cyclone data reader object from given IDs.

Parameters:

  • serviceId ID of the service
  • instanceId ID of the instance of the service
  • eventId ID of the event

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 cylcone data reader 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

Checks if new samples are ready to take.

Return: True if new samples are 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

get ID of the service

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

function getInstanceId🔗

virtual capro::IdString_t getInstanceId() const override

get ID of the instance

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

function getEventId🔗

virtual capro::IdString_t getEventId() const override

get ID of the event

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

Updated on 18 December 2023 at 13:11:43 CET