OFCondition Class Reference

General purpose class for condition codes. More...

Public Member Functions
	OFCondition (unsigned short aModule, unsigned short aCode, OFStatus aStatus, const char *aText)
	constructor for condition code with text More...
	OFCondition (const OFConditionConst &aConst=EC_Normal)
	constructor for condition code from constant data More...
	OFCondition (const OFCondition &arg)
	copy constructor More...
	~OFCondition ()
	destructor
OFCondition &	operator= (const OFCondition &arg)
	copy assignment operator More...
unsigned short	module () const
	get the module identifier for this object. More...
unsigned short	code () const
	get the status code identifier for this object. More...
OFStatus	status () const
	get the error status this object represents. More...
const char *	text () const
	get a human readable text representation of this error code. More...
const OFConditionConst &	condition () const
	internal function only, don't use yourself. More...
OFBool	good () const
	check if the status is OK. More...
OFBool	bad () const
	check if the status is not OK, i.e. error or failure. More...
OFBool	operator== (const OFCondition &arg) const
	comparison operator. More...
OFBool	operator!= (const OFCondition &arg) const
	comparison operator. More...

Private Attributes
OFConditionConst	theCondition
	The condition information.
OFBool	ownsText
	Does theCondition.theText point to our own heap string which must be freed?

Detailed Description

General purpose class for condition codes.

Objects of this class can be efficiently passed by value. To make this possible, the contained string is not copied when possible.

Constructor & Destructor Documentation

OFCondition() [1/3]

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

inline

constructor for condition code with text

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.

OFCondition() [2/3]

OFCondition::OFCondition ( const OFConditionConst &  aConst = EC_Normal )

inline

constructor for condition code from constant data

Parameters

aConst

OFConditionConst to use

OFCondition() [3/3]

OFCondition::OFCondition ( const OFCondition &  arg )

inline

copy constructor

Parameters

arg	OFCondition to copy

Member Function Documentation

bad()

OFBool OFCondition::bad ( ) const

inline

check if the status is not OK, i.e. error or failure.

Returns

true if status is not OK, else false

References OF_ok.

Referenced by DcmIODUtil::writeSubSequence().

code()

unsigned short OFCondition::code ( ) const

inline

get the status code identifier for this object.

This uniquely identifies the error code within the module.

Returns

the status code identifier for this object.

See also

module()

condition()

const OFConditionConst& OFCondition::condition ( ) const

inline

internal function only, don't use yourself.

Returns

an equivalent OFConditionConst for this object.

Referenced by operator!=(), and operator==().

good()

OFBool OFCondition::good ( ) const

inline

check if the status is OK.

Returns

true if status is OK, else false

References OF_ok.

Referenced by CMR_SRNumericMeasurementValueWithUnits< T_Units, T_DefinedGroup >::checkMeasurementUnit(), DcmIODUtil::copyFromUint8Array(), DRTSearch::searchPropertyEqual< IOD, Item, type, arg2, argument2 >::operator()(), CMR_SRNumericMeasurementValueWithUnits< T_Units, T_DefinedGroup >::setMeasurementUnit(), CMR_SRNumericMeasurementValueWithUnits< T_Units, T_DefinedGroup >::setValue(), DcmIODImage<>::write(), DcmIODUtil::writeSingleItem(), and DcmIODUtil::writeSubSequence().

module()

unsigned short OFCondition::module ( ) const

inline

get the module identifier for this object.

Returns

the module identifier for this object.

See also

code()

operator!=()

OFBool OFCondition::operator!= ( const OFCondition &  arg ) const

inline

comparison operator.

Compares status, code and module but not error text.

Parameters

arg	error to compare to

Returns

true if equal, false otherwise

References theCondition.

operator=()

OFCondition& OFCondition::operator= ( const OFCondition &  arg )

inline

copy assignment operator

Parameters

arg	The OFCondition instance to copy

Returns

*this

operator==()

OFBool OFCondition::operator== ( const OFCondition &  arg ) const

inline

comparison operator.

Compares status, code and module but not error text.

Parameters

arg	error to compare to

Returns

true if equal, false otherwise

References theCondition.

status()

OFStatus OFCondition::status ( ) const

inline

get the error status this object represents.

Returns

the status for this object.

text()

const char* OFCondition::text ( ) const

inline

get a human readable text representation of this error code.

The returned string is owned by this OFCondition instance and must not be modified or freed.

Returns

the error message text for this object.

Referenced by DcmIODUtil::writeSubSequence().

---

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

• ofstd/include/dcmtk/ofstd/ofcond.h