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
DcmUniqueIdentifier & operator= (const DcmUniqueIdentifier &obj)
 assignment operator
virtual DcmObject * clone () const
 clone method
virtual DcmEVR ident () const
 get element type identifier
virtual void print (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.

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 44 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

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

clone method

Returns:
deep copy of this object

Reimplemented from DcmByteString.

Definition at line 76 of file dcvrui.h.

References DcmUniqueIdentifier().

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

get element type identifier

Returns:
type identifier of this class (EVR_UI)

Reimplemented from DcmByteString.

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.

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

assignment operator

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

virtual void DcmUniqueIdentifier::print (  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.

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