Ignition Msgs

API Reference

5.8.1

#include <user_cmd.pb.h>

Public Types

enum  : int {
  kModelFieldNumber = 5 , kLightFieldNumber = 6 , kDescriptionFieldNumber = 3 , kEntityNameFieldNumber = 7 ,
  kHeaderFieldNumber = 1 , kWorldControlFieldNumber = 8 , kWrenchFieldNumber = 9 , kIdFieldNumber = 2 ,
  kTypeFieldNumber = 4
}
 
typedef UserCmd_Type Type
 

Public Member Functions

 UserCmd ()
 
constexpr UserCmd (::PROTOBUF_NAMESPACE_ID::internal::ConstantInitialized)
 
 UserCmd (const UserCmd &from)
 
 UserCmd (UserCmd &&from) noexcept
 
 ~UserCmd () 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
 
::ignition::msgs::Lightadd_light ()
 
::ignition::msgs::Modeladd_model ()
 
size_t ByteSizeLong () const final
 
PROTOBUF_ATTRIBUTE_REINITIALIZES void Clear () final
 
void clear_description ()
 
void clear_entity_name ()
 
void clear_header ()
 
void clear_id ()
 
void clear_light ()
 
void clear_model ()
 
void clear_type ()
 
void clear_world_control ()
 
void clear_wrench ()
 
void CopyFrom (const UserCmd &from)
 
const std::stringdescription () const
 
const std::stringentity_name () const
 
int GetCachedSize () const final
 
const ::PROTOBUF_NAMESPACE_ID::Message::ClassData * GetClassData () const final
 
::PROTOBUF_NAMESPACE_ID::Metadata GetMetadata () const final
 
bool has_header () const
 
bool has_world_control () const
 
bool has_wrench () const
 
const ::ignition::msgs::Headerheader () const
 
uint32_t id () const
 
bool IsInitialized () const final
 
const ::PROTOBUF_NAMESPACE_ID::RepeatedPtrField< ::ignition::msgs::Light > & light () const
 
const ::ignition::msgs::Lightlight (int index) const
 
int light_size () const
 
void MergeFrom (const UserCmd &from)
 
const ::PROTOBUF_NAMESPACE_ID::RepeatedPtrField< ::ignition::msgs::Model > & model () const
 
const ::ignition::msgs::Modelmodel (int index) const
 
int model_size () const
 
std::stringmutable_description ()
 
std::stringmutable_entity_name ()
 
::ignition::msgs::Headermutable_header ()
 
::PROTOBUF_NAMESPACE_ID::RepeatedPtrField< ::ignition::msgs::Light > * mutable_light ()
 
::ignition::msgs::Lightmutable_light (int index)
 
::PROTOBUF_NAMESPACE_ID::RepeatedPtrField< ::ignition::msgs::Model > * mutable_model ()
 
::ignition::msgs::Modelmutable_model (int index)
 
::ignition::msgs::WorldControlmutable_world_control ()
 
::ignition::msgs::Wrenchmutable_wrench ()
 
UserCmdNew (::PROTOBUF_NAMESPACE_ID::Arena *arena=nullptr) const final
 
UserCmdoperator= (const UserCmd &from)
 
UserCmdoperator= (UserCmd &&from) noexcept
 
PROTOBUF_NODISCARD std::stringrelease_description ()
 
PROTOBUF_NODISCARD std::stringrelease_entity_name ()
 
PROTOBUF_NODISCARD ::ignition::msgs::Headerrelease_header ()
 
PROTOBUF_NODISCARD ::ignition::msgs::WorldControlrelease_world_control ()
 
PROTOBUF_NODISCARD ::ignition::msgs::Wrenchrelease_wrench ()
 
void set_allocated_description (std::string *description)
 
void set_allocated_entity_name (std::string *entity_name)
 
void set_allocated_header (::ignition::msgs::Header *header)
 
void set_allocated_world_control (::ignition::msgs::WorldControl *world_control)
 
void set_allocated_wrench (::ignition::msgs::Wrench *wrench)
 
template<typename ArgT0 = const std::string&, typename... ArgT>
void set_description (ArgT0 &&arg0, ArgT... args)
 
template<typename ArgT0 , typename... ArgT>
PROTOBUF_ALWAYS_INLINE void set_description (ArgT0 &&arg0, ArgT... args)
 
template<typename ArgT0 = const std::string&, typename... ArgT>
void set_entity_name (ArgT0 &&arg0, ArgT... args)
 
template<typename ArgT0 , typename... ArgT>
PROTOBUF_ALWAYS_INLINE void set_entity_name (ArgT0 &&arg0, ArgT... args)
 
void set_id (uint32_t value)
 
void set_type (::ignition::msgs::UserCmd_Type value)
 
