ExceptionsHelper Class Reference

#include <exceptionsHelper.h>

List of all members.

Public Member Functions
CAFEException_pv	prepareCAFEException_pv (const char *pv, const char *pvAlias, unsigned int handle, chid pCh, int status, const char *source, unsigned int ln)
	Populates the CAFEException_pv struct; precedes throw(e).
CAFEException_group	prepareCAFEException_group (char groupName[PVNAME_SIZE], unsigned int groupHandle, int statusCode, const char *source, unsigned int ln)
	Populates the CAFEException_group struct; precedes throw(e).
	ExceptionsHelper (void)
	~ExceptionsHelper (void)
void	printCAFEException_pv (CAFEException_pv &e)
	Prints CAFEException_pv to std out.
Private Attributes
CAFEDataTypeCode	cafeDataTypeCode
CAFEStatus	cafeStatus

---

Constructor & Destructor Documentation

ExceptionsHelper::ExceptionsHelper

(

void

)

[inline]

ExceptionsHelper::~ExceptionsHelper

(

void

)

[inline]

---

Member Function Documentation

CAFEException_group ExceptionsHelper::prepareCAFEException_group	(	char	groupName[PVNAME_SIZE],
		unsigned int	ghandle,
		int	status,
		const char *	source,
		unsigned int	ln
	)

Populates the CAFEException_group struct; precedes throw(e).

Parameters:

	groupName	input: name of group
	ghandle	input: group handle to reference object
	status	input: the error/status code
	source	input: method name
	ln	input: line number of file from where the error originates

Returns:

struct CAFEException_group

References cafeStatus, CAFEStatus::csc, CAFEStatus::csi, CAFEException_group::groupHandle, CAFEException_group::groupName, CAFEException_group::ln, CAFEStatusInfo::message(), CAFEStatusCode::message(), CAFEException_group::source, CAFEException_group::statusCode, CAFEException_group::statusCodeText, and CAFEException_group::statusMessage.

CAFEException_pv ExceptionsHelper::prepareCAFEException_pv	(	const char *	pv,
		const char *	pvAlias,
		unsigned int	handle,
		chid	pCh,
		int	status,
		const char *	source,
		unsigned int	ln
	)

Populates the CAFEException_pv struct; precedes throw(e).

Parameters:

	pv	input: process variable
	pvAlias	input: process variable alias
	handle	input: handle to reference object
	pCh	input: channel identifier (chid)
	status	input: the error/status code
	source	input: method name
	ln	input: line number of file from where the error originates

Returns:

struct CAFEException_pv

References CAFE_NO_ACCESS, CAFE_NOT_REQUESTED, cafeDataTypeCode, cafeStatus, CAFEStatus::csc, CAFEStatus::csi, CAFEException_pv::dataTypeNative, CAFEException_pv::dataTypeNativeText, ECAFE_RULE_FALSE, CAFEException_pv::handle, ICAFE_RULE_FALSE, CAFEException_pv::ln, CAFEStatusInfo::message(), CAFEStatusCode::message(), CAFEDataTypeCode::message(), CAFEException_pv::pv, CAFEException_pv::pvAlias, CAFEException_pv::source, CAFEException_pv::statusCode, CAFEException_pv::statusCodeText, and CAFEException_pv::statusMessage.

void ExceptionsHelper::printCAFEException_pv

(

CAFEException_pv &

e

)

Prints CAFEException_pv to std out.

Parameters:

e

input: struct CAFEException

References __METHOD__, CAFEException_pv::dataTypeNative, CAFEException_pv::dataTypeNativeText, CAFEException_pv::handle, CAFEException_pv::ln, CAFEException_pv::pv, CAFEException_pv::pvAlias, CAFEException_pv::source, CAFEException_pv::statusCode, CAFEException_pv::statusCodeText, and CAFEException_pv::statusMessage.

Referenced by Connect::printCAFEException_pv().

---

Member Data Documentation

CAFEDataTypeCode ExceptionsHelper::cafeDataTypeCode [private]

Referenced by prepareCAFEException_pv().

CAFEStatus ExceptionsHelper::cafeStatus [private]

Referenced by prepareCAFEException_group(), and prepareCAFEException_pv().

---

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

• exceptionsHelper.h
• exceptionsHelper.cpp