Ignition Msgs

API Reference

5.8.1

#include <fuel_metadata.pb.h>

Public Types

enum  : int {
  kAuthorsFieldNumber = 6 , kTagsFieldNumber = 8 , kAnnotationsFieldNumber = 9 , kDependenciesFieldNumber = 10 ,
  kCompatibilitiesFieldNumber = 11 , kNameFieldNumber = 3 , kDescriptionFieldNumber = 4 , kLegalFieldNumber = 7 ,
  kVersionFieldNumber = 5 , kModelFieldNumber = 1 , kWorldFieldNumber = 2
}
 
typedef FuelMetadata_Compatibility Compatibility
 
typedef FuelMetadata_Contact Contact
 
typedef FuelMetadata_Dependency Dependency
 
typedef FuelMetadata_Legal Legal
 
typedef FuelMetadata_Model Model
 
enum  ResourceTypeCase { kModel = 1 , kWorld = 2 , RESOURCE_TYPE_NOT_SET = 0 }
 
typedef FuelMetadata_World World
 

Public Member Functions

 FuelMetadata ()
 
constexpr FuelMetadata (::PROTOBUF_NAMESPACE_ID::internal::ConstantInitialized)
 
 FuelMetadata (const FuelMetadata &from)
 
 FuelMetadata (FuelMetadata &&from) noexcept
 
 ~FuelMetadata () 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::FuelMetadata_Contactadd_authors ()
 
::ignition::msgs::FuelMetadata_Compatibilityadd_compatibilities ()
 
::ignition::msgs::FuelMetadata_Dependencyadd_dependencies ()
 
std::stringadd_tags ()
 
void add_tags (const char *value)
 
void add_tags (const char *value, size_t size)
 
void add_tags (const std::string &value)
 
void add_tags (std::string &&value)
 
const ::PROTOBUF_NAMESPACE_ID::Map< std::string, std::string > & annotations () const
 
int annotations_size () const
 
const ::PROTOBUF_NAMESPACE_ID::RepeatedPtrField< ::ignition::msgs::FuelMetadata_Contact > & authors () const
 
const ::ignition::msgs::FuelMetadata_Contactauthors (int index) const
 
int authors_size () const
 
size_t ByteSizeLong () const final
 
PROTOBUF_ATTRIBUTE_REINITIALIZES void Clear () final
 
void clear_annotations ()
 
void clear_authors ()
 
void clear_compatibilities ()
 
void clear_dependencies ()
 
void clear_description ()
 
void clear_legal ()
 
void clear_model ()
 
void clear_name ()
 
void clear_resource_type ()
 
void clear_tags ()
 
void clear_version ()
 
void clear_world ()
 
const ::PROTOBUF_NAMESPACE_ID::RepeatedPtrField< ::ignition::msgs::FuelMetadata_Compatibility > & compatibilities () const
 
const ::ignition::msgs::FuelMetadata_Compatibilitycompatibilities (int index) const
 
int compatibilities_size () const
 
void CopyFrom (const FuelMetadata &from)
 
const ::PROTOBUF_NAMESPACE_ID::RepeatedPtrField< ::ignition::msgs::FuelMetadata_Dependency > & dependencies () const
 
const ::ignition::msgs::FuelMetadata_Dependencydependencies (int index) const
 
int dependencies_size () const
 
const std::stringdescription () const
 
int GetCachedSize () const final
 
const ::PROTOBUF_NAMESPACE_ID::Message::ClassData * GetClassData () const final
 
::PROTOBUF_NAMESPACE_ID::Metadata GetMetadata () const final
 
bool has_legal () const
 
bool has_model () const
 
bool has_world () const
 
bool IsInitialized () const final
 
const ::ignition::msgs::FuelMetadata_Legallegal () const
 
void MergeFrom (const FuelMetadata &from)
 
const ::ignition::msgs::FuelMetadata_Modelmodel () const
 
::PROTOBUF_NAMESPACE_ID::Map< std::string, std::string > * mutable_annotations ()
 
::PROTOBUF_NAMESPACE_ID::RepeatedPtrField< ::ignition::msgs::FuelMetadata_Contact > * mutable_authors ()
 
::ignition::msgs::FuelMetadata_Contactmutable_authors (int index)
 
::PROTOBUF_NAMESPACE_ID::RepeatedPtrField< ::ignition::msgs::FuelMetadata_Compatibility > * mutable_compatibilities ()
 
::ignition::msgs::FuelMetadata_Compatibilitymutable_compatibilities (int index)
 
::PROTOBUF_NAMESPACE_ID::RepeatedPtrField< ::ignition::msgs::FuelMetadata_Dependency > * mutable_dependencies ()
 
::ignition::msgs::FuelMetadata_Dependencymutable_dependencies (int index)
 
