this class is used to declare global condition constants. More...

Inheritance diagram for OFConditionConst:

Collaboration diagram for OFConditionConst:

Public Member Functions
	OFConditionConst (unsigned short aModule, unsigned short aCode, OFStatus aStatus, const char *aText)
	constructor.
	OFConditionConst (const OFConditionConst &arg)
	copy constructor
virtual	~OFConditionConst ()
	destructor
virtual const OFConditionBase *	clone () const
	this method returns a pointer to a OFConditionBase object containing a clone of this object.
virtual unsigned long	codeAndModule () const
	returns a combined code and module for this object.
virtual OFStatus	status () const
	returns the status for this object.
virtual const char *	text () const
	returns the error message text for this object.
virtual OFBool	deletable () const
	checks if this object is deletable, e.g.
Public Member Functions inherited from OFConditionBase
	OFConditionBase ()
	default constructor
	OFConditionBase (const OFConditionBase &)
	copy constructor
virtual	~OFConditionBase ()
	destructor
unsigned short	module () const
	returns the module identifier for this object.
unsigned short	code () const
	returns the status code identifier for this object.
OFBool	operator== (const OFConditionBase &arg) const
	comparison operator.
OFBool	operator!= (const OFConditionBase &arg) const
	comparison operator, not equal.

Private Member Functions
OFConditionConst &	operator= (const OFConditionConst &arg)
	private undefined copy assignment operator

Private Attributes
unsigned long	theCodeAndModule
	code/module identification. Code is lower 16 bits, module is upper 16 bits
OFStatus	theStatus
	status
const char *	theText
	condition description

Detailed Description

this class is used to declare global condition constants.

OFError instances may keep multiple aliased pointers to an instance of this class. Therefore, instances should be global constants.

Definition at line 146 of file ofcond.h.

Constructor & Destructor Documentation

OFConditionConst::OFConditionConst	(	unsigned short	aModule,
		unsigned short	aCode,
		OFStatus	aStatus,
		const char *	aText
	)

inline

constructor.

Parameters

aModule	module identifier. 0 is reserved for global codes, other constants are defined elsewhere.
aCode	status code that is unique for each module
aStatus	condition status enum
aText	error text. The text is not copied, so the pointer must remain valid for the full lifetime of this object.

Definition at line 158 of file ofcond.h.

virtual const OFConditionBase* OFConditionConst::clone ( ) const

virtual

this method returns a pointer to a OFConditionBase object containing a clone of this object.

In this case, deletable() is false and clone just returns a pointer to this.

virtual unsigned long OFConditionConst::codeAndModule ( ) const

virtual

returns a combined code and module for this object.

code is lower 16 bits, module is upper 16 bits

virtual OFBool OFConditionConst::deletable ( ) const

virtual

checks if this object is deletable, e.g.

all instances of this class are allocated on the heap.

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