ECapeUser Class Reference

#include <CapeException.hpp>

Inheritance diagram for ECapeUser:

List of all members.

Public Member Functions
	ECapeUser ()
	ECapeUser (ExceptionCode _code, Common::Types::CapeString _description=Common::Types::CapeStringUNDEFINED, Common::Types::CapeString _scope=Common::Types::CapeStringUNDEFINED, Common::Types::CapeString _interfaceName=Common::Types::CapeStringUNDEFINED, Common::Types::CapeString _operation=Common::Types::CapeStringUNDEFINED, Common::Types::CapeURL _moreInfo=Common::Types::CapeStringUNDEFINED)
Public Attributes
ExceptionCode	code
Common::Types::CapeString	description
Common::Types::CapeString	scope
Common::Types::CapeString	interfaceName
Common::Types::CapeString	operation
Common::Types::CapeURL	moreInfo
Friends
std::ostream &	operator<< (std::ostream &os, const ECapeUser &exc)

---

Detailed Description

The base class of the CO errors hierarchy. It defines the minimum state of a CO error. This is an abstract class. No real error can be raised from this class.

---

Constructor & Destructor Documentation

ECapeUser

(

)

Constructor (does nothing).

ECapeUser	(	ExceptionCode	_code,
		Common::Types::CapeString	_description = Common::Types::CapeStringUNDEFINED,
		Common::Types::CapeString	_scope = Common::Types::CapeStringUNDEFINED,
		Common::Types::CapeString	_interfaceName = Common::Types::CapeStringUNDEFINED,
		Common::Types::CapeString	_operation = Common::Types::CapeStringUNDEFINED,
		Common::Types::CapeURL	_moreInfo = Common::Types::CapeStringUNDEFINED
	)

Constructor with default arguments. Not defined in Python.

---

Friends And Related Function Documentation

std::ostream& operator<<	(	std::ostream &	os,
		const ECapeUser &	exc
	)		[friend]

ostream output operator for the ECapeUser class.

---

Member Data Documentation

ExceptionCode code

Code to designate the subcategory of the error. The assignment of values is left to each implementation. So that is a proprietary code specific to the CO component provider.

Referenced by DianaContinuation::calcTangentVector(), HopfPointContinuation::Continuate(), SingAnalyser::Continuate(), SingAnalyser::GetVariableName(), HopfPointContinuation::Solve(), and SingAnalyser::Solve().

Common::Types::CapeString description

The description of the error.

Referenced by DianaContinuation::calcTangentVector(), HopfPointContinuation::Continuate(), SingAnalyser::Continuate(), SingAnalyser::GetVariableName(), HopfPointContinuation::Solve(), and SingAnalyser::Solve().

Common::Types::CapeString interfaceName

The name of the interface where the error is thrown. This is a mandatory field.

Referenced by DianaContinuation::calcTangentVector(), HopfPointContinuation::Continuate(), SingAnalyser::Continuate(), SingAnalyser::GetVariableName(), HopfPointContinuation::Solve(), and SingAnalyser::Solve().

Common::Types::CapeURL moreInfo

An URL to a page, document, web site, & where more information on the error can be found. The content of this information is obviously implementation dependent.

Referenced by DianaContinuation::calcTangentVector(), HopfPointContinuation::Continuate(), SingAnalyser::Continuate(), SingAnalyser::GetVariableName(), HopfPointContinuation::Solve(), and SingAnalyser::Solve().

Common::Types::CapeString operation

The name of the operation where the error is thrown. This is a mandatory field.

Referenced by DianaContinuation::calcTangentVector(), HopfPointContinuation::Continuate(), SingAnalyser::Continuate(), SingAnalyser::GetVariableName(), HopfPointContinuation::Solve(), and SingAnalyser::Solve().

Common::Types::CapeString scope

The scope of the error. The list of packages where the error occurs separated by "::". For example CapeOpen::Common::Identification.

Referenced by DianaContinuation::calcTangentVector(), HopfPointContinuation::Continuate(), SingAnalyser::Continuate(), SingAnalyser::GetVariableName(), HopfPointContinuation::Solve(), and SingAnalyser::Solve().

---

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

• CapeException.hpp