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
DcmShortTextoperator= (const DcmShortText &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="", const OFBool oldFormat=OFFalse)
 check whether stored value conforms to the VR and to the specified VM
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)

Static Public Member Functions

static OFCondition checkStringValue (const OFString &value)
 check whether given string value conforms to the VR "ST" (Short Text)

Detailed Description

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

Definition at line 40 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

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

assignment operator

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

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

clone method

Returns:
deep copy of this object

Reimplemented from DcmCharString.

Definition at line 71 of file dcvrst.h.

References DcmShortText().

virtual OFCondition DcmShortText::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 DcmCharString.

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

get element type identifier

Returns:
type identifier of this class (EVR_ST)

Reimplemented from DcmByteString.

virtual OFCondition DcmShortText::checkValue ( const OFString vm = "",
const OFBool  oldFormat = OFFalse 
) [virtual]

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

Parameters:
vm parameter not used for this VR
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 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 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.

static OFCondition DcmShortText::checkStringValue ( const OFString value  )  [static]

check whether given string value conforms to the VR "ST" (Short Text)

Parameters:
value string value to be checked (possibly multi-valued)
Returns:
status of the check, EC_Normal if value is correct, an error code otherwise


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