iceoryx2
C++ Language Bindings
Loading...
Searching...
No Matches
iox2::TypeDetail Class Reference

#include <message_type_details.hpp>

Public Member Functions

 TypeDetail (TypeVariant variant, const char *type_name, size_t size, size_t alignment)
 Creates a [TypeDetail] from runtime values.
 
auto variant () const -> TypeVariant
 The [TypeVariant] of the type.
 
auto type_name () const -> const char *
 Contains the output of [typeid().name].
 
auto size () const -> size_t
 The size of the underlying type.
 
auto alignment () const -> size_t
 The alignment of the underlying type.
 

Friends

class MessageTypeDetails
 
class StaticConfigBlackboard
 

Detailed Description

Contains all type details required to connect to a [crate::service::Service]

Definition at line 23 of file message_type_details.hpp.

Constructor & Destructor Documentation

◆ TypeDetail()

iox2::TypeDetail::TypeDetail ( TypeVariant  variant,
const char *  type_name,
size_t  size,
size_t  alignment 
)

Creates a [TypeDetail] from runtime values.

Member Function Documentation

◆ alignment()

auto iox2::TypeDetail::alignment ( ) const -> size_t

The alignment of the underlying type.

◆ size()

auto iox2::TypeDetail::size ( ) const -> size_t

The size of the underlying type.

◆ type_name()

auto iox2::TypeDetail::type_name ( ) const -> const char *

Contains the output of [typeid().name].

◆ variant()

auto iox2::TypeDetail::variant ( ) const -> TypeVariant

The [TypeVariant] of the type.

Friends And Related Symbol Documentation

◆ MessageTypeDetails

friend class MessageTypeDetails
friend

Definition at line 41 of file message_type_details.hpp.

◆ StaticConfigBlackboard

friend class StaticConfigBlackboard
friend

Definition at line 42 of file message_type_details.hpp.


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