void Swap (UserCmd *other)
 
::ignition::msgs::UserCmd_Type type () const
 
::ignition::msgs::Headerunsafe_arena_release_header ()
 
::ignition::msgs::WorldControlunsafe_arena_release_world_control ()
 
::ignition::msgs::Wrenchunsafe_arena_release_wrench ()
 
void unsafe_arena_set_allocated_header (::ignition::msgs::Header *header)
 
void unsafe_arena_set_allocated_world_control (::ignition::msgs::WorldControl *world_control)
 
void unsafe_arena_set_allocated_wrench (::ignition::msgs::Wrench *wrench)
 
void UnsafeArenaSwap (UserCmd *other)
 
const ::ignition::msgs::WorldControlworld_control () const
 
const ::ignition::msgs::Wrenchwrench () const
 

Static Public Member Functions

static const UserCmddefault_instance ()
 
static const ::PROTOBUF_NAMESPACE_ID::Descriptor * descriptor ()
 
static const ::PROTOBUF_NAMESPACE_ID::Descriptor * GetDescriptor ()
 
static const ::PROTOBUF_NAMESPACE_ID::Reflection * GetReflection ()
 
static const UserCmdinternal_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 int kIndexInFileMessages
 
static constexpr Type MOVING
 
static constexpr Type SCALING
 
static constexpr int Type_ARRAYSIZE
 
static constexpr Type Type_MAX
 
static constexpr Type Type_MIN
 
static constexpr Type WORLD_CONTROL
 
static constexpr Type WRENCH
 

Protected Member Functions

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

Member Typedef Documentation

◆ Type

typedef UserCmd_Type Type

Member Enumeration Documentation

◆ anonymous enum

anonymous enum : int
Enumerator
kModelFieldNumber 
kLightFieldNumber 
kDescriptionFieldNumber 
kEntityNameFieldNumber 
kHeaderFieldNumber 
kWorldControlFieldNumber 
kWrenchFieldNumber 
kIdFieldNumber 
kTypeFieldNumber 

Constructor & Destructor Documentation

◆ UserCmd() [1/5]

UserCmd ( )
inline

◆ ~UserCmd()

~UserCmd ( )
override

◆ UserCmd() [2/5]

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

◆ UserCmd() [3/5]

UserCmd ( const UserCmd from)

◆ UserCmd() [4/5]

UserCmd ( UserCmd &&  from)
inlinenoexcept

◆ UserCmd() [5/5]

