Ignition Msgs

API Reference

5.8.1

#include <entity.pb.h>

Public Types

enum  : int { kNameFieldNumber = 3 , kHeaderFieldNumber = 1 , kIdFieldNumber = 2 , kTypeFieldNumber = 4 }
 
typedef Entity_Type Type
 

Public Member Functions

 Entity ()
 
constexpr Entity (::PROTOBUF_NAMESPACE_ID::internal::ConstantInitialized)
 
 Entity (const Entity &from)
 
 Entity (Entity &&from) noexcept
 
 ~Entity () override
 
const char * _InternalParse (const char *ptr, ::PROTOBUF_NAMESPACE_ID::internal::ParseContext *ctx) final
 
uint8_t * _InternalSerialize (uint8_t *target, ::PROTOBUF_NAMESPACE_ID::io::EpsCopyOutputStream *stream) const final
 
size_t ByteSizeLong () const final
 
PROTOBUF_ATTRIBUTE_REINITIALIZES void Clear () final
 
void clear_header ()
 
void clear_id ()
 
void clear_name ()
 
void clear_type ()
 
void CopyFrom (const Entity &from)
 
int GetCachedSize () const final
 
const ::PROTOBUF_NAMESPACE_ID::Message::ClassData * GetClassData () const final
 
::PROTOBUF_NAMESPACE_ID::Metadata GetMetadata () const final
 
bool has_header () const
 
const ::ignition::msgs::Headerheader () const
 
uint64_t id () const
 
bool IsInitialized () const final
 
void MergeFrom (const Entity &from)
 
::ignition::msgs::Headermutable_header ()
 
std::stringmutable_name ()
 
const std::stringname () const
 
EntityNew (::PROTOBUF_NAMESPACE_ID::Arena *arena=nullptr) const final
 
Entityoperator= (const Entity &from)
 
Entityoperator= (Entity &&from) noexcept
 
PROTOBUF_NODISCARD ::ignition::msgs::Headerrelease_header ()
 
PROTOBUF_NODISCARD std::stringrelease_name ()
 
void set_allocated_header (::ignition::msgs::Header *header)
 
void set_allocated_name (std::string *name)
 
void set_id (uint64_t value)
 
template<typename ArgT0 = const std::string&, typename... ArgT>
void set_name (ArgT0 &&arg0, ArgT... args)
 
template<typename ArgT0 , typename... ArgT>
PROTOBUF_ALWAYS_INLINE void set_name (ArgT0 &&arg0, ArgT... args)
 
void set_type (::ignition::msgs::Entity_Type value)
 
void Swap (Entity *other)
 
::ignition::msgs::Entity_Type type () const
 
::ignition::msgs::Headerunsafe_arena_release_header ()
 
void unsafe_arena_set_allocated_header (::ignition::msgs::Header *header)
 
void UnsafeArenaSwap (Entity *other)
 

Static Public Member Functions

static const Entitydefault_instance ()
 
static const ::PROTOBUF_NAMESPACE_ID::Descriptor * descriptor ()
 
static const ::PROTOBUF_NAMESPACE_ID::Descriptor * GetDescriptor ()
 
static const ::PROTOBUF_NAMESPACE_ID::Reflection * GetReflection ()
 
static const Entityinternal_default_instance ()
 
static const ::PROTOBUF_NAMESPACE_ID::EnumDescriptor * Type_descriptor ()
 
static bool Type_IsValid (int value)
 
template<typename T >
static const std::stringType_Name (T enum_t_value)
 
static bool Type_Parse (::PROTOBUF_NAMESPACE_ID::ConstStringParam name, Type *value)
 

Static Public Attributes

static const ClassData _class_data_
 
static constexpr Type COLLISION
 
static constexpr Type JOINT
 
static constexpr int kIndexInFileMessages
 
static constexpr Type LIGHT
 
static constexpr Type LINK
 
static constexpr Type MODEL
 
