ErrorComposition Class Reference

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

Class to represent a stack of errors. More...

Inheritance diagram for ErrorComposition:

Detailed Description

Class to represent a stack of errors.

Errors can be composed into a stack as they are handled in nested function calls to include additional information. The composition of errors will add the new one to the top of the stack. It will hence appear at the back of the vectors returned by id(), message(), and domain().

Public Member Functions
	ErrorComposition (const ErrorInterface &input)
	ErrorComposition (const ErrorComposition &input)
std::string	domain () const override
int	id () const override
	Retrieves the unique identifier for the outermost error.
std::string	message () const override
std::vector< std::string >	messages () const
	Returns the list of messages of all errors.
std::vector< int >	ids () const
	Returns the list of ids of all errors.
std::vector< std::string >	domains () const
	Returns the list of ids.
ErrorComposition	operator| (const ErrorInterface &input) const override
	Compose the error with another one.
Public Member Functions inherited from ErrorInheritanceHelper< ErrorComposition >
	~ErrorInheritanceHelper () override=default
	Override destructor.
	ErrorInheritanceHelper (const ErrorInterface &ei)
std::unique_ptr< ErrorComposition >	clone () const &
	Creates a copy of the current instance.

Additional Inherited Members
Protected Member Functions inherited from ImFusion::Utils::NotCopyable
	NotCopyable (NotCopyable &&) noexcept=default
NotCopyable &	operator= (NotCopyable &&) noexcept=default
	NotCopyable (const NotCopyable &)=delete
NotCopyable &	operator= (const NotCopyable &)=delete

Member Function Documentation

domain()

std::string ErrorComposition::domain ( ) const

nodiscardoverride

Returns

string representing the category of the outermost error.

id()

int ErrorComposition::id ( ) const

nodiscardoverride

Retrieves the unique identifier for the outermost error.

Returns

The error ID.

operator|()

ErrorComposition ErrorComposition::operator| ( const ErrorInterface & input ) const

override

Compose the error with another one.

The error passed as argument will be interpreted as the outer error, and will be added to the top of the error stack (i.e. the back of the error vector).

---

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

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