UserCmd ( ::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

◆ add_light()

ignition::msgs::Light * add_light ( )
inline

◆ add_model()

ignition::msgs::Model * add_model ( )
inline

◆ ByteSizeLong()

size_t ByteSizeLong ( ) const
final

◆ Clear()

PROTOBUF_ATTRIBUTE_REINITIALIZES void Clear ( )
final

◆ clear_description()

void clear_description ( )
inline

◆ clear_entity_name()

void clear_entity_name ( )
inline

◆ clear_header()

void clear_header ( )

◆ clear_id()

void clear_id ( )
inline

◆ clear_light()

void clear_light ( )

◆ clear_model()

void clear_model ( )

◆ clear_type()

void clear_type ( )
inline

◆ clear_world_control()

void clear_world_control ( )

◆ clear_wrench()

void clear_wrench ( )

◆ CopyFrom()

void CopyFrom ( const UserCmd from)

◆ default_instance()

static const UserCmd& default_instance ( )
inlinestatic

◆ description()

const std::string & description ( ) const
inline

◆ descriptor()

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

◆ entity_name()

const std::string & entity_name ( ) const
inline

◆ 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

◆ has_world_control()

bool has_world_control ( ) const
inline

◆ has_wrench()

bool has_wrench ( ) const
inline

◆ header()

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

◆ id()

uint32_t id ( ) const
inline

◆ internal_default_instance()

static const UserCmd* internal_default_instance ( )
inlinestatic

◆ IsInitialized()

bool IsInitialized ( ) const
final

◆ light() [1/2]

const ::PROTOBUF_NAMESPACE_ID::RepeatedPtrField<::ignition::msgs::Light > & light ( ) const
inline

◆ light() [2/2]

const ::ignition::msgs::Light & light ( int  index) const
inline

◆ light_size()

int light_size ( ) const
inline

◆ MergeFrom()

void MergeFrom ( const UserCmd from)

◆ model() [1/2]

const ::PROTOBUF_NAMESPACE_ID::RepeatedPtrField<::ignition::msgs::Model > & model ( ) const
inline

◆ model() [2/2]

const ::ignition::msgs::Model & model ( int  index) const
inline

◆ model_size()

int model_size ( ) const
inline

◆ mutable_description()

std::string * mutable_description ( )
inline

◆ mutable_entity_name()

std::string * mutable_entity_name ( )
inline

◆ mutable_header()

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

◆ mutable_light() [1/2]

PROTOBUF_NAMESPACE_ID::RepeatedPtrField<::ignition::msgs::Light > * mutable_light ( )
inline

◆ mutable_light() [2/2]

ignition::msgs::Light * mutable_light ( int  index)
inline

◆ mutable_model() [1/2]

PROTOBUF_NAMESPACE_ID::RepeatedPtrField<::ignition::msgs::Model > * mutable_model ( )
inline

◆ mutable_model() [2/2]

ignition::msgs::Model * mutable_model ( int  index)
inline

◆ mutable_world_control()

ignition::msgs::WorldControl * mutable_world_control ( )
inline

◆ mutable_wrench()

ignition::msgs::Wrench * mutable_wrench ( )
inline

◆ New()

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

◆ operator=() [1/2]

UserCmd& operator= ( const UserCmd from)
inline

◆ operator=() [2/2]

UserCmd& operator= ( UserCmd &&  from)
inlinenoexcept

◆ release_description()

std::string * release_description ( )
inline

◆ release_entity_name()

std::string * release_entity_name ( )
inline

◆ release_header()

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

◆ release_world_control()

ignition::msgs::WorldControl * release_world_control ( )
inline

◆ release_wrench()

ignition::msgs::Wrench * release_wrench ( )
inline

◆ set_allocated_description()

void set_allocated_description ( std::string description)
inline

◆ set_allocated_entity_name()

void set_allocated_entity_name ( std::string entity_name)
inline

◆ set_allocated_header()

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

◆ set_allocated_world_control()

void set_allocated_world_control ( ::ignition::msgs::WorldControl world_control)
inline

◆ set_allocated_wrench()

void set_allocated_wrench ( ::ignition::msgs::Wrench wrench)
inline

◆ set_description() [1/2]

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

◆ set_description() [2/2]

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

◆ set_entity_name() [1/2]

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

◆ set_entity_name() [2/2]

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

◆ set_id()

void set_id ( uint32_t  value)
inline

◆ set_type()

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

◆ Swap()

void Swap ( UserCmd other)
inline

◆ type()

ignition::msgs::UserCmd_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_release_world_control()

ignition::msgs::WorldControl * unsafe_arena_release_world_control ( )
inline

◆ unsafe_arena_release_wrench()

ignition::msgs::Wrench * unsafe_arena_release_wrench ( )
inline

◆ unsafe_arena_set_allocated_header()

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

◆ unsafe_arena_set_allocated_world_control()

void unsafe_arena_set_allocated_world_control ( ::ignition::msgs::WorldControl world_control)
inline

◆ unsafe_arena_set_allocated_wrench()

void unsafe_arena_set_allocated_wrench ( ::ignition::msgs::Wrench wrench)
inline

◆ UnsafeArenaSwap()

void UnsafeArenaSwap ( UserCmd other)
inline

◆ world_control()

const ::ignition::msgs::WorldControl & world_control ( ) const
inline

◆ wrench()

const ::ignition::msgs::Wrench & wrench ( ) const
inline

Member Data Documentation

◆ _class_data_

const ClassData _class_data_
static

◆ kIndexInFileMessages

constexpr int kIndexInFileMessages
staticconstexpr
Initial value:
=
0

◆ MOVING

constexpr Type MOVING
staticconstexpr
Initial value:
=
@ UserCmd_Type_MOVING
Definition: user_cmd.pb.h:87

◆ SCALING

constexpr Type SCALING
staticconstexpr
Initial value:
=
@ UserCmd_Type_SCALING
Definition: user_cmd.pb.h:90

◆ Type_ARRAYSIZE

constexpr int Type_ARRAYSIZE
staticconstexpr
Initial value:
=
constexpr int UserCmd_Type_Type_ARRAYSIZE
Definition: user_cmd.pb.h:97

◆ Type_MAX

constexpr Type Type_MAX
staticconstexpr
Initial value:
=
constexpr UserCmd_Type UserCmd_Type_Type_MAX
Definition: user_cmd.pb.h:96

◆ Type_MIN

constexpr Type Type_MIN
staticconstexpr
Initial value:
=
constexpr UserCmd_Type UserCmd_Type_Type_MIN
Definition: user_cmd.pb.h:95

◆ WORLD_CONTROL

constexpr Type WORLD_CONTROL
staticconstexpr
Initial value:
=
@ UserCmd_Type_WORLD_CONTROL
Definition: user_cmd.pb.h:88

◆ WRENCH

constexpr Type WRENCH
staticconstexpr
Initial value:
=
@ UserCmd_Type_WRENCH
Definition: user_cmd.pb.h:89

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