static constexpr Type NONE
 
static constexpr Type SENSOR
 
static constexpr int Type_ARRAYSIZE
 
static constexpr Type Type_MAX
 
static constexpr Type Type_MIN
 
static constexpr Type VISUAL
 

Protected Member Functions

 Entity (::PROTOBUF_NAMESPACE_ID::Arena *arena, bool is_message_owned=false)
 

Member Typedef Documentation

◆ Type

typedef Entity_Type Type

Member Enumeration Documentation

◆ anonymous enum

anonymous enum : int
Enumerator
kNameFieldNumber 
kHeaderFieldNumber 
kIdFieldNumber 
kTypeFieldNumber 

Constructor & Destructor Documentation

◆ Entity() [1/5]

Entity ( )
inline

◆ ~Entity()

~Entity ( )
override

◆ Entity() [2/5]

constexpr Entity ( ::PROTOBUF_NAMESPACE_ID::internal::ConstantInitialized  )
explicitconstexpr

◆ Entity() [3/5]

Entity ( const Entity from)

◆ Entity() [4/5]

Entity ( Entity &&  from)
inlinenoexcept

◆ Entity() [5/5]

Entity ( ::PROTOBUF_NAMESPACE_ID::Arena *  arena,
bool  is_message_owned = false 
)
explicitprotected

Member Function Documentation

◆ _InternalParse()

const char* _InternalParse ( const char *  ptr,
::PROTOBUF_NAMESPACE_ID::internal::ParseContext *  ctx 
)
final

◆ _InternalSerialize()

uint8_t* _InternalSerialize ( uint8_t *  target,
::PROTOBUF_NAMESPACE_ID::io::EpsCopyOutputStream *  stream 
) const
final

◆ ByteSizeLong()

size_t ByteSizeLong ( ) const
final

◆ Clear()

PROTOBUF_ATTRIBUTE_REINITIALIZES void Clear ( )
final

◆ clear_header()

void clear_header ( )

◆ clear_id()

void clear_id ( )
inline

◆ clear_name()

void clear_name ( )
inline

◆ clear_type()

void clear_type ( )
inline

◆ CopyFrom()

void CopyFrom ( const Entity from)

◆ default_instance()

static const Entity& default_instance ( )
inlinestatic

◆ descriptor()

static const ::PROTOBUF_NAMESPACE_ID::Descriptor* descriptor ( )
inlinestatic

◆ GetCachedSize()

int GetCachedSize ( ) const
inlinefinal

◆ GetClassData()

const ::PROTOBUF_NAMESPACE_ID::Message::ClassData* GetClassData ( ) const
final

◆ GetDescriptor()

static const ::PROTOBUF_NAMESPACE_ID::Descriptor* GetDescriptor ( )
inlinestatic

◆ GetMetadata()

::PROTOBUF_NAMESPACE_ID::Metadata GetMetadata ( ) const
final

◆ GetReflection()

static const ::PROTOBUF_NAMESPACE_ID::Reflection* GetReflection ( )
inlinestatic

◆ has_header()

bool has_header ( ) const
inline

◆ header()

const ::ignition::msgs::Header & header ( ) const
inline

◆ id()

uint64_t id ( ) const
inline

◆ internal_default_instance()

static const Entity* internal_default_instance ( )
inlinestatic

◆ IsInitialized()

bool IsInitialized ( ) const
final

◆ MergeFrom()

void MergeFrom ( const Entity from)

◆ mutable_header()

ignition::msgs::Header * mutable_header ( )
inline

◆ mutable_name()

std::string * mutable_name ( )
inline

◆ name()

const std::string & name ( ) const
inline

◆ New()

Entity* New ( ::PROTOBUF_NAMESPACE_ID::Arena *  arena = nullptr) const
inlinefinal

◆ operator=() [1/2]

Entity& operator= ( const Entity from)
inline

◆ operator=() [2/2]

