Ignition Msgs

API Reference

8.1.0

#include <fuel_metadata.pb.h>

Public Types

typedef FuelMetadata_Categories Categories
 
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 ()
 
 FuelMetadata (const FuelMetadata &from)
 
virtual ~FuelMetadata ()
 
::ignition::msgs::FuelMetadata_Contactadd_authors ()
 
::ignition::msgs::FuelMetadata_Compatibilityadd_compatibilities ()
 
::ignition::msgs::FuelMetadata_Dependencyadd_dependencies ()
 
::std::stringadd_tags ()
 
void add_tags (const ::std::string &value)
 
void add_tags (const char *value)
 
void add_tags (const char *value, size_t size)
 
const ::google::protobuf::Map< ::std::string, ::std::string > & annotations () const
 
int annotations_size () const
 
const ::ignition::msgs::FuelMetadata_Contactauthors (int index) const
 
const ::google::protobuf::RepeatedPtrField< ::ignition::msgs::FuelMetadata_Contact > & authors () const
 
int authors_size () const
 
int ByteSize () const
 
const ::ignition::msgs::FuelMetadata_Categoriescategories () const
 
void Clear ()
 
void clear_annotations ()
 
void clear_authors ()
 
void clear_categories ()
 
void clear_compatibilities ()
 
void clear_dependencies ()
 
void clear_description ()
 
void clear_legal ()
 
void clear_model ()
 
void clear_name ()
 
void clear_tags ()
 
void clear_version ()
 
void clear_world ()
 
const ::ignition::msgs::FuelMetadata_Compatibilitycompatibilities (int index) const
 
const ::google::protobuf::RepeatedPtrField< ::ignition::msgs::FuelMetadata_Compatibility > & compatibilities () const
 
int compatibilities_size () const
 
void CopyFrom (const ::google::protobuf::Message &from)
 
void CopyFrom (const FuelMetadata &from)
 
const ::ignition::msgs::FuelMetadata_Dependencydependencies (int index) const
 
const ::google::protobuf::RepeatedPtrField< ::ignition::msgs::FuelMetadata_Dependency > & dependencies () const
 
int dependencies_size () const
 
const ::std::stringdescription () const
 
int GetCachedSize () const
 
::google::protobuf::Metadata GetMetadata () const
 
bool has_categories () const
 
bool has_legal () const
 
bool has_model () const
 
bool has_world () const
 
::google::protobuf::uint8 * InternalSerializeWithCachedSizesToArray (bool deterministic, ::google::protobuf::uint8 *output) const
 
bool IsInitialized () const
 
const ::ignition::msgs::FuelMetadata_Legallegal () const
 
void MergeFrom (const ::google::protobuf::Message &from)
 
void MergeFrom (const FuelMetadata &from)
 
bool MergePartialFromCodedStream (::google::protobuf::io::CodedInputStream *input)
 
const ::ignition::msgs::FuelMetadata_Modelmodel () const
 
::google::protobuf::Map< ::std::string, ::std::string > * mutable_annotations ()
 
::ignition::msgs::FuelMetadata_Contactmutable_authors (int index)
 
::google::protobuf::RepeatedPtrField< ::ignition::msgs::FuelMetadata_Contact > * mutable_authors ()
 
::ignition::msgs::FuelMetadata_Categoriesmutable_categories ()
 
::ignition::msgs::FuelMetadata_Compatibilitymutable_compatibilities (int index)
 
::google::protobuf::RepeatedPtrField< ::ignition::msgs::FuelMetadata_Compatibility > * mutable_compatibilities ()
 
::ignition::msgs::FuelMetadata_Dependencymutable_dependencies (int index)
 
::google::protobuf::RepeatedPtrField< ::ignition::msgs::FuelMetadata_Dependency > * mutable_dependencies ()
 
::std::stringmutable_description ()
 
::ignition::msgs::FuelMetadata_Legalmutable_legal ()
 
::ignition::msgs::FuelMetadata_Modelmutable_model ()
 
::std::stringmutable_name ()
 
::std::stringmutable_tags (int index)
 
::google::protobuf::RepeatedPtrField< ::std::string > * mutable_tags ()
 
::ignition::msgs::FuelMetadata_Worldmutable_world ()
 
const ::std::stringname () const
 
FuelMetadataNew () const
 
FuelMetadataNew (::google::protobuf::Arena *arena) const
 
FuelMetadataoperator= (const FuelMetadata &from)
 
::ignition::msgs::FuelMetadata_Categoriesrelease_categories ()
 
::std::stringrelease_description ()
 
::ignition::msgs::FuelMetadata_Legalrelease_legal ()
 
::ignition::msgs::FuelMetadata_Modelrelease_model ()
 
