Ignition Msgs

API Reference

6.4.0

#include <entity.pb.h>

Public Types

typedef Entity_Type Type
 

Public Member Functions

 Entity ()
 
 Entity (const Entity &from)
 
virtual ~Entity ()
 
int ByteSize () const
 
void Clear ()
 
void clear_header ()
 
void clear_id ()
 
void clear_name ()
 
void clear_type ()
 
void CopyFrom (const ::google::protobuf::Message &from)
 
void CopyFrom (const Entity &from)
 
int GetCachedSize () const
 
::google::protobuf::Metadata GetMetadata () const
 
bool has_header () const
 
const ::ignition::msgs::Headerheader () const
 
::google::protobuf::uint64 id () const
 
::google::protobuf::uint8 * InternalSerializeWithCachedSizesToArray (bool deterministic, ::google::protobuf::uint8 *output) const
 
bool IsInitialized () const
 
void MergeFrom (const ::google::protobuf::Message &from)
 
void MergeFrom (const Entity &from)
 
bool MergePartialFromCodedStream (::google::protobuf::io::CodedInputStream *input)
 
::ignition::msgs::Headermutable_header ()
 
::std::stringmutable_name ()
 
const ::std::stringname () const
 
EntityNew () const
 
EntityNew (::google::protobuf::Arena *arena) const
 
Entityoperator= (const Entity &from)
 
::ignition::msgs::Headerrelease_header ()
 
::std::stringrelease_name ()
 
void SerializeWithCachedSizes (::google::protobuf::io::CodedOutputStream *output) const
 
::google::protobuf::uint8 * SerializeWithCachedSizesToArray (::google::protobuf::uint8 *output) const
 
void set_allocated_header (::ignition::msgs::Header *header)
 
void set_allocated_name (::std::string *name)
 
void set_id (::google::protobuf::uint64 value)
 
void set_name (const ::std::string &value)
 
void set_name (const char *value)
 
void set_name (const char *value, size_t size)
 
void set_type (::ignition::msgs::Entity_Type value)
 
void Swap (Entity *other)
 
::ignition::msgs::Entity_Type type () const
 

Static Public Member Functions

static const Entitydefault_instance ()
 
static const ::google::protobuf::Descriptor * descriptor ()
 
static const ::google::protobuf::EnumDescriptor * Type_descriptor ()
 
static bool Type_IsValid (int value)
 
static const ::std::stringType_Name (Type value)
 
static bool Type_Parse (const ::std::string &name, Type *value)
 

Static Public Attributes

static const Type COLLISION
 
static const Type JOINT
 
static const int kHeaderFieldNumber = 1
 
static const int kIdFieldNumber = 2
 
static const int kNameFieldNumber = 3
 
static const int kTypeFieldNumber = 4
 
static const Type LIGHT
 
static const Type LINK
 
static const Type MODEL
 
static const Type NONE
 
static const Type SENSOR
 
static const int Type_ARRAYSIZE
 
static const Type Type_MAX
 
static const Type Type_MIN
 
static const Type VISUAL
 

Friends

void IGNITION_MSGS_VISIBLE protobuf_AddDesc_ignition_2fmsgs_2fentity_2eproto ()
 
void protobuf_AssignDesc_ignition_2fmsgs_2fentity_2eproto ()
 
void protobuf_ShutdownFile_ignition_2fmsgs_2fentity_2eproto ()
 

Member Typedef Documentation

◆ Type

typedef Entity_Type Type

Constructor & Destructor Documentation

◆ Entity() [1/2]

Entity ( )

◆ ~Entity()

virtual ~Entity ( )
virtual

◆ Entity() [2/2]

Entity ( const Entity from)

Member Function Documentation

◆ ByteSize()

int ByteSize ( ) const

◆ Clear()

void Clear ( )

◆ clear_header()

void clear_header ( )
inline

◆ clear_id()

void clear_id ( )
inline

◆ clear_name()

void clear_name ( )
inline

◆ clear_type()

void clear_type ( )
inline

◆ CopyFrom() [1/2]

void CopyFrom ( const ::google::protobuf::Message &  from)

◆ CopyFrom() [2/2]

void CopyFrom ( const Entity from)

◆ default_instance()

static const Entity& default_instance ( )
static

◆ descriptor()

static const ::google::protobuf::Descriptor* descriptor ( )
static

