Inheritance diagram for DSRStringValue:
Public Member Functions | |
| DSRStringValue () | |
| default contructor | |
| DSRStringValue (const OFString &stringValue) | |
| constructor The string value is only set if it passed the validity check (see setValue()). | |
| DSRStringValue (const DSRStringValue &stringValue) | |
| copy constructor | |
| virtual | ~DSRStringValue () |
| destructor | |
| DSRStringValue & | operator= (const DSRStringValue &stringValue) |
| assignment operator | |
| virtual void | clear () |
| clear all internal variables. | |
| virtual OFBool | isValid () const |
| check whether the current code is valid. | |
| void | print (STD_NAMESPACE ostream &stream, const size_t maxLength=0) const |
| print string value. | |
| OFCondition | read (DcmItem &dataset, const DcmTagKey &tagKey) |
| read string value from dataset. | |
| OFCondition | write (DcmItem &dataset, const DcmTagKey &tagKey) const |
| write string value to dataset | |
| OFCondition | readXML (const DSRXMLDocument &doc, DSRXMLCursor cursor, const OFBool encoding=OFFalse) |
| read string value from XML document | |
| OFCondition | renderHTML (STD_NAMESPACE ostream &docStream, const size_t flags) const |
| render string value in HTML/XHTML format | |
| const OFString & | getValue () const |
| get string value | |
| OFCondition | setValue (const OFString &stringValue) |
| set string value. | |
Protected Member Functions | |
| virtual OFBool | checkValue (const OFString &stringValue) const |
| check the specified string value for validity. | |
Private Attributes | |
| OFString | Value |
| string value (various VRs, mandatory) | |
Definition at line 47 of file dsrstrvl.h.
| DSRStringValue::DSRStringValue | ( | const OFString & | stringValue | ) |
constructor The string value is only set if it passed the validity check (see setValue()).
| stringValue | string value to be set |
| DSRStringValue::DSRStringValue | ( | const DSRStringValue & | stringValue | ) |
copy constructor
| stringValue | string value to be copied (not checked !) |
| DSRStringValue& DSRStringValue::operator= | ( | const DSRStringValue & | stringValue | ) |
assignment operator
| stringValue | string value to be copied (not checked !) |
| virtual void DSRStringValue::clear | ( | ) | [virtual] |
clear all internal variables.
Please note that the string value might become invalid afterwards.
Reimplemented in DSRDateTreeNode, DSRDateTimeTreeNode, DSRPNameTreeNode, DSRTextTreeNode, DSRTimeTreeNode, and DSRUIDRefTreeNode.
| virtual OFBool DSRStringValue::isValid | ( | ) | const [virtual] |
check whether the current code is valid.
See checkValue() for details.
Reimplemented in DSRDateTreeNode, DSRDateTimeTreeNode, DSRPNameTreeNode, DSRTextTreeNode, DSRTimeTreeNode, and DSRUIDRefTreeNode.
| void DSRStringValue::print | ( | STD_NAMESPACE ostream & | stream, | |
| const size_t | maxLength = 0 | |||
| ) | const |
print string value.
The output of a typical string value looks like this: "Short text" or "Very long t..." (incl. the quotation marks).
| stream | output stream to which the string value should be printed | |
| maxLength | maximum number of characters to be printed. If the string value is longer the output is shortened automatically and three dots "..." are added. The value of 'maxLength' includes these three trailing char's. A value of 0 turns this meachanism off (default), i.e. the full string value is printed. |
Reimplemented in DSRDateTreeNode, DSRDateTimeTreeNode, DSRPNameTreeNode, DSRTextTreeNode, DSRTimeTreeNode, and DSRUIDRefTreeNode.
| OFCondition DSRStringValue::read | ( | DcmItem & | dataset, | |
| const DcmTagKey & | tagKey | |||
| ) |
read string value from dataset.
If error/warning output is enabled a warning message is printed if the string value does not conform with the type (= 1) and value multiplicity (= 1).
| dataset | DICOM dataset from which the string value should be read | |
| tagKey | DICOM tag specifying the attribute which should be read |
| OFCondition DSRStringValue::write | ( | DcmItem & | dataset, | |
| const DcmTagKey & | tagKey | |||
| ) | const |
write string value to dataset
| dataset | DICOM dataset to which the string value should be written | |
| tagKey | DICOM tag specifying the attribute which should be written |
| OFCondition DSRStringValue::readXML | ( | const DSRXMLDocument & | doc, | |
| DSRXMLCursor | cursor, | |||
| const OFBool | encoding = OFFalse | |||
| ) |
read string value from XML document
| doc | document containing the XML file content | |
| cursor | cursor pointing to the starting node | |
| encoding | use encoding handler if OFTrue, ignore character set otherwise |
| OFCondition DSRStringValue::renderHTML | ( | STD_NAMESPACE ostream & | docStream, | |
| const size_t | flags | |||
| ) | const |
render string value in HTML/XHTML format
| docStream | output stream to which the main HTML/XHTML document is written | |
| flags | flag used to customize the output (see DSRTypes::HF_xxx) |
| const OFString& DSRStringValue::getValue | ( | ) | const [inline] |
get string value
Definition at line 140 of file dsrstrvl.h.
References Value.
| OFCondition DSRStringValue::setValue | ( | const OFString & | stringValue | ) |
set string value.
Before setting the string value it is checked (see checkValue()). If the value is invalid the current value is not replaced and remains unchanged. Use clear() to empty the string value (which becomes invalid afterwards).
| stringValue | value to be set |
| virtual OFBool DSRStringValue::checkValue | ( | const OFString & | stringValue | ) | const [protected, virtual] |
check the specified string value for validity.
This base class just checks that the string value is not empty (since all corresponding DICOM attributes are type 1). Derived classes might overwrite this method to perform more sophisticated tests.
| stringValue | string value to be checked |