class FirmwareBundleVersions

February 26, 2020 ยท View on GitHub

Member values

Member nameData typeDescription
main_bundle_versionstringVersion of the main bundle
components_versionsFirmwareComponentVersionList containing all components of the bundle

Member functions

Function nameReturn typeInput typeDescription
main_bundle_version()const string&voidReturns the current value of main_bundle_version. If main_bundle_version is not set, returns the empty string/empty bytes.
set_main_bundle_version()voidconst string&Sets the value of main_bundle_version. After calling this, main_bundle_version() will return a copy of value.
set_main_bundle_version()voidstring&&(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()voidconst 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 *voidReturns 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()voidvoidClears the value of main_bundle_version. After calling this, main_bundle_version() will return the empty string/empty bytes.
set_allocated_main_bundle_version()voidstring*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 *voidReleases 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() constintvoidReturns the number of elements currently in the field.
components_versions() constconst FirmwareComponentVersionint indexReturns 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 indexReturns 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*voidAdds 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()voidvoidRemoves all elements from the field. After calling this, components_versions_size() will return zero.
components_versions() constconst RepeatedPtrField< FirmwareComponentVersion>&voidReturns the underlying RepeatedPtrField that stores the field's elements. This container class provides STL-like iterators and other methods.
mutable_components_versions()RepeatedPtrField< FirmwareComponentVersion>*voidReturns 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++)