std::stringmutable_description ()
 
::ignition::msgs::FuelMetadata_Legalmutable_legal ()
 
::ignition::msgs::FuelMetadata_Modelmutable_model ()
 
std::stringmutable_name ()
 
::PROTOBUF_NAMESPACE_ID::RepeatedPtrField< std::string > * mutable_tags ()
 
std::stringmutable_tags (int index)
 
::ignition::msgs::FuelMetadata_Worldmutable_world ()
 
const std::stringname () const
 
FuelMetadataNew (::PROTOBUF_NAMESPACE_ID::Arena *arena=nullptr) const final
 
FuelMetadataoperator= (const FuelMetadata &from)
 
FuelMetadataoperator= (FuelMetadata &&from) noexcept
 
PROTOBUF_NODISCARD std::stringrelease_description ()
 
PROTOBUF_NODISCARD ::ignition::msgs::FuelMetadata_Legalrelease_legal ()
 
PROTOBUF_NODISCARD ::ignition::msgs::FuelMetadata_Modelrelease_model ()
 
PROTOBUF_NODISCARD std::stringrelease_name ()
 
PROTOBUF_NODISCARD ::ignition::msgs::FuelMetadata_Worldrelease_world ()
 
ResourceTypeCase resource_type_case () const
 
void set_allocated_description (std::string *description)
 
void set_allocated_legal (::ignition::msgs::FuelMetadata_Legal *legal)
 
void set_allocated_model (::ignition::msgs::FuelMetadata_Model *model)
 
void set_allocated_name (std::string *name)
 
void set_allocated_world (::ignition::msgs::FuelMetadata_World *world)
 
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_name (ArgT0 &&arg0, ArgT... args)
 
template<typename ArgT0 , typename... ArgT>
PROTOBUF_ALWAYS_INLINE void set_name (ArgT0 &&arg0, ArgT... args)
 
void set_tags (int index, const char *value)
 
void set_tags (int index, const char *value, size_t size)
 
void set_tags (int index, const std::string &value)
 
void set_tags (int index, std::string &&value)
 
void set_version (int32_t value)
 
void Swap (FuelMetadata *other)
 
const ::PROTOBUF_NAMESPACE_ID::RepeatedPtrField< std::string > & tags () const
 
const std::stringtags (int index) const
 
int tags_size () const
 
::ignition::msgs::FuelMetadata_Legalunsafe_arena_release_legal ()
 
::ignition::msgs::FuelMetadata_Modelunsafe_arena_release_model ()
 
::ignition::msgs::FuelMetadata_Worldunsafe_arena_release_world ()
 
void unsafe_arena_set_allocated_legal (::ignition::msgs::FuelMetadata_Legal *legal)
 
void unsafe_arena_set_allocated_model (::ignition::msgs::FuelMetadata_Model *model)
 
void unsafe_arena_set_allocated_world (::ignition::msgs::FuelMetadata_World *world)
 
void UnsafeArenaSwap (FuelMetadata *other)
 
int32_t version () const
 
const ::ignition::msgs::FuelMetadata_Worldworld () const
 

Static Public Member Functions

static const FuelMetadatadefault_instance ()
 
static const ::PROTOBUF_NAMESPACE_ID::Descriptor * descriptor ()
 
static const ::PROTOBUF_NAMESPACE_ID::Descriptor * GetDescriptor ()
 
static const ::PROTOBUF_NAMESPACE_ID::Reflection * GetReflection ()
 
static const FuelMetadatainternal_default_instance ()
 

Static Public Attributes

static const ClassData _class_data_
 
static constexpr int kIndexInFileMessages
 

Protected Member Functions

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

Member Typedef Documentation

◆ Compatibility

◆ Contact

◆ Dependency

◆ Legal

◆ Model

◆ World

Member Enumeration Documentation

◆ anonymous enum

anonymous enum : int
Enumerator
kAuthorsFieldNumber 
kTagsFieldNumber 
kAnnotationsFieldNumber 
kDependenciesFieldNumber 
kCompatibilitiesFieldNumber 
kNameFieldNumber 
kDescriptionFieldNumber 
kLegalFieldNumber 
kVersionFieldNumber 
kModelFieldNumber 
kWorldFieldNumber 

◆ ResourceTypeCase

Enumerator
kModel 
kWorld 
RESOURCE_TYPE_NOT_SET 

Constructor & Destructor Documentation

◆ FuelMetadata() [1/5]

FuelMetadata ( )
inline

◆ ~FuelMetadata()

~FuelMetadata ( )
override

◆ FuelMetadata() [2/5]

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

◆ FuelMetadata() [3/5]

FuelMetadata ( const FuelMetadata from)

