OFConditionString Class Reference

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

Inheritance diagram for OFConditionString:

OFConditionBase List of all members.

Public Member Functions

 OFConditionString (unsigned short aModule, unsigned short aCode, OFStatus aStatus, const char *aText)
 constructor.
 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.
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.

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 228 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 239 of file ofcond.h.

References theText.

Member Function Documentation

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.

Returns:
deep copy of this object

Implements OFConditionBase.

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

Implements OFConditionBase.

virtual OFBool OFConditionString::deletable (   )  const [virtual]
 

checks if this object is deletable, e.g.

all instances of this class are allocated on the heap.

Returns:
true if deletable, false otherwise

Implements OFConditionBase.

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

Generated on 20 Dec 2005 for OFFIS DCMTK Version 3.5.4 by Doxygen 1.4.5