DcmCodeString Class Reference

a class representing the DICOM value representation 'Code String' (CS) More...

Inheritance diagram for DcmCodeString:

DcmByteString DcmElement DcmObject List of all members.

Public Member Functions

 DcmCodeString (const DcmTag &tag, const Uint32 len=0)
 constructor.
 DcmCodeString (const DcmCodeString &old)
 copy constructor
virtual ~DcmCodeString ()
 destructor
DcmCodeString & operator= (const DcmCodeString &obj)
 assignment operator
virtual DcmObject * clone () const
 clone method
virtual DcmEVR ident () const
 get element type identifier
virtual OFCondition getOFString (OFString &stringVal, const unsigned long pos, OFBool normalize=OFTrue)
 get a copy of a particular string component

Static Public Member Functions

static OFBool checkVR (const OFString &value, size_t *pos=NULL, const OFBool checkLength=OFTrue)
 check whether given value conforms to value representation CS (Code String).

Detailed Description

a class representing the DICOM value representation 'Code String' (CS)

Definition at line 45 of file dcvrcs.h.

Constructor & Destructor Documentation

DcmCodeString::DcmCodeString (  const DcmTag &  tag,
const Uint32  len = 0
) 
 

constructor.

Create new element from given tag and length.

Parameters:
tag DICOM tag for the new element
len value length for the new element

Referenced by clone().

DcmCodeString::DcmCodeString (  const DcmCodeString &  old  ) 
 

copy constructor

Parameters:
old element to be copied

Member Function Documentation

static OFBool DcmCodeString::checkVR (  const OFString &  value,
size_t *  pos = NULL,
const OFBool  checkLength = OFTrue
)  [static]
 

check whether given value conforms to value representation CS (Code String).

Valid characters are: A-Z, 0-9, _ and ' ' (space). The maximum length is 16.

Parameters:
value string value to be checked
pos returns index of first invalid character (0..n-1) if not NULL. Points to trailing zero byte (eos) if value is valid.
checkLength check maximum length if OFTrue, ignore length if OFFalse
Returns:
OFTrue if value is valid, OFFalse otherwise

virtual DcmObject* DcmCodeString::clone (   )  const [inline, virtual]
 

clone method

Returns:
deep copy of this object

Reimplemented from DcmByteString.

Definition at line 77 of file dcvrcs.h.

References DcmCodeString().

virtual OFCondition DcmCodeString::getOFString (  OFString &  stringVal,
const unsigned long  pos,
OFBool  normalize = OFTrue
)  [virtual]
 

get a copy of a particular string component

Parameters:
stringVal variable in which the result value is stored
pos index of the value in case of multi-valued elements (0..vm-1)
normalize delete leading and trailing spaces if OFTrue
Returns:
status, EC_Normal if successful, an error code otherwise

Reimplemented from DcmByteString.

virtual DcmEVR DcmCodeString::ident (   )  const [virtual]
 

get element type identifier

Returns:
type identifier of this class (EVR_CS)

Reimplemented from DcmByteString.

DcmCodeString& DcmCodeString::operator= (  const DcmCodeString &  obj  ) 
 

assignment operator

Parameters:
obj element to be assigned/copied
Returns:
reference to this object

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