class TrajectoryErrorElement

Member values

Member name	Data type	Description
error_type	uint32	Error type
error_identifier	uint32	This field is deprecated and will be removed in a future release.
error_value	float32	Erroneous value
min_value	float32	Minimum permitted value
max_value	float32	Maximum permitted value
index	uint32	Actuator index
message	string	Clarification message for the error
waypoint_index	uint32	Waypoint index (if it applies)

Member functions

Function name	Return type	Input type	Description
error_type() const	uint32	void	Returns the current value of error_type. If the error_type is not set, returns 0.
set_error_type()	void	uint32	Sets the value of error_type. After calling this, error_type() will return value.
clear_error_type()	void	void	Clears the value of error_type. After calling this, error_type() will return the empty string/empty bytes.
error_identifier() const	uint32	void	Returns the current value of error_identifier. If the error_identifier is not set, returns 0.
set_error_identifier()	void	uint32	Sets the value of error_identifier. After calling this, error_identifier() will return value.
clear_error_identifier()	void	void	Clears the value of error_identifier. After calling this, error_identifier() will return the empty string/empty bytes.
error_value()	float32	void	Returns the current value of error_value. If the error_value is not set, returns 0.
set_error_value()	void	float32	Sets the value of error_value. After calling this, error_value() will return value.
clear_error_value()	void	void	Clears the value of error_value. After calling this, error_value() will return 0.
min_value()	float32	void	Returns the current value of min_value. If the min_value is not set, returns 0.
set_min_value()	void	float32	Sets the value of min_value. After calling this, min_value() will return value.
clear_min_value()	void	void	Clears the value of min_value. After calling this, min_value() will return 0.
max_value()	float32	void	Returns the current value of max_value. If the max_value is not set, returns 0.
set_max_value()	void	float32	Sets the value of max_value. After calling this, max_value() will return value.
clear_max_value()	void	void	Clears the value of max_value. After calling this, max_value() will return 0.
index()	uint32	void	Returns the current value of index. If the index is not set, returns 0.
set_index()	void	uint32	Sets the value of index. After calling this, index() will return value.
clear_index()	void	void	Clears the value of index. After calling this, index() will return 0.
message()	const string&	void	Returns the current value of message. If message is not set, returns the empty string/empty bytes.
set_message()	void	const string&	Sets the value of message. After calling this, message() will return a copy of value.
set_message()	void	string&&	(C++11 and beyond): Sets the value of message, moving from the passed string. After calling this, message() will return a copy of value.
set_message()	void	const char*	Sets the value of message using a C-style null-terminated string. After calling this, message() will return a copy of value.
mutable_message()	string *	void	Returns a pointer to the mutable string object that stores message's value. If the field was not set prior to the call, then the returned string will be empty. After calling this, message() will return whatever value is written into the given string.
clear_message()	void	void	Clears the value of message. After calling this, message() will return the empty string/empty bytes.
set_allocated_message()	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_message().
release_message()	string *	void	Releases the ownership of message and returns the pointer of the string object. After calling this, caller takes the ownership of the allocated string object and message() will return the empty string/empty bytes.
waypoint_index()	uint32	void	Returns the current value of waypoint_index. If the waypoint_index is not set, returns 0.
set_waypoint_index()	void	uint32	Sets the value of waypoint_index. After calling this, waypoint_index() will return value.
clear_waypoint_index()	void	void	Clears the value of waypoint_index. After calling this, waypoint_index() will return 0.

Parent topic: Base (C++)