OFFIS DCMTK  Version 3.6.0
Public Member Functions | Private Member Functions | Private Attributes | List of all members
OFConditionString Class Reference

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

Inheritance diagram for OFConditionString:
[legend]
Collaboration diagram for OFConditionString:
[legend]

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 OFConditionBaseclone () 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

OFConditionStringoperator= (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
aModulemodule identifier. 0 is reserved for global codes, other constants are defined elsewhere.
aCodestatus code that is unique for each module
aStatuscondition status enum
aTexterror text. The text is copied.

Definition at line 235 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 Thu Dec 20 2012 for OFFIS DCMTK Version 3.6.0 by Doxygen 1.8.2