Skip to content

Latest commit

 

History

History
31 lines (25 loc) · 4.24 KB

FirmwareBundleVersions.md

File metadata and controls

31 lines (25 loc) · 4.24 KB

class FirmwareBundleVersions

Member values

Member name Data type Description
main_bundle_version string Version of the main bundle
components_versions FirmwareComponentVersion List containing all components of the bundle

Member functions

Function name Return type Input type Description
main_bundle_version() const string& void Returns the current value of main_bundle_version. If main_bundle_version is not set, returns the empty string/empty bytes.
set_main_bundle_version() void const string& Sets the value of main_bundle_version. After calling this, main_bundle_version() will return a copy of value.
set_main_bundle_version() void string&& (C++11 and beyond): Sets the value of main_bundle_version, moving from the passed string. After calling this, main_bundle_version() will return a copy of value.
set_main_bundle_version() void const char* Sets the value of main_bundle_version using a C-style null-terminated string. After calling this, main_bundle_version() will return a copy of value.
mutable_main_bundle_version() string * void Returns a pointer to the mutable string object that stores main_bundle_version's value. If the field was not set prior to the call, then the returned string will be empty. After calling this, main_bundle_version() will return whatever value is written into the given string.
clear_main_bundle_version() void void Clears the value of main_bundle_version. After calling this, main_bundle_version() will return the empty string/empty bytes.
set_allocated_main_bundle_version() void string* Sets the string object to the field and frees the previous field value if it exists. If the string pointer is not NULL, the message takes ownership of the allocated string object. The message is free to delete the allocated string object at any time, so references to the object may be invalidated. Otherwise, if the value is NULL, the behavior is the same as calling clear_main_bundle_version().
release_main_bundle_version() string * void Releases the ownership of main_bundle_version and returns the pointer of the string object. After calling this, caller takes the ownership of the allocated string object and main_bundle_version() will return the empty string/empty bytes.
components_versions_size() const int void Returns the number of elements currently in the field.
components_versions() const const FirmwareComponentVersion int index Returns the element at the given zero-based index. Calling this method with index outside of [0, components_versions_size()) yields undefined behavior.
mutable_components_versions() FirmwareComponentVersion* int index Returns a pointer to the mutable FirmwareComponentVersion object that stores the value of the element at the given zero-based index. Calling this method with index outside of [0, components_versions_size()) yields undefined behavior.
add_components_versions() FirmwareComponentVersion* void Adds a new element and returns a pointer to it. The returned FirmwareComponentVersion is mutable and will have none of its fields set (i.e. it will be identical to a newly-allocated FirmwareComponentVersion).
clear_components_versions() void void Removes all elements from the field. After calling this, components_versions_size() will return zero.
components_versions() const const RepeatedPtrField< FirmwareComponentVersion>& void Returns the underlying RepeatedPtrField that stores the field's elements. This container class provides STL-like iterators and other methods.
mutable_components_versions() RepeatedPtrField< FirmwareComponentVersion>* void Returns a pointer to the underlying mutable RepeatedPtrField that stores the field's elements. This container class provides STL-like iterators and other methods.

Parent topic: Base (C++)