this class is used to declare condition codes with user defined error messages. More...

Inheritance diagram for OFConditionString:

Collaboration diagram for OFConditionString:

Public Member Functions
	OFConditionString (unsigned short aModule, unsigned short aCode, OFStatus aStatus, const char *aText)
	constructor. More...

	OFConditionString (const OFConditionString &arg)
	copy constructor

virtual	~OFConditionString ()
	destructor

virtual const OFConditionBase *	clone () const
	this method returns a pointer to a OFConditionBase object containing a clone of this object. More...

virtual unsigned long	codeAndModule () const
	returns a combined code and module for this object. More...

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. More...

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. More...

OFBool	operator!= (const OFConditionBase &arg) const
	comparison operator, not equal. More...

Private Member Functions
OFConditionString &	operator= (const OFConditionString &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

OFString	theText
	condition description

Detailed Description

this class is used to declare condition codes with user defined error messages.

Definition at line 224 of file ofcond.h.

Constructor & Destructor Documentation

OFConditionString::OFConditionString	(	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 copied.

Definition at line 235 of file ofcond.h.

References theText.

virtual const OFConditionBase* OFConditionString::clone ( ) const

virtual

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

The clone is a deep copy allocated on the heap.

virtual unsigned long OFConditionString::codeAndModule ( ) const

virtual

returns a combined code and module for this object.

code is lower 16 bits, module is upper 16 bits

virtual OFBool OFConditionString::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: