class ActivateMapHandle

August 13, 2019 · View on GitHub

Member values

Member name	Data type	Description
mapping_handle	MappingHandle	Mapping that the active map is asked for
map_group_handle	MapGroupHandle	Map group that the active map is asked for (not implemented yet)
map_handle	MapHandle	New active map

Member functions

Function name	Return type	Input type	Description
has_mapping_handle() const	bool	void	Returns true if mapping_handle is set.
mapping_handle()	const MappingHandle&	void	Returns the current value of mapping_handle. If mapping_handle is not set, returns a MappingHandle with none of its fields set (possibly mapping_handle::default_instance()).
mutable_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_mapping_handle() will return true and mapping_handle() will return a reference to the same instance of MappingHandle.
clear_mapping_handle()	void	void	Clears the value of the field. After calling this, has_mapping_handle() will return false and mapping_handle() will return the default value.
set_allocated_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 mapping_handle is NULL, the behavior is the same as calling clear_mapping_handle().
release_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_mapping_handle() will return false, and mapping_handle() will return the default value.
has_map_group_handle() const	bool	void	Returns true if map_group_handle is set.
map_group_handle()	const MapGroupHandle&	void	Returns the current value of map_group_handle. If map_group_handle is not set, returns a MapGroupHandle with none of its fields set (possibly map_group_handle::default_instance()).
mutable_map_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_map_group_handle() will return true and map_group_handle() will return a reference to the same instance of MapGroupHandle.
clear_map_group_handle()	void	void	Clears the value of the field. After calling this, has_map_group_handle() will return false and map_group_handle() will return the default value.
set_allocated_map_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 map_group_handle is NULL, the behavior is the same as calling clear_map_group_handle().
release_map_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_map_group_handle() will return false, and map_group_handle() will return the default value.
has_map_handle() const	bool	void	Returns true if map_handle is set.
map_handle()	const MapHandle&	void	Returns the current value of map_handle. If map_handle is not set, returns a MapHandle with none of its fields set (possibly map_handle::default_instance()).
mutable_map_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_map_handle() will return true and map_handle() will return a reference to the same instance of MapHandle.
clear_map_handle()	void	void	Clears the value of the field. After calling this, has_map_handle() will return false and map_handle() will return the default value.
set_allocated_map_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 map_handle is NULL, the behavior is the same as calling clear_map_handle().
release_map_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_map_handle() will return false, and map_handle() will return the default value.

Parent topic: Base (C++)