Skip to content

iox::popo::ApplicationPort🔗

Inherits from iox::popo::BasePort

Public Types🔗

Name
using ApplicationPortData MemberType_t

Public Functions🔗

Name
ApplicationPort(ApplicationPortData *const applicationPortDataPtr)
ApplicationPort(const ApplicationPort & other)
ApplicationPort & operator=(const ApplicationPort & other)
ApplicationPort(ApplicationPort && other) =default
ApplicationPort & operator=(ApplicationPort && other) =default
~ApplicationPort() =default
cxx::optional< capro::CaproMessage > tryGetCaProMessage()
get an optional CaPro message that was provided by the application
void dispatchCaProMessage(const capro::CaproMessage & caProMessage)
dispatch a CaPro message from the application side to the daemon

Additional inherited members🔗

Public Functions inherited from iox::popo::BasePort

Name
BasePort(MemberType_t *const basePortDataPtr)
BasePort(const BasePort & other)
BasePort(BasePort && )
virtual ~BasePort() =default
operator bool() const
a port can be constructed from a nullptr, additionally it also can be moved and in these cases the member methods would work on a nullptr. to circumvent this problem
capro::ServiceDescription getCaProServiceDescription() const
Reads Type of actual CaPro Port (publisher/subscriber...)
RuntimeName_t getRuntimeName() const
Gets name of the application's runtime for the active port.
UniquePortId getUniqueID() const
Gets Id of the active port.
NodeName_t getNodeName() const
returns node name for the active port
void destroy()
Indicate that this port can be destroyed.
bool toBeDestroyed() const
Checks whether port can be destroyed.

Public Types Documentation🔗

using MemberType_t🔗

using iox::popo::ApplicationPort::MemberType_t =  ApplicationPortData;

Public Functions Documentation🔗

function ApplicationPort🔗

explicit ApplicationPort(
    ApplicationPortData *const applicationPortDataPtr
)

function ApplicationPort🔗

ApplicationPort(
    const ApplicationPort & other
)

function operator=🔗

ApplicationPort & operator=(
    const ApplicationPort & other
)

function ApplicationPort🔗

ApplicationPort(
    ApplicationPort && other
) =default

function operator=🔗

ApplicationPort & operator=(
    ApplicationPort && other
) =default

function ~ApplicationPort🔗

~ApplicationPort() =default

function tryGetCaProMessage🔗

cxx::optional< capro::CaproMessage > tryGetCaProMessage()

get an optional CaPro message that was provided by the application

Return: CaPro message, empty optional if no new messages

function dispatchCaProMessage🔗

void dispatchCaProMessage(
    const capro::CaproMessage & caProMessage
)

dispatch a CaPro message from the application side to the daemon

Parameters:

  • caProMessage

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