◆ GetCachedSize()

int GetCachedSize ( ) const
inline

◆ GetMetadata()

::google::protobuf::Metadata GetMetadata ( ) const

◆ has_header()

bool has_header ( ) const
inline

◆ header()

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

◆ id()

google::protobuf::uint64 id ( ) const
inline

◆ InternalSerializeWithCachedSizesToArray()

::google::protobuf::uint8* InternalSerializeWithCachedSizesToArray ( bool  deterministic,
::google::protobuf::uint8 *  output 
) const

◆ IsInitialized()

bool IsInitialized ( ) const

◆ MergeFrom() [1/2]

void MergeFrom ( const ::google::protobuf::Message &  from)

◆ MergeFrom() [2/2]

void MergeFrom ( const Entity from)

◆ MergePartialFromCodedStream()

bool MergePartialFromCodedStream ( ::google::protobuf::io::CodedInputStream *  input)

◆ mutable_header()

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

◆ mutable_name()

std::string * mutable_name ( )
inline

◆ name()

const ::std::string & name ( ) const
inline

◆ New() [1/2]

Entity* New ( ) const
inline

References Entity::New().

Referenced by Entity::New().

◆ New() [2/2]

Entity* New ( ::google::protobuf::Arena *  arena) const

◆ operator=()

Entity& operator= ( const Entity from)
inline

◆ release_header()

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

◆ release_name()

std::string * release_name ( )
inline

◆ SerializeWithCachedSizes()

void SerializeWithCachedSizes ( ::google::protobuf::io::CodedOutputStream *  output) const

◆ SerializeWithCachedSizesToArray()

::google::protobuf::uint8* SerializeWithCachedSizesToArray ( ::google::protobuf::uint8 *  output) const
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 ( ::google::protobuf::uint64  value)
inline

◆ set_name() [1/3]

void set_name ( const ::std::string value)
inline

◆ set_name() [2/3]

void set_name ( const char *  value)
inline

◆ set_name() [3/3]

void set_name ( const char *  value,
size_t  size 
)
inline

◆ set_type()

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

◆ Swap()

void Swap ( Entity other)

◆ type()

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

◆ Type_descriptor()

static const ::google::protobuf::EnumDescriptor* Type_descriptor ( )
inlinestatic

◆ Type_IsValid()

static bool Type_IsValid ( int  value)
inlinestatic

◆ Type_Name()

static const ::std::string& Type_Name ( Type  value)
inlinestatic

◆ Type_Parse()

static bool Type_Parse ( const ::std::string name,
Type value 
)
inlinestatic

Friends And Related Function Documentation

◆ protobuf_AddDesc_ignition_2fmsgs_2fentity_2eproto

void IGNITION_MSGS_VISIBLE protobuf_AddDesc_ignition_2fmsgs_2fentity_2eproto ( )
friend

◆ protobuf_AssignDesc_ignition_2fmsgs_2fentity_2eproto

void protobuf_AssignDesc_ignition_2fmsgs_2fentity_2eproto ( )
friend

◆ protobuf_ShutdownFile_ignition_2fmsgs_2fentity_2eproto

void protobuf_ShutdownFile_ignition_2fmsgs_2fentity_2eproto ( )
friend

Member Data Documentation

◆ COLLISION

const Type COLLISION
static
Initial value:

◆ JOINT

const Type JOINT
static
Initial value:

◆ kHeaderFieldNumber

const int kHeaderFieldNumber = 1
static

◆ kIdFieldNumber

const int kIdFieldNumber = 2
static

◆ kNameFieldNumber

const int kNameFieldNumber = 3
static

◆ kTypeFieldNumber

const int kTypeFieldNumber = 4
static

◆ LIGHT

const Type LIGHT
static
Initial value:

◆ LINK

const Type LINK
static
Initial value:

◆ MODEL

const Type MODEL
static
Initial value:

◆ NONE

const Type NONE
static
Initial value:

◆ SENSOR

const Type SENSOR
static
Initial value:

◆ Type_ARRAYSIZE

const int Type_ARRAYSIZE
static
Initial value:

◆ Type_MAX

const Type Type_MAX
static
Initial value:

◆ Type_MIN

const Type Type_MIN
static
Initial value:

◆ VISUAL

const Type VISUAL
static
Initial value:

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