DcmUniqueIdentifier Class Reference

a class representing the DICOM value representation 'Unique Identifier' (UI) More...

Inheritance diagram for DcmUniqueIdentifier:

DcmByteString DcmElement DcmObject List of all members.

Public Member Functions

 DcmUniqueIdentifier (const DcmTag &tag, const Uint32 len=0)
 constructor.
 DcmUniqueIdentifier (const DcmUniqueIdentifier &old)
 copy constructor
virtual ~DcmUniqueIdentifier ()
 destructor
DcmUniqueIdentifieroperator= (const DcmUniqueIdentifier &obj)
 assignment operator
virtual DcmObjectclone () 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 void print (STD_NAMESPACE ostream &out, const size_t flags=0, const int level=0, const char *pixelFileName=NULL, size_t *pixelCounter=NULL)
 print element to a stream.
virtual OFCondition putString (const char *stringVal)
 set element value from the given character string.

Static Public Member Functions

static OFCondition checkStringValue (const OFString &value, const OFString &vm="1-n")
 check whether given string value conforms to the VR "UI" (Unique Identifier) and to the specified VM.

Protected Member Functions

virtual OFCondition makeMachineByteString ()
 convert currently stored string value to internal representation.

Detailed Description

a class representing the DICOM value representation 'Unique Identifier' (UI)

Definition at line 39 of file dcvrui.h.


Constructor & Destructor Documentation

DcmUniqueIdentifier::DcmUniqueIdentifier ( 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().

DcmUniqueIdentifier::DcmUniqueIdentifier ( const DcmUniqueIdentifier old  ) 

copy constructor

Parameters:
old element to be copied


Member Function Documentation

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

assignment operator

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

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

clone method

Returns:
deep copy of this object

Reimplemented from DcmByteString.

Definition at line 71 of file dcvrui.h.

References DcmUniqueIdentifier().

virtual OFCondition DcmUniqueIdentifier::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 DcmEVR DcmUniqueIdentifier::ident (  )  const [virtual]

get element type identifier

Returns:
type identifier of this class (EVR_UI)

Reimplemented from DcmByteString.

virtual OFCondition DcmUniqueIdentifier::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. (valid values: "1", "1-2", "1-3", "1-8", "1-99", "1-n", "2", "2-n", "2-2n", "3", "3-n", "3-3n", "4", "6", "9", "16", "32")
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.

virtual void DcmUniqueIdentifier::print ( STD_NAMESPACE ostream &  out,
const size_t  flags = 0,
const int  level = 0,
const char *  pixelFileName = NULL,
size_t *  pixelCounter = NULL 
) [virtual]

print element to a stream.

The output format of the value is a backslash separated sequence of string components. In case of a single component the UID number is mapped to the corresponding UID name (using "dcmFindNameOfUID()") if available. A "=" is used as a prefix to distinguish the UID name from the UID number. NB: this mapping of UID names only works for single-valued strings.

Parameters:
out output stream
flags optional flag used to customize the output (see DCMTypes::PF_xxx)
level current level of nested items. Used for indentation.
pixelFileName not used
pixelCounter not used

Reimplemented from DcmByteString.

virtual OFCondition DcmUniqueIdentifier::putString ( const char *  stringVal  )  [virtual]

set element value from the given character string.

If the string starts with a "=" the subsequent characters are interpreted as a UID name and mapped to the corresponding UID number (using "dcmFindUIDFromName()") if possible. Otherwise the leading "=" is removed. NB: this mapping of UID names only works for single-valued input strings.

Parameters:
stringVal input character string (possibly multi-valued)
Returns:
status, EC_Normal if successful, an error code otherwise

Reimplemented from DcmByteString.

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

check whether given string value conforms to the VR "UI" (Unique Identifier) 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. (valid values: "1", "1-2", "1-3", "1-8", "1-99", "1-n", "2", "2-n", "2-2n", "3", "3-n", "3-3n", "4", "6", "9", "16", "32")
Returns:
status of the check, EC_Normal if value is correct, an error code otherwise

virtual OFCondition DcmUniqueIdentifier::makeMachineByteString (  )  [protected, virtual]

convert currently stored string value to internal representation.

It removes any leading, embedded and trailing space character and recomputes the string length. This manipulation attempts to correct problems with incorrectly encoded UIDs which have been observed in some images.

Returns:
status, EC_Normal if successful, an error code otherwise

Reimplemented from DcmByteString.


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


Generated on 6 Jan 2011 for OFFIS DCMTK Version 3.6.0 by Doxygen 1.5.1