::std::stringrelease_name ()
 
::ignition::msgs::FuelMetadata_Worldrelease_world ()
 
ResourceTypeCase resource_type_case () const
 
void SerializeWithCachedSizes (::google::protobuf::io::CodedOutputStream *output) const
 
::google::protobuf::uint8 * SerializeWithCachedSizesToArray (::google::protobuf::uint8 *output) const
 
void set_allocated_categories (::ignition::msgs::FuelMetadata_Categories *categories)
 
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)
 
void set_description (const ::std::string &value)
 
void set_description (const char *value)
 
void set_description (const char *value, size_t size)
 
void set_name (const ::std::string &value)
 
void set_name (const char *value)
 
void set_name (const char *value, size_t size)
 
void set_tags (int index, const ::std::string &value)
 
void set_tags (int index, const char *value)
 
void set_tags (int index, const char *value, size_t size)
 
void set_version (::google::protobuf::int32 value)
 
void Swap (FuelMetadata *other)
 
const ::std::stringtags (int index) const
 
const ::google::protobuf::RepeatedPtrField< ::std::string > & tags () const
 
int tags_size () const
 
::google::protobuf::int32 version () const
 
const ::ignition::msgs::FuelMetadata_Worldworld () const
 

Static Public Member Functions

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

Static Public Attributes

static const int kAnnotationsFieldNumber = 9
 
static const int kAuthorsFieldNumber = 6
 
static const int kCategoriesFieldNumber = 12
 
static const int kCompatibilitiesFieldNumber = 11
 
static const int kDependenciesFieldNumber = 10
 
static const int kDescriptionFieldNumber = 4
 
static const int kLegalFieldNumber = 7
 
static const int kModelFieldNumber = 1
 
static const int kNameFieldNumber = 3
 
static const int kTagsFieldNumber = 8
 
static const int kVersionFieldNumber = 5
 
static const int kWorldFieldNumber = 2
 

Friends

void IGNITION_MSGS_VISIBLE protobuf_AddDesc_ignition_2fmsgs_2ffuel_5fmetadata_2eproto ()
 
void protobuf_AssignDesc_ignition_2fmsgs_2ffuel_5fmetadata_2eproto ()
 
void protobuf_ShutdownFile_ignition_2fmsgs_2ffuel_5fmetadata_2eproto ()
 

Member Typedef Documentation

◆ Categories

◆ Compatibility

◆ Contact

◆ Dependency

◆ Legal

◆ Model

◆ World

Member Enumeration Documentation

◆ ResourceTypeCase

Enumerator
kModel 
kWorld 
RESOURCE_TYPE_NOT_SET 

Constructor & Destructor Documentation

◆ FuelMetadata() [1/2]

◆ ~FuelMetadata()

virtual ~FuelMetadata ( )
virtual

◆ FuelMetadata() [2/2]

FuelMetadata ( const FuelMetadata from)

Member Function Documentation

◆ 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/4]

std::string * add_tags ( )
inline

◆ add_tags() [2/4]

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

References string::assign().

◆ add_tags() [3/4]

void add_tags ( const char *  value)
inline

References string::assign().

◆ add_tags() [4/4]

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

References string::assign().

◆ annotations()

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

◆ annotations_size()

int annotations_size ( ) const
inline

◆ authors() [1/2]

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

◆ authors() [2/2]

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

◆ authors_size()

int authors_size ( ) const
inline

◆ ByteSize()

int ByteSize ( ) const

◆ categories()

const ::ignition::msgs::FuelMetadata_Categories & categories ( ) const
inline

◆ Clear()

void Clear ( )

◆ clear_annotations()

void clear_annotations ( )
inline

◆ clear_authors()

void clear_authors ( )
inline

◆ clear_categories()

void clear_categories ( )
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_tags()

void clear_tags ( )
inline

◆ clear_version()

void clear_version ( )
inline

◆ clear_world()

void clear_world ( )
inline

◆ compatibilities() [1/2]

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

◆ compatibilities() [2/2]

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

◆ compatibilities_size()

int compatibilities_size ( ) const
inline

◆ CopyFrom() [1/2]

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

◆ CopyFrom() [2/2]

void CopyFrom ( const FuelMetadata from)

◆ default_instance()

static const FuelMetadata& default_instance ( )
static

◆ dependencies() [1/2]

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

◆ dependencies() [2/2]

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

◆ dependencies_size()

int dependencies_size ( ) const
inline

◆ description()

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

◆ descriptor()

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

◆ GetCachedSize()

int GetCachedSize ( ) const
inline

◆ GetMetadata()

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

◆ has_categories()

bool has_categories ( ) const
inline

◆ has_legal()

