Skip to content

iox::popo::InterfacePort🔗

Inherits from iox::popo::BasePort

Public Functions🔗

Name
InterfacePort(InterfacePortData *const interfacePortDataPtr)
InterfacePort(const InterfacePort & other)
InterfacePort & operator=(const InterfacePort & other)
InterfacePort(InterfacePort && other) =default
InterfacePort & operator=(InterfacePort && other) =default
~InterfacePort() =default
cxx::optional< capro::CaproMessage > tryGetCaProMessage()
get an optional CaPro message for the interface port to process
void dispatchCaProMessage(const capro::CaproMessage & caProMessage)
dispatch a CaPro message to this interface port

Additional inherited members🔗

Public Types inherited from iox::popo::BasePort

Name
using BasePortData MemberType_t

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 Functions Documentation🔗

function InterfacePort🔗

explicit InterfacePort(
    InterfacePortData *const interfacePortDataPtr
)

function InterfacePort🔗

InterfacePort(
    const InterfacePort & other
)

function operator=🔗

InterfacePort & operator=(
    const InterfacePort & other
)

function InterfacePort🔗

InterfacePort(
    InterfacePort && other
) =default

function operator=🔗

InterfacePort & operator=(
    InterfacePort && other
) =default

function ~InterfacePort🔗

~InterfacePort() =default

function tryGetCaProMessage🔗

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

get an optional CaPro message for the interface port to process

Return: CaPro message, empty optional if no new messages

function dispatchCaProMessage🔗

void dispatchCaProMessage(
    const capro::CaproMessage & caProMessage
)

dispatch a CaPro message to this interface port

Parameters:

  • caProMessage

Updated on 26 April 2021 at 15:31:02 CEST