Arc::MCC_Status Class Reference

A class for communication of MCC processing results. More...

#include <MCC_Status.h>

Public Member Functions
	MCC_Status (StatusKind kind=STATUS_UNDEFINED, const std::string &origin="???", const std::string &explanation="No explanation.")
bool	isOk () const
StatusKind	getKind () const
const std::string &	getOrigin () const
const std::string &	getExplanation () const
	operator std::string () const
	operator bool (void) const
bool	operator! (void) const

---

Detailed Description

A class for communication of MCC processing results.

This class is used to communicate result status between MCCs. It contains a status kind, a string specifying the origin (MCC) of the status object and an explanation.

---

Constructor & Destructor Documentation

Arc::MCC_Status::MCC_Status	(	StatusKind	kind = STATUS_UNDEFINED,
		const std::string &	origin = "???",
		const std::string &	explanation = "No explanation."
	)

The constructor.

Creates a MCC_Status object.

Parameters:

	kind	The StatusKind (default: STATUS_UNDEFINED)
	origin	The origin MCC (default: "???")
	explanation	An explanation (default: "No explanation.")

---

Member Function Documentation

const std::string& Arc::MCC_Status::getExplanation

(

)

const

Returns an explanation.

This method returns an explanation of this object.

Returns:

An explanation of this object.

StatusKind Arc::MCC_Status::getKind

(

)

const

Returns the status kind.

Returns the status kind of this object.

Returns:

The status kind of this object.

const std::string& Arc::MCC_Status::getOrigin

(

)

const

Returns the origin.

This method returns a string specifying the origin MCC of this object.

Returns:

A string specifying the origin MCC of this object.

bool Arc::MCC_Status::isOk

(

)

const

Is the status kind ok?

This method returns true if the status kind of this object is STATUS_OK

Returns:

true if kind==STATUS_OK

Referenced by operator bool(), and operator!().

Arc::MCC_Status::operator bool

(

void

)

const [inline]

Is the status kind ok?

This method returns true if the status kind of this object is STATUS_OK

Returns:

true if kind==STATUS_OK

References isOk().

Arc::MCC_Status::operator std::string

(

)

const

Conversion to string.

This operator converts a MCC_Status object to a string.

bool Arc::MCC_Status::operator!

(

void

)

const [inline]

not operator

Returns true if the status kind is not OK

Returns:

true if kind!=STATUS_OK

References isOk().

---

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

• MCC_Status.h