DcmCodeString Class Reference

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

Inheritance diagram for DcmCodeString:

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 OFCondition	copyFrom (const DcmObject &rhs)
	Virtual object copying.
virtual DcmEVR	ident () const
	get element type identifier
virtual OFCondition	checkValue (const OFString &vm="1-n", const OFBool oldFormat=OFFalse)
	check whether stored value conforms to the VR and to the specified VM
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).
static OFCondition	checkStringValue (const OFString &value, const OFString &vm="1-n")
	check whether given string value conforms to the VR "CS" (Code String) and to the specified VM.

---

Detailed Description

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

---

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

DcmCodeString::DcmCodeString

(

const DcmCodeString &

old

)

copy constructor

Parameters:

old	element to be copied

---

Member Function Documentation

static OFCondition DcmCodeString::checkStringValue	(	const OFString &	value,
		const OFString &	vm = "1-n"
	)		[static]

check whether given string value conforms to the VR "CS" (Code String) and to the specified VM.

Parameters:

value	string value to be checked (possibly multi-valued)
vm	value multiplicity (according to the data dictionary) to be checked for. (See DcmElement::checkVM() for a list of valid values.)

Returns:

status of the check, EC_Normal if value is correct, an error code otherwise

virtual OFCondition DcmCodeString::checkValue	(	const OFString &	vm = "1-n",
		const OFBool	oldFormat = OFFalse
	)		[virtual]

check whether stored value conforms to the VR and to the specified VM

Parameters:

vm	value multiplicity (according to the data dictionary) to be checked for. (See DcmElement::checkVM() for a list of valid values.)
oldFormat	parameter not used for this VR (only for DA, TM, PN)

Returns:

status of the check, EC_Normal if value is correct, an error code otherwise

Reimplemented from DcmElement.

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. NB: This method is only used by the DicomDirInterface class and might be replaced by the following method (checkStringValue) in the future.

Parameters:

value	string value to be checked (single value only)
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.

virtual OFCondition DcmCodeString::copyFrom

(

const DcmObject &

rhs

)

[virtual]

Virtual object copying.

This method can be used for DcmObject and derived classes to get a deep copy of an object. Internally the assignment operator is called if the given DcmObject parameter is of the same type as "this" object instance. If not, an error is returned. This function permits copying an object by value in a virtual way which therefore is different to just calling the assignment operator of DcmElement which could result in slicing the object.

Parameters:

rhs	- [in] The instance to copy from. Has to be of the same class type as "this" object

Returns:

EC_Normal if copying was successful, error otherwise

Reimplemented from DcmByteString.

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:

• dcmdata/include/dcmtk/dcmdata/dcvrcs.h