iceoryx_doc  1.0.1
Public Member Functions | Public Attributes | List of all members
iox::runtime::NodeProperty Struct Reference

helper struct which is convertable to string and constructable from a string which is required to send the createNode request over the IPC channel More...

#include <node_property.hpp>

Public Member Functions

 NodeProperty (const iox::NodeName_t &name, const uint64_t nodeDeviceIdentifier) noexcept
 constructor More...
 
 NodeProperty (const cxx::Serialization &serialized) noexcept
 serialization constructor, used by the IPC channel message to create NodeProperty from a received message More...
 
 operator cxx::Serialization () const noexcept
 serialization of the node properties
 

Public Attributes

iox::NodeName_t m_name
 
uint64_t m_nodeDeviceIdentifier
 

Detailed Description

helper struct which is convertable to string and constructable from a string which is required to send the createNode request over the IPC channel

Constructor & Destructor Documentation

◆ NodeProperty() [1/2]

iox::runtime::NodeProperty::NodeProperty ( const iox::NodeName_t &  name,
const uint64_t  nodeDeviceIdentifier 
)
noexcept

constructor

Parameters
[in]namename of the node
[in]nodeDeviceIdentifieridentifier of the device on which the node will run

◆ NodeProperty() [2/2]

iox::runtime::NodeProperty::NodeProperty ( const cxx::Serialization &  serialized)
noexcept

serialization constructor, used by the IPC channel message to create NodeProperty from a received message

Parameters
[in]serializedraw serialized string where all the values are stored

The documentation for this struct was generated from the following file: