DcmShortText Class Reference

a class representing the DICOM value representation 'Short Text' (ST) More...

Inheritance diagram for DcmShortText:

DcmCharString DcmByteString DcmElement DcmObject List of all members.

Public Member Functions

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

Detailed Description

a class representing the DICOM value representation 'Short Text' (ST)

Definition at line 45 of file dcvrst.h.

Constructor & Destructor Documentation

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

DcmShortText::DcmShortText (  const DcmShortText &  old  ) 
 

copy constructor

Parameters:
old element to be copied

Member Function Documentation

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

clone method

Returns:
deep copy of this object

Reimplemented from DcmCharString.

Definition at line 76 of file dcvrst.h.

References DcmShortText().

virtual OFCondition DcmShortText::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 OFCondition DcmShortText::getOFStringArray (  OFString &  stringVal,
OFBool  normalize = OFTrue
)  [virtual]
 

get the string value (all compenents)

Parameters:
stringVal string variable in which the result value is stored
normalize remove trailing spaces if OFTrue
Returns:
status, EC_Normal if successful, an error code otherwise

Reimplemented from DcmElement.

virtual unsigned long DcmShortText::getVM (   )  [virtual]
 

get the value multiplicity.

Since the backslash "\" is not regarded as a separator the value multiplicity is always 1.

Returns:
value multiplicity of the currently stored value

Reimplemented from DcmByteString.

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

get element type identifier

Returns:
type identifier of this class (EVR_ST)

Reimplemented from DcmByteString.

DcmShortText& DcmShortText::operator= (  const DcmShortText &  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