Member values
| Member name | Data type | Description |
|---|---|---|
| group_handle | MapGroupHandle | Map group handle (do not set on createMapGroup() call) |
| name | string | Map group friendly name |
| related_mapping_handle | MappingHandle | Mapping that this map group belongs to |
| parent_group_handle | MapGroupHandle | Parent map group (if any) |
| children_map_group_handles | MapGroupHandle | Children map groups (if any) |
| map_handles | MapHandle | Array of maps that are included in this map group |
| application_data | string | Application data (reserved for use by Web App) |
Member functions
| Function name | Return type | Input type | Description |
|---|---|---|---|
| has_group_handle() const | bool | void | Returns true if group_handle is set. |
| group_handle() | const MapGroupHandle& | void | Returns the current value of group_handle. If group_handle is not set, returns a MapGroupHandle with none of its fields set (possibly group_handle::default_instance()). |
| mutable_group_handle() | MapGroupHandle * | void | Returns a pointer to the mutable MapGroupHandle object that stores the field's value. If the field was not set prior to the call, then the returned MapGroupHandle will have none of its fields set (i.e. it will be identical to a newly-allocated MapGroupHandle). After calling this, has_group_handle() will return true and group_handle() will return a reference to the same instance of MapGroupHandle. |
| clear_group_handle() | void | void | Clears the value of the field. After calling this, has_group_handle() will return false and group_handle() will return the default value. |
| set_allocated_group_handle() | void | MapGroupHandle * | Sets the MapGroupHandle object to the field and frees the previous field value if it exists. If the MapGroupHandle pointer is not NULL, the message takes ownership of the allocated MapGroupHandle object and has_ MapGroupHandle() will return true. Otherwise, if the group_handle is NULL, the behavior is the same as calling clear_group_handle(). |
| release_group_handle() | MapGroupHandle * | void | Releases the ownership of the field and returns the pointer of the MapGroupHandle object. After calling this, caller takes the ownership of the allocated MapGroupHandle object, has_group_handle() will return false, and group_handle() will return the default value. |
| name() | const string& | void | Returns the current value of name. If name is not set, returns the empty string/empty bytes. |
| set_name() | void | const string& | Sets the value of name. After calling this, name() will return a copy of value. |
| set_name() | void | string&& | (C++11 and beyond): Sets the value of name, moving from the passed string. After calling this, name() will return a copy of value. |
| set_name() | void | const char* | Sets the value of name using a C-style null-terminated string. After calling this, name() will return a copy of value. |
| mutable_name() | string * | void | Returns a pointer to the mutable string object that stores name's value. If the field was not set prior to the call, then the returned string will be empty. After calling this, name() will return whatever value is written into the given string. |
| clear_name() | void | void | Clears the value of name. After calling this, name() will return the empty string/empty bytes. |
| set_allocated_name() | 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_name(). |
| release_name() | string * | void | Releases the ownership of name and returns the pointer of the string object. After calling this, caller takes the ownership of the allocated string object and name() will return the empty string/empty bytes. |
| has_related_mapping_handle() const | bool | void | Returns true if related_mapping_handle is set. |
| related_mapping_handle() | const MappingHandle& | void | Returns the current value of related_mapping_handle. If related_mapping_handle is not set, returns a MappingHandle with none of its fields set (possibly related_mapping_handle::default_instance()). |
| mutable_related_mapping_handle() | MappingHandle * | void | Returns a pointer to the mutable MappingHandle object that stores the field's value. If the field was not set prior to the call, then the returned MappingHandle will have none of its fields set (i.e. it will be identical to a newly-allocated MappingHandle). After calling this, has_related_mapping_handle() will return true and related_mapping_handle() will return a reference to the same instance of MappingHandle. |
| clear_related_mapping_handle() | void | void | Clears the value of the field. After calling this, has_related_mapping_handle() will return false and related_mapping_handle() will return the default value. |
| set_allocated_related_mapping_handle() | void | MappingHandle * | Sets the MappingHandle object to the field and frees the previous field value if it exists. If the MappingHandle pointer is not NULL, the message takes ownership of the allocated MappingHandle object and has_ MappingHandle() will return true. Otherwise, if the related_mapping_handle is NULL, the behavior is the same as calling clear_related_mapping_handle(). |
| release_related_mapping_handle() | MappingHandle * | void | Releases the ownership of the field and returns the pointer of the MappingHandle object. After calling this, caller takes the ownership of the allocated MappingHandle object, has_related_mapping_handle() will return false, and related_mapping_handle() will return the default value. |
| has_parent_group_handle() const | bool | void | Returns true if parent_group_handle is set. |
| parent_group_handle() | const MapGroupHandle& | void | Returns the current value of parent_group_handle. If parent_group_handle is not set, returns a MapGroupHandle with none of its fields set (possibly parent_group_handle::default_instance()). |
| mutable_parent_group_handle() | MapGroupHandle * | void | Returns a pointer to the mutable MapGroupHandle object that stores the field's value. If the field was not set prior to the call, then the returned MapGroupHandle will have none of its fields set (i.e. it will be identical to a newly-allocated MapGroupHandle). After calling this, has_parent_group_handle() will return true and parent_group_handle() will return a reference to the same instance of MapGroupHandle. |
| clear_parent_group_handle() | void | void | Clears the value of the field. After calling this, has_parent_group_handle() will return false and parent_group_handle() will return the default value. |
| set_allocated_parent_group_handle() | void | MapGroupHandle * | Sets the MapGroupHandle object to the field and frees the previous field value if it exists. If the MapGroupHandle pointer is not NULL, the message takes ownership of the allocated MapGroupHandle object and has_ MapGroupHandle() will return true. Otherwise, if the parent_group_handle is NULL, the behavior is the same as calling clear_parent_group_handle(). |
| release_parent_group_handle() | MapGroupHandle * | void | Releases the ownership of the field and returns the pointer of the MapGroupHandle object. After calling this, caller takes the ownership of the allocated MapGroupHandle object, has_parent_group_handle() will return false, and parent_group_handle() will return the default value. |
| children_map_group_handles_size() const | int | void | Returns the number of elements currently in the field. |
| children_map_group_handles() const | const MapGroupHandle | int index | Returns the element at the given zero-based index. Calling this method with index outside of [0, children_map_group_handles_size()) yields undefined behavior. |
| mutable_children_map_group_handles() | MapGroupHandle* | int index | Returns a pointer to the mutable MapGroupHandle object that stores the value of the element at the given zero-based index. Calling this method with index outside of [0, children_map_group_handles_size()) yields undefined behavior. |
| add_children_map_group_handles() | MapGroupHandle* | void | Adds a new element and returns a pointer to it. The returned MapGroupHandle is mutable and will have none of its fields set (i.e. it will be identical to a newly-allocated MapGroupHandle). |
| clear_children_map_group_handles() | void | void | Removes all elements from the field. After calling this, children_map_group_handles_size() will return zero. |
| children_map_group_handles() const | const RepeatedPtrField< MapGroupHandle>& | void | Returns the underlying RepeatedPtrField that stores the field's elements. This container class provides STL-like iterators and other methods. |
| mutable_children_map_group_handles() | RepeatedPtrField< MapGroupHandle>* | 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. |
| map_handles_size() const | int | void | Returns the number of elements currently in the field. |
| map_handles() const | const MapHandle | int index | Returns the element at the given zero-based index. Calling this method with index outside of [0, map_handles_size()) yields undefined behavior. |
| mutable_map_handles() | MapHandle* | int index | Returns a pointer to the mutable MapHandle object that stores the value of the element at the given zero-based index. Calling this method with index outside of [0, map_handles_size()) yields undefined behavior. |
| add_map_handles() | MapHandle* | void | Adds a new element and returns a pointer to it. The returned MapHandle is mutable and will have none of its fields set (i.e. it will be identical to a newly-allocated MapHandle). |
| clear_map_handles() | void | void | Removes all elements from the field. After calling this, map_handles_size() will return zero. |
| map_handles() const | const RepeatedPtrField< MapHandle>& | void | Returns the underlying RepeatedPtrField that stores the field's elements. This container class provides STL-like iterators and other methods. |
| mutable_map_handles() | RepeatedPtrField< MapHandle>* | 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. |
| application_data() | const string& | void | Returns the current value of application_data. If application_data is not set, returns the empty string/empty bytes. |
| set_application_data() | void | const string& | Sets the value of application_data. After calling this, application_data() will return a copy of value. |
| set_application_data() | void | string&& | (C++11 and beyond): Sets the value of application_data, moving from the passed string. After calling this, application_data() will return a copy of value. |
| set_application_data() | void | const char* | Sets the value of application_data using a C-style null-terminated string. After calling this, application_data() will return a copy of value. |
| mutable_application_data() | string * | void | Returns a pointer to the mutable string object that stores application_data's value. If the field was not set prior to the call, then the returned string will be empty. After calling this, application_data() will return whatever value is written into the given string. |
| clear_application_data() | void | void | Clears the value of application_data. After calling this, application_data() will return the empty string/empty bytes. |
| set_allocated_application_data() | 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_application_data(). |
| release_application_data() | string * | void | Releases the ownership of application_data and returns the pointer of the string object. After calling this, caller takes the ownership of the allocated string object and application_data() will return the empty string/empty bytes. |
Parent topic: Base (C++)