◆ FuelMetadata() [4/5]

FuelMetadata ( FuelMetadata &&  from)
inlinenoexcept

◆ FuelMetadata() [5/5]

FuelMetadata ( ::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_authors()

ignition::msgs::FuelMetadata_Contact * add_authors ( )
inline

◆ add_compatibilities()

ignition::msgs::FuelMetadata_Compatibility * add_compatibilities ( )
inline

◆ add_dependencies()

ignition::msgs::FuelMetadata_Dependency * add_dependencies ( )
inline

◆ add_tags() [1/5]

std::string * add_tags ( )
inline

◆ add_tags() [2/5]

void add_tags ( const char *  value)
inline

◆ add_tags() [3/5]

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

References string::assign().

◆ add_tags() [4/5]

void add_tags ( const std::string value)
inline

References string::assign().

◆ add_tags() [5/5]

void add_tags ( std::string &&  value)
inline

References std::move().

◆ annotations()

const ::PROTOBUF_NAMESPACE_ID::Map< std::string, std::string > & annotations ( ) const
inline

◆ annotations_size()

int annotations_size ( ) const
inline

◆ authors() [1/2]

const ::PROTOBUF_NAMESPACE_ID::RepeatedPtrField<::ignition::msgs::FuelMetadata_Contact > & authors ( ) const
inline

◆ authors() [2/2]

const ::ignition::msgs::FuelMetadata_Contact & authors ( int  index) const
inline

◆ authors_size()

int authors_size ( ) const
inline

◆ ByteSizeLong()

size_t ByteSizeLong ( ) const
final

◆ Clear()

PROTOBUF_ATTRIBUTE_REINITIALIZES void Clear ( )
final

◆ clear_annotations()

void clear_annotations ( )
inline

◆ clear_authors()

void clear_authors ( )
inline

◆ clear_compatibilities()

void clear_compatibilities ( )
inline

◆ clear_dependencies()

void clear_dependencies ( )
inline

◆ clear_description()

void clear_description ( )
inline

◆ clear_legal()

void clear_legal ( )
inline

◆ clear_model()

void clear_model ( )
inline

◆ clear_name()

void clear_name ( )
inline

◆ clear_resource_type()

void clear_resource_type ( )

◆ clear_tags()

void clear_tags ( )
inline

◆ clear_version()

void clear_version ( )
inline

◆ clear_world()

void clear_world ( )
inline

◆ compatibilities() [1/2]

const ::PROTOBUF_NAMESPACE_ID::RepeatedPtrField<::ignition::msgs::FuelMetadata_Compatibility > & compatibilities ( ) const
inline

◆ compatibilities() [2/2]

const ::ignition::msgs::FuelMetadata_Compatibility & compatibilities ( int  index) const
inline

◆ compatibilities_size()

int compatibilities_size ( ) const
inline

◆ CopyFrom()

void CopyFrom ( const FuelMetadata from)

◆ default_instance()

static const FuelMetadata& default_instance ( )
inlinestatic

◆ dependencies() [1/2]

const ::PROTOBUF_NAMESPACE_ID::RepeatedPtrField<::ignition::msgs::FuelMetadata_Dependency > & dependencies ( ) const
inline

◆ dependencies() [2/2]

const ::ignition::msgs::FuelMetadata_Dependency & dependencies ( int  index) const
inline

◆ dependencies_size()

int dependencies_size ( ) const
inline

◆ description()

const std::string & description ( ) const
inline

◆ 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_legal()

bool has_legal ( ) const
inline

◆ has_model()

bool has_model ( ) const
inline

◆ has_world()

bool has_world ( ) const
inline

◆ internal_default_instance()

static const FuelMetadata* internal_default_instance ( )
inlinestatic

◆ IsInitialized()

bool IsInitialized ( ) const
final

◆ legal()

const ::ignition::msgs::FuelMetadata_Legal & legal ( ) const
inline

◆ MergeFrom()

void MergeFrom ( const FuelMetadata from)

◆ model()

const ::ignition::msgs::FuelMetadata_Model & model ( ) const
inline

◆ mutable_annotations()

PROTOBUF_NAMESPACE_ID::Map< std::string, std::string > * mutable_annotations ( )
inline

◆ mutable_authors() [1/2]

PROTOBUF_NAMESPACE_ID::RepeatedPtrField<::ignition::msgs::FuelMetadata_Contact > * mutable_authors ( )
inline

◆ mutable_authors() [2/2]

ignition::msgs::FuelMetadata_Contact * mutable_authors ( int  index)
inline

◆ mutable_compatibilities() [1/2]

PROTOBUF_NAMESPACE_ID::RepeatedPtrField<::ignition::msgs::FuelMetadata_Compatibility > * mutable_compatibilities ( )
inline

◆ mutable_compatibilities() [2/2]

ignition::msgs::FuelMetadata_Compatibility * mutable_compatibilities ( int  index)
inline

◆ mutable_dependencies() [1/2]

PROTOBUF_NAMESPACE_ID::RepeatedPtrField<::ignition::msgs::FuelMetadata_Dependency > * mutable_dependencies ( )
inline

◆ mutable_dependencies() [2/2]

ignition::msgs::FuelMetadata_Dependency * mutable_dependencies ( int  index)
inline

◆ mutable_description()

std::string * mutable_description ( )
inline

◆ mutable_legal()

ignition::msgs::FuelMetadata_Legal * mutable_legal ( )
inline

◆ mutable_model()

ignition::msgs::FuelMetadata_Model * mutable_model ( )
inline

◆ mutable_name()

std::string * mutable_name ( )
inline

◆ mutable_tags() [1/2]

PROTOBUF_NAMESPACE_ID::RepeatedPtrField< std::string > * mutable_tags ( )
inline

◆ mutable_tags() [2/2]

std::string * mutable_tags ( int  index)
inline

◆ mutable_world()

ignition::msgs::FuelMetadata_World * mutable_world ( )
inline

◆ name()

const std::string & name ( ) const
inline

◆ New()

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

◆ operator=() [1/2]

FuelMetadata& operator= ( const FuelMetadata from)
inline

◆ operator=() [2/2]

FuelMetadata& operator= ( FuelMetadata &&  from)
inlinenoexcept

◆ release_description()

std::string * release_description ( )
inline

◆ release_legal()

ignition::msgs::FuelMetadata_Legal * release_legal ( )
inline

◆ release_model()

ignition::msgs::FuelMetadata_Model * release_model ( )
inline

◆ release_name()

std::string * release_name ( )
inline

◆ release_world()

ignition::msgs::FuelMetadata_World * release_world ( )
inline

◆ resource_type_case()

FuelMetadata::ResourceTypeCase resource_type_case ( ) const
inline

◆ set_allocated_description()

void set_allocated_description ( std::string description)
inline

◆ set_allocated_legal()

void set_allocated_legal ( ::ignition::msgs::FuelMetadata_Legal legal)
inline

◆ set_allocated_model()

void set_allocated_model ( ::ignition::msgs::FuelMetadata_Model model)

◆ set_allocated_name()

void set_allocated_name ( std::string name)
inline

◆ set_allocated_world()

void set_allocated_world ( ::ignition::msgs::FuelMetadata_World world)

◆ 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_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_tags() [1/4]

void set_tags ( int  index,
const char *  value 
)
inline

◆ set_tags() [2/4]

void set_tags ( int  index,
const char *  value,
size_t  size 
)
inline

◆ set_tags() [3/4]

void set_tags ( int  index,
const std::string value 
)
inline

◆ set_tags() [4/4]

void set_tags ( int  index,
std::string &&  value 
)
inline

References std::move().

◆ set_version()

void set_version ( int32_t  value)
inline

◆ Swap()

void Swap ( FuelMetadata other)
inline

◆ tags() [1/2]

const ::PROTOBUF_NAMESPACE_ID::RepeatedPtrField< std::string > & tags ( ) const
inline

◆ tags() [2/2]

const std::string & tags ( int  index) const
inline

◆ tags_size()

int tags_size ( ) const
inline

◆ unsafe_arena_release_legal()

ignition::msgs::FuelMetadata_Legal * unsafe_arena_release_legal ( )
inline

◆ unsafe_arena_release_model()

ignition::msgs::FuelMetadata_Model * unsafe_arena_release_model ( )
inline

◆ unsafe_arena_release_world()

ignition::msgs::FuelMetadata_World * unsafe_arena_release_world ( )
inline

◆ unsafe_arena_set_allocated_legal()

void unsafe_arena_set_allocated_legal ( ::ignition::msgs::FuelMetadata_Legal legal)
inline

◆ unsafe_arena_set_allocated_model()

void unsafe_arena_set_allocated_model ( ::ignition::msgs::FuelMetadata_Model model)
inline

◆ unsafe_arena_set_allocated_world()

void unsafe_arena_set_allocated_world ( ::ignition::msgs::FuelMetadata_World world)
inline

◆ UnsafeArenaSwap()

void UnsafeArenaSwap ( FuelMetadata other)
inline

◆ version()

int32_t version ( ) const
inline

◆ world()

const ::ignition::msgs::FuelMetadata_World & world ( ) const
inline

Member Data Documentation

◆ _class_data_

const ClassData _class_data_
static

◆ kIndexInFileMessages

constexpr int kIndexInFileMessages
staticconstexpr
Initial value:
=
7

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