ErrorTracIK Class Reference

#include <RoboticsPlugin/Include/ImFusion/Robotics/ErrorTracIK.h>

Implementation of error types from trac_ik library. More...

Inheritance diagram for ErrorTracIK:

Detailed Description

Implementation of error types from trac_ik library.

Error taken from github https://bitbucket.org/traclabs/trac_ik/src/jazzy/trac_ik_lib/src/trac_ik.cpp

Public Member Functions
	ErrorTracIK (int err)
int	id () const override
	Retrieves the unique identifier for the error.
std::string	domain () const override
	Returns the category to which the custom error implementation belongs.
std::string	message () const override
	Retrieves the error message.
void	handle () override
	Error handling strategy, allows the user to define a task on the constructor of ErrorFrontEnd.
Public Member Functions inherited from ErrorInheritanceHelper< ErrorTracIK >
	~ErrorInheritanceHelper () override=default
	Override destructor.
	ErrorInheritanceHelper (const ErrorInterface &ei)
std::unique_ptr< ErrorTracIK >	clone () const &
	Creates a copy of the current instance.
Public Member Functions inherited from ErrorInterface
template<typename T>
	operator Utils::Expected< T, ErrorFrontEnd > () const &
	Template method for casting to std::expected<T, ErrorFrontEnd>.
std::unique_ptr< ErrorInterface >	clone () const &
	Creates a copy of the current instance.
bool	operator== (const ErrorFrontEnd &other) const
	Compares the id and the domain.
bool	operator== (const ErrorInterface &other) const
	Compares the id and the domain.
virtual ErrorComposition	operator| (const ErrorInterface &input) const
	Composition operator.

Member Function Documentation

id()

int id ( ) const

nodiscardoverridevirtual

Retrieves the unique identifier for the error.

Returns

The error ID.

Implements ErrorInterface.

domain()

std::string domain ( ) const

nodiscardoverridevirtual

Returns the category to which the custom error implementation belongs.

Returns

string representing the category

Implements ErrorInterface.

message()

std::string message ( ) const

nodiscardoverridevirtual

Retrieves the error message.

This method is abstract to force the user to instantiate the error with the correct message.

Returns

An error message.

Implements ErrorInterface.

handle()

void handle ( )

overridevirtual

Error handling strategy, allows the user to define a task on the constructor of ErrorFrontEnd.

Reimplemented from ErrorInterface.

---

The documentation for this class was generated from the following file:

• RoboticsPlugin/Include/ImFusion/Robotics/ErrorTracIK.h