DcmIntegerString Class Reference

a class representing the DICOM value representation 'Integer String' (IS) More...

Inheritance diagram for DcmIntegerString:

DcmByteString DcmElement DcmObject List of all members.

Public Member Functions

 DcmIntegerString (const DcmTag &tag, const Uint32 len=0)
 constructor.
 DcmIntegerString (const DcmIntegerString &old)
 copy constructor
virtual ~DcmIntegerString ()
 destructor
DcmIntegerStringoperator= (const DcmIntegerString &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 OFCondition getSint32 (Sint32 &sintVal, const unsigned long pos=0)
 get particular integer value
virtual OFCondition getOFString (OFString &stringVal, const unsigned long pos, OFBool normalize=OFTrue)
 get a particular value as a 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 "IS" (Integer String) and to the specified VM.

Detailed Description

a class representing the DICOM value representation 'Integer String' (IS)

Definition at line 39 of file dcvris.h.


Constructor & Destructor Documentation

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

DcmIntegerString::DcmIntegerString ( const DcmIntegerString old  ) 

copy constructor

Parameters:
old element to be copied


Member Function Documentation

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

assignment operator

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

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

clone method

Returns:
deep copy of this object

Reimplemented from DcmByteString.

Definition at line 71 of file dcvris.h.

References DcmIntegerString().

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

get element type identifier

Returns:
type identifier of this class (EVR_IS)

Reimplemented from DcmByteString.

virtual OFCondition DcmIntegerString::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 OFCondition DcmIntegerString::getSint32 ( Sint32 &  sintVal,
const unsigned long  pos = 0 
) [virtual]

get particular integer value

Parameters:
sintVal reference to result variable
pos index of the value to be retrieved (0..vm-1)
Returns:
status status, EC_Normal if successful, an error code otherwise

Reimplemented from DcmElement.

virtual OFCondition DcmIntegerString::getOFString ( OFString stringVal,
const unsigned long  pos,
OFBool  normalize = OFTrue 
) [virtual]

get a particular value as a character string

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.

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

check whether given string value conforms to the VR "IS" (Integer 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. (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


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