ito::RetVal Class Reference

Class for managing status values (like errors or warning) More...

#include <retVal.h>

List of all members.

Public Member Functions
	RetVal ()
	default constructor that creates a RetVal with status ito::retOk, code 0 and no message.
	RetVal (tRetValue retValue)
	default constructor that creates a RetVal with the status given by retValue, code 0 and no message.
	RetVal (int retValue)
	default constructor that creates a RetVal with the status given by retValue, code 0 and no message.
	RetVal (ito::tRetValue retValue, int retCode, const char *pRetMessage)
	~RetVal ()
	destructor
RetVal &	operator= (const RetVal &rhs)
RetVal &	operator+= (const RetVal &rhs)
RetVal	operator+ (const RetVal &rhs)
char	operator== (const RetVal &rhs)
char	operator!= (const RetVal &rhs)
char	operator== (const tRetValue rhs)
char	operator!= (const tRetValue rhs)
void	appendRetMessage (const char *addRetMessage)
int	containsWarning () const
int	containsError () const
int	containsWarningOrError () const
bool	hasErrorMessage () const
int	errorCode () const
const char *	errorMessage () const
Static Public Member Functions
static RetVal	format (ito::tRetValue retValue, int retCode, const char *pRetMessage,...)
	create RetVal with message that may contain placeholders using the formalism of the default sprintf method.
Private Attributes
tRetValue	m_retValue
int	m_retCode
ByteArray	m_retMessage

---

Detailed Description

Class for managing status values (like errors or warning)

The RetVal class is used for handling return codes. All classes should use this class. In case an error occurs, only the first error is stored and will not be overridden by potentially subsequent occurring errors. An error is more severe than a warning and will overwrite a warning if it is added to an existing RetVal.

---

Constructor & Destructor Documentation

ito::RetVal::RetVal	(	ito::tRetValue	retValue,
		int	retCode,
		const char *	pRetMessage
	)

constructor with retValue, retCode and errorMessage

Parameters:

[in]	retValue	type of RetVal; for possible values see tRetValue
[in]	retCode	user definable return code
[in]	pRetMessage	error message to be passed or NULL, string is copied Makes a deep copy of RetVal, i.e. a copy of the error message

---

Member Function Documentation

int ito::RetVal::containsError

(

)

const [inline]

check if any error has occurred in this return value (true), else (false)

int ito::RetVal::containsWarning

(

)

const [inline]

check if any warning has occurred in this return value (true), else (false)

int ito::RetVal::containsWarningOrError

(

)

const [inline]

check if any warning or error has occurred in this return value (true), else (false)

int ito::RetVal::errorCode

(

)

const [inline]

return the error code (default: 0)

const char* ito::RetVal::errorMessage

(

)

const [inline]

return zero-terminated error message or empty, zero-terminated string if no error message has been set

RetVal ito::RetVal::format	(	ito::tRetValue	retValue,
		int	retCode,
		const char *	pRetMessage,
			...
	)		[static]

create RetVal with message that may contain placeholders using the formalism of the default sprintf method.

Parameters:

retValue	is the type of RetVal (retOk, retWarning, retError)
retCode	is the code number of RetVal
pRetMessage	is the zero-terminated message string that may contain placeholders like s, i, ... (see sprintf)
...	are further arguments. Their number and type must correspond to the placeholders in pRetMessage

Returns:

created RetVal

bool ito::RetVal::hasErrorMessage

(

)

const [inline]

return true if an error or warning message is available

char ito::RetVal::operator!=

(

const RetVal &

rhs

)

[inline]

unequality operator compares retValue with with retValue of rhs RetVal. For possible constant values see tRetValue

char ito::RetVal::operator!=

(

const tRetValue

rhs

)

[inline]

unequality operator compares retValue with tRetValue constant. For possible constant values see tRetValue

RetVal ito::RetVal::operator+

(

const RetVal &

rhs

)

[inline]

Concatenation of RetVal See operator RetVal::operator+=

RetVal & ito::RetVal::operator+=

(

const RetVal &

rhs

)

Concatenation of RetVal "Adds" RetVals, i.e. returns the most serious error. In case of equally serious errors the first is retained

RetVal & ito::RetVal::operator=

(

const RetVal &

rhs

)

assignment operator, copies values of rhs to current RetVal. Before copiing current errorMessage is freed

char ito::RetVal::operator==

(

const RetVal &

rhs

)

[inline]

equality operator compares retValue with with retValue of rhs RetVal. For possible constant values see tRetValue

char ito::RetVal::operator==

(

const tRetValue

rhs

)

[inline]

equality operator compares retValue with tRetValue constant. For possible constant values see tRetValue

---

Member Data Documentation

int ito::RetVal::m_retCode [private]

the error code itself

ByteArray ito::RetVal::m_retMessage [private]

message of this RetVal using ByteArray (using implicit sharing)

tRetValue ito::RetVal::m_retValue [private]

can be one of enumeration tLogLevel values or an or-combination of these values

---

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

• K:/git-itom/sources/itom/common/retVal.h
• K:/git-itom/sources/itom/common/sources/retVal.cpp