Member values
| Member name | Data type | Description |
|---|---|---|
| handle | MapHandle | Map handle (do not set on createMap() call) |
| name | string | Map friendly name |
| elements | MapElement | Array of map elements |
Member functions
| Function name | Return type | Input type | Description |
|---|---|---|---|
| has_handle() const | bool | void | Returns true if handle is set. |
| handle() | const MapHandle& | void | Returns the current value of handle. If handle is not set, returns a MapHandle with none of its fields set (possibly handle::default_instance()). |
| mutable_handle() | MapHandle * | void | Returns a pointer to the mutable MapHandle object that stores the field's value. If the field was not set prior to the call, then the returned MapHandle will have none of its fields set (i.e. it will be identical to a newly-allocated MapHandle). After calling this, has_handle() will return true and handle() will return a reference to the same instance of MapHandle. |
| clear_handle() | void | void | Clears the value of the field. After calling this, has_handle() will return false and handle() will return the default value. |
| set_allocated_handle() | void | MapHandle * | Sets the MapHandle object to the field and frees the previous field value if it exists. If the MapHandle pointer is not NULL, the message takes ownership of the allocated MapHandle object and has_ MapHandle() will return true. Otherwise, if the handle is NULL, the behavior is the same as calling clear_handle(). |
| release_handle() | MapHandle * | void | Releases the ownership of the field and returns the pointer of the MapHandle object. After calling this, caller takes the ownership of the allocated MapHandle object, has_handle() will return false, and 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. |
| elements_size() const | int | void | Returns the number of elements currently in the field. |
| elements() const | const MapElement | int index | Returns the element at the given zero-based index. Calling this method with index outside of [0, elements_size()) yields undefined behavior. |
| mutable_elements() | MapElement* | int index | Returns a pointer to the mutable MapElement object that stores the value of the element at the given zero-based index. Calling this method with index outside of [0, elements_size()) yields undefined behavior. |
| add_elements() | MapElement* | void | Adds a new element and returns a pointer to it. The returned MapElement is mutable and will have none of its fields set (i.e. it will be identical to a newly-allocated MapElement). |
| clear_elements() | void | void | Removes all elements from the field. After calling this, elements_size() will return zero. |
| elements() const | const RepeatedPtrField< MapElement>& | void | Returns the underlying RepeatedPtrField that stores the field's elements. This container class provides STL-like iterators and other methods. |
| mutable_elements() | RepeatedPtrField< MapElement>* | 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++)