KallistoDetailedResult Class Reference

Class that encapsulates a result. More...

#include <kallisto_error.hpp>

Public Member Functions
	~KallistoDetailedResult ()
	KallistoDetailedResult (const KallistoDetailedResult &other)
	KallistoDetailedResult (KallistoDetailedResult &&other)
KallistoDetailedResult &	operator= (const KallistoDetailedResult &other)
KallistoDetailedResult &	operator= (KallistoDetailedResult &&other)
std::string	toString () const
KallistoResult	getResult () const
std::string	getMessage () const

Static Public Member Functions
static KallistoDetailedResult	build (const KallistoResult result)
static KallistoDetailedResult	build (const KallistoResult result, const std::string message)
static std::string	toString (const KallistoResult result)

Detailed Description

Class that encapsulates a result.

Constructor & Destructor Documentation

~KallistoDetailedResult()

~KallistoDetailedResult

(

)

Destructor

KallistoDetailedResult() [1/2]

KallistoDetailedResult

(

const KallistoDetailedResult &

other

)

Copy constructor

KallistoDetailedResult() [2/2]

KallistoDetailedResult

(

KallistoDetailedResult &&

other

)

Move constructor

Member Function Documentation

build() [1/2]

static KallistoDetailedResult build ( const KallistoResult  result )

static

Builds an object of this class.

Parameters

result

The desired result.

Returns

A built KallistoDetailedResult.

build() [2/2]

static KallistoDetailedResult build ( const KallistoResult  result, const std::string  message  )

static

Builds an object of this class with an message.

Parameters

result	The desired result.
message	The desired message.

Returns

A built KallistoDetailedResult.

getMessage()

std::string getMessage

(

)

const

Returns optional message.

Returns

The message associated with this result or "" if no message was provided.

getResult()

KallistoResult getResult

(

)

const

Returns result.

Returns

The code associated with the result.

operator=() [1/2]

KallistoDetailedResult& operator=

(

const KallistoDetailedResult &

other

)

Copy assignment operator

operator=() [2/2]

KallistoDetailedResult& operator=

(

KallistoDetailedResult &&

other

)

Move assignment operator

toString() [1/2]

static std::string toString ( const KallistoResult  result )

static

Parses the passed result to string.

Parameters

result

The desired result.

Returns

A user readable string detailing the result code.

toString() [2/2]

std::string toString

(

)

const

Parses to string.

Returns

A user readable string detailing the result code.

---

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

• /home/joao.oliveira/Workspace/local/repo/documentation/sphinx/source/components/kallistolinuxapi/include/util/error/kallisto_error.hpp