Entity& operator= ( Entity &&  from)
inlinenoexcept

◆ release_header()

ignition::msgs::Header * release_header ( )
inline

◆ release_name()

std::string * release_name ( )
inline

◆ set_allocated_header()

void set_allocated_header ( ::ignition::msgs::Header header)
inline

◆ set_allocated_name()

void set_allocated_name ( std::string name)
inline

◆ set_id()

void set_id ( uint64_t  value)
inline

◆ set_name() [1/2]

void set_name ( ArgT0 &&  arg0,
ArgT...  args 
)

◆ set_name() [2/2]

PROTOBUF_ALWAYS_INLINE void set_name ( ArgT0 &&  arg0,
ArgT...  args 
)
inline

◆ set_type()

void set_type ( ::ignition::msgs::Entity_Type  value)
inline

◆ Swap()

void Swap ( Entity other)
inline

◆ type()

ignition::msgs::Entity_Type type ( ) const
inline

◆ Type_descriptor()

static const ::PROTOBUF_NAMESPACE_ID::EnumDescriptor* Type_descriptor ( )
inlinestatic

◆ Type_IsValid()

static bool Type_IsValid ( int  value)
inlinestatic

◆ Type_Name()

static const std::string& Type_Name ( enum_t_value)
inlinestatic

◆ Type_Parse()

static bool Type_Parse ( ::PROTOBUF_NAMESPACE_ID::ConstStringParam  name,
Type value 
)
inlinestatic

◆ unsafe_arena_release_header()

ignition::msgs::Header * unsafe_arena_release_header ( )
inline

◆ unsafe_arena_set_allocated_header()

void unsafe_arena_set_allocated_header ( ::ignition::msgs::Header header)
inline

◆ UnsafeArenaSwap()

void UnsafeArenaSwap ( Entity other)
inline

Member Data Documentation

◆ _class_data_

const ClassData _class_data_
static

◆ COLLISION

constexpr Type COLLISION
staticconstexpr
Initial value:
=
@ Entity_Type_COLLISION
Definition: entity.pb.h:88

◆ JOINT

constexpr Type JOINT
staticconstexpr
Initial value:
=
@ Entity_Type_JOINT
Definition: entity.pb.h:90

◆ kIndexInFileMessages

constexpr int kIndexInFileMessages
staticconstexpr
Initial value:
=
0

◆ LIGHT

constexpr Type LIGHT
staticconstexpr
Initial value:
=
@ Entity_Type_LIGHT
Definition: entity.pb.h:84

◆ LINK

constexpr Type LINK
staticconstexpr
Initial value:
=
@ Entity_Type_LINK
Definition: entity.pb.h:86

◆ MODEL

constexpr Type MODEL
staticconstexpr
Initial value:
=
@ Entity_Type_MODEL
Definition: entity.pb.h:85

◆ NONE

constexpr Type NONE
staticconstexpr
Initial value:
=
@ Entity_Type_NONE
Definition: entity.pb.h:83

◆ SENSOR

constexpr Type SENSOR
staticconstexpr
Initial value:
=
@ Entity_Type_SENSOR
Definition: entity.pb.h:89

◆ Type_ARRAYSIZE

constexpr int Type_ARRAYSIZE
staticconstexpr
Initial value:
=
constexpr int Entity_Type_Type_ARRAYSIZE
Definition: entity.pb.h:97

◆ Type_MAX

constexpr Type Type_MAX
staticconstexpr
Initial value:
=
constexpr Entity_Type Entity_Type_Type_MAX
Definition: entity.pb.h:96

◆ Type_MIN

constexpr Type Type_MIN
staticconstexpr
Initial value:
=
constexpr Entity_Type Entity_Type_Type_MIN
Definition: entity.pb.h:95

◆ VISUAL

constexpr Type VISUAL
staticconstexpr
Initial value:
=
@ Entity_Type_VISUAL
Definition: entity.pb.h:87

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