CException wrapper for XIA return codes containing the return code and context message of the error. More...

#include <CXIAException.h>

Inheritance diagram for CXIAException:

Collaboration diagram for CXIAException:

Public Member Functions
	CXIAException (std::string msg, std::string fcn, int rv)
	Constructor from arguments. More...

virtual	~CXIAException ()
	Destructor. Nothing to do here. More...

virtual int	ReasonCode () const
	Get the reason code. More...

virtual const char *	ReasonText () const
	Get the return text. More...

Detailed Description

CException wrapper for XIA return codes containing the return code and context message of the error.

XIA API major version 4 and later implement a return code and context message for non-zero return values from API functions. This class provides a wrapper for that business using the CException class:

m_reasonCode holds the XIA API return value,
The XIA API return value is used to generate an XIA API context message for that error,
m_szAction holds some additional user-provided context message (passed to the CException constructor as-is). The full error message incorporating the XIA API return code and its associated context message as well as the user-provided context can be accessed using the class' ReasonText() method. The value of the return code can be accessed using the ReasonCode() method.

Constructor & Destructor Documentation

◆ CXIAException()

CXIAException::CXIAException	(	std::string	msg,
		std::string	fcn,
		int	rv
	)

Constructor from arguments.

Parameters

msg	User context message for the error.
fcn	XIA API function name.
rv	XIA API function return value.

Get the XIA API error message from the passed return value and construct the full error message.

◆ ~CXIAException()

virtual CXIAException::~CXIAException ( )

inlinevirtual

Destructor. Nothing to do here.

Member Function Documentation

◆ ReasonCode()

int CXIAException::ReasonCode ( ) const

virtual

Get the reason code.

Returns: The reason code: non-zero return value from the XIA API.

◆ ReasonText()

const char * CXIAException::ReasonText ( ) const