class MappingInfoNotification

February 26, 2020 · View on GitHub

Member values

Member name	Data type	Description
controller_identifier	uint32	Identifier of the controller
active_map_handle	MapHandle	New active map
timestamp	Timestamp	Event timestamp
user_handle	UserProfileHandle	User that caused the mapping information event
connection	Connection	Connection that caused the mapping information event
mapping_handle	MappingHandle	Mapping for which the map was activated

Member functions

Function name	Return type	Input type	Description
controller_identifier()	uint32	void	Returns the current value of controller_identifier. If the controller_identifier is not set, returns 0.
set_controller_identifier()	void	uint32	Sets the value of controller_identifier. After calling this, controller_identifier() will return value.
clear_controller_identifier()	void	void	Clears the value of controller_identifier. After calling this, controller_identifier() will return 0.
has_active_map_handle() const	bool	void	Returns true if active_map_handle is set.
active_map_handle()	const MapHandle&	void	Returns the current value of active_map_handle. If active_map_handle is not set, returns a MapHandle with none of its fields set (possibly active_map_handle::default_instance()).
mutable_active_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_active_map_handle() will return true and active_map_handle() will return a reference to the same instance of MapHandle.
clear_active_map_handle()	void	void	Clears the value of the field. After calling this, has_active_map_handle() will return false and active_map_handle() will return the default value.
set_allocated_active_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 active_map_handle is NULL, the behavior is the same as calling clear_active_map_handle().
release_active_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_active_map_handle() will return false, and active_map_handle() will return the default value.
has_timestamp() const	bool	void	Returns true if timestamp is set.
timestamp()	const Timestamp&	void	Returns the current value of timestamp. If timestamp is not set, returns a Timestamp with none of its fields set (possibly timestamp::default_instance()).
mutable_timestamp()	Timestamp *	void	Returns a pointer to the mutable Timestamp object that stores the field's value. If the field was not set prior to the call, then the returned Timestamp will have none of its fields set (i.e. it will be identical to a newly-allocated Timestamp). After calling this, has_timestamp() will return true and timestamp() will return a reference to the same instance of Timestamp.
clear_timestamp()	void	void	Clears the value of the field. After calling this, has_timestamp() will return false and timestamp() will return the default value.
set_allocated_timestamp()	void	Timestamp *	Sets the Timestamp object to the field and frees the previous field value if it exists. If the Timestamp pointer is not NULL, the message takes ownership of the allocated Timestamp object and has_ Timestamp() will return true. Otherwise, if the timestamp is NULL, the behavior is the same as calling clear_timestamp().
release_timestamp()	Timestamp *	void	Releases the ownership of the field and returns the pointer of the Timestamp object. After calling this, caller takes the ownership of the allocated Timestamp object, has_timestamp() will return false, and timestamp() will return the default value.
has_user_handle() const	bool	void	Returns true if user_handle is set.
user_handle()	const UserProfileHandle&	void	Returns the current value of user_handle. If user_handle is not set, returns a UserProfileHandle with none of its fields set (possibly user_handle::default_instance()).
mutable_user_handle()	UserProfileHandle *	void	Returns a pointer to the mutable UserProfileHandle object that stores the field's value. If the field was not set prior to the call, then the returned UserProfileHandle will have none of its fields set (i.e. it will be identical to a newly-allocated UserProfileHandle). After calling this, has_user_handle() will return true and user_handle() will return a reference to the same instance of UserProfileHandle.
clear_user_handle()	void	void	Clears the value of the field. After calling this, has_user_handle() will return false and user_handle() will return the default value.
set_allocated_user_handle()	void	UserProfileHandle *	Sets the UserProfileHandle object to the field and frees the previous field value if it exists. If the UserProfileHandle pointer is not NULL, the message takes ownership of the allocated UserProfileHandle object and has_ UserProfileHandle() will return true. Otherwise, if the user_handle is NULL, the behavior is the same as calling clear_user_handle().
release_user_handle()	UserProfileHandle *	void	Releases the ownership of the field and returns the pointer of the UserProfileHandle object. After calling this, caller takes the ownership of the allocated UserProfileHandle object, has_user_handle() will return false, and user_handle() will return the default value.
has_connection() const	bool	void	Returns true if connection is set.
connection()	const Connection&	void	Returns the current value of connection. If connection is not set, returns a Connection with none of its fields set (possibly connection::default_instance()).
mutable_connection()	Connection *	void	Returns a pointer to the mutable Connection object that stores the field's value. If the field was not set prior to the call, then the returned Connection will have none of its fields set (i.e. it will be identical to a newly-allocated Connection). After calling this, has_connection() will return true and connection() will return a reference to the same instance of Connection.
clear_connection()	void	void	Clears the value of the field. After calling this, has_connection() will return false and connection() will return the default value.
set_allocated_connection()	void	Connection *	Sets the Connection object to the field and frees the previous field value if it exists. If the Connection pointer is not NULL, the message takes ownership of the allocated Connection object and has_ Connection() will return true. Otherwise, if the connection is NULL, the behavior is the same as calling clear_connection().
release_connection()	Connection *	void	Releases the ownership of the field and returns the pointer of the Connection object. After calling this, caller takes the ownership of the allocated Connection object, has_connection() will return false, and connection() will return the default value.
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.

Parent topic: Base (C++)