a class representing the DICOM value representation 'Unlimited Text' (UT) More...
Inheritance diagram for DcmUnlimitedText:
Public Member Functions | |
| DcmUnlimitedText (const DcmTag &tag, const Uint32 len=0) | |
| constructor | |
| DcmUnlimitedText (const DcmUnlimitedText &old) | |
| copy constructor | |
| virtual | ~DcmUnlimitedText () |
| destructor | |
| DcmUnlimitedText & | operator= (const DcmUnlimitedText &obj) |
| copy assignment operator | |
| virtual DcmObject * | clone () const |
| clone method | |
| virtual OFCondition | copyFrom (const DcmObject &rhs) |
| Virtual object copying. | |
| virtual DcmEVR | ident () const |
| return identifier for this class. | |
| 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 particular components of the string value | |
| 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 "UT" (Unlimited Text) | |
Detailed Description
a class representing the DICOM value representation 'Unlimited Text' (UT)
Constructor & Destructor Documentation
| DcmUnlimitedText::DcmUnlimitedText | ( | const DcmTag & | tag, |
| const Uint32 | len = 0 |
||
| ) |
constructor
- Parameters:
-
tag attribute tag len length of the attribute value
| DcmUnlimitedText::DcmUnlimitedText | ( | const DcmUnlimitedText & | old | ) |
copy constructor
- Parameters:
-
old element to be copied
Member Function Documentation
| static OFCondition DcmUnlimitedText::checkStringValue | ( | const OFString & | value | ) | [static] |
check whether given string value conforms to the VR "UT" (Unlimited 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
| virtual OFCondition DcmUnlimitedText::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 DcmObject* DcmUnlimitedText::clone | ( | ) | const [inline, virtual] |
| virtual OFCondition DcmUnlimitedText::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 OFCondition DcmUnlimitedText::getOFString | ( | OFString & | stringVal, |
| const unsigned long | pos, | ||
| OFBool | normalize = OFTrue |
||
| ) | [virtual] |
get a particular components of the string value
- Parameters:
-
stringVal string variable in which the result value is stored pos not used since value multiplicity is always 1 normalize remove trailing spaces if OFTrue
- Returns:
- status, EC_Normal if successful, an error code otherwise
Reimplemented from DcmByteString.
| virtual OFCondition DcmUnlimitedText::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 DcmByteString.
| virtual unsigned long DcmUnlimitedText::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 DcmUnlimitedText::ident | ( | ) | const [virtual] |
return identifier for this class.
Every class derived from this class returns a unique value of type enum DcmEVR for this call. This is used as a "poor man's RTTI" to correctly identify instances derived from this class even on compilers not supporting RTTI.
- Returns:
- type identifier of this class
Reimplemented from DcmByteString.
| DcmUnlimitedText& DcmUnlimitedText::operator= | ( | const DcmUnlimitedText & | obj | ) |
copy assignment operator
- Parameters:
-
obj element to be copied
The documentation for this class was generated from the following file:
- dcmdata/include/dcmtk/dcmdata/dcvrut.h