bool has_legal ( ) const
inline

◆ has_model()

bool has_model ( ) const
inline

◆ has_world()

bool has_world ( ) const
inline

◆ InternalSerializeWithCachedSizesToArray()

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

◆ IsInitialized()

bool IsInitialized ( ) const

◆ legal()

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

◆ MergeFrom() [1/2]

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

◆ MergeFrom() [2/2]

void MergeFrom ( const FuelMetadata from)

◆ MergePartialFromCodedStream()

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

◆ model()

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

◆ mutable_annotations()

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

◆ mutable_authors() [1/2]

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

◆ mutable_authors() [2/2]

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

◆ mutable_categories()

ignition::msgs::FuelMetadata_Categories * mutable_categories ( )
inline

◆ mutable_compatibilities() [1/2]

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

◆ mutable_compatibilities() [2/2]

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

◆ mutable_dependencies() [1/2]

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

◆ mutable_dependencies() [2/2]

google::protobuf::RepeatedPtrField<::ignition::msgs::FuelMetadata_Dependency > * mutable_dependencies ( )
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]

std::string * mutable_tags ( int  index)
inline

◆ mutable_tags() [2/2]

google::protobuf::RepeatedPtrField<::std::string > * mutable_tags ( )
inline

◆ mutable_world()

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

◆ name()

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

◆ New() [1/2]

FuelMetadata* New ( ) const
inline

References FuelMetadata::New().

Referenced by FuelMetadata::New().

◆ New() [2/2]

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

◆ operator=()

FuelMetadata& operator= ( const FuelMetadata from)
inline

◆ release_categories()

ignition::msgs::FuelMetadata_Categories * release_categories ( )
inline

◆ 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

◆ SerializeWithCachedSizes()

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

◆ SerializeWithCachedSizesToArray()

::google::protobuf::uint8* SerializeWithCachedSizesToArray ( ::google::protobuf::uint8 *  output) const
inline

◆ set_allocated_categories()

void set_allocated_categories ( ::ignition::msgs::FuelMetadata_Categories categories)
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)
inline

◆ set_allocated_name()

void set_allocated_name ( ::std::string name)
inline

◆ set_allocated_world()

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

◆ set_description() [1/3]

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

◆ set_description() [2/3]

void set_description ( const char *  value)
inline

◆ set_description() [3/3]

void set_description ( const char *  value,
size_t  size 
)
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_tags() [1/3]

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

◆ set_tags() [2/3]

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

◆ set_tags() [3/3]

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

◆ set_version()

void set_version ( ::google::protobuf::int32  value)
inline

◆ Swap()

void Swap ( FuelMetadata other)

◆ tags() [1/2]

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

◆ tags() [2/2]

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

◆ tags_size()

int tags_size ( ) const
inline

◆ version()

google::protobuf::int32 version ( ) const
inline

◆ world()

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

Friends And Related Function Documentation

◆ protobuf_AddDesc_ignition_2fmsgs_2ffuel_5fmetadata_2eproto

void IGNITION_MSGS_VISIBLE protobuf_AddDesc_ignition_2fmsgs_2ffuel_5fmetadata_2eproto ( )
friend

◆ protobuf_AssignDesc_ignition_2fmsgs_2ffuel_5fmetadata_2eproto

void protobuf_AssignDesc_ignition_2fmsgs_2ffuel_5fmetadata_2eproto ( )
friend

◆ protobuf_ShutdownFile_ignition_2fmsgs_2ffuel_5fmetadata_2eproto

void protobuf_ShutdownFile_ignition_2fmsgs_2ffuel_5fmetadata_2eproto ( )
friend

Member Data Documentation

◆ kAnnotationsFieldNumber

const int kAnnotationsFieldNumber = 9
static

◆ kAuthorsFieldNumber

const int kAuthorsFieldNumber = 6
static

◆ kCategoriesFieldNumber

const int kCategoriesFieldNumber = 12
static

◆ kCompatibilitiesFieldNumber

const int kCompatibilitiesFieldNumber = 11
static

◆ kDependenciesFieldNumber

const int kDependenciesFieldNumber = 10
static

◆ kDescriptionFieldNumber

const int kDescriptionFieldNumber = 4
static

◆ kLegalFieldNumber

const int kLegalFieldNumber = 7
static

◆ kModelFieldNumber

const int kModelFieldNumber = 1
static

◆ kNameFieldNumber

const int kNameFieldNumber = 3
static

◆ kTagsFieldNumber

const int kTagsFieldNumber = 8
static

◆ kVersionFieldNumber

const int kVersionFieldNumber = 5
static

◆ kWorldFieldNumber

const int kWorldFieldNumber = 2
static

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