DSRStringValue Class Reference

Class for string values. More...

Inheritance diagram for DSRStringValue:

DSRDateTimeTreeNode DSRDateTreeNode DSRPNameTreeNode DSRTextTreeNode DSRTimeTreeNode DSRUIDRefTreeNode List of all members.

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 (ostream &stream, const size_t maxLength=0) const
 print string value.
OFCondition read (DcmItem &dataset, const DcmTagKey &tagKey, OFConsole *logStream)
 read string value from dataset.
OFCondition write (DcmItem &dataset, const DcmTagKey &tagKey, OFConsole *logStream) 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 (ostream &docStream, const size_t flags, OFConsole *logStream) const
 render string value in HTML format
const OFString & getValue () const
 get string value
OFCondition setValue (const OFString &stringValue)
 set string value.
OFBool valueContainsExtendedCharacters () const
 check if this value contains non-ASCII characters.

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)

Detailed Description

Class for string values.

Definition at line 51 of file dsrstrvl.h.

Constructor & Destructor Documentation

DSRStringValue::DSRStringValue (  const OFString &  stringValue  ) 
 

constructor The string value is only set if it passed the validity check (see setValue()).

Parameters:
stringValue string value to be set

DSRStringValue::DSRStringValue (  const DSRStringValue &  stringValue  ) 
 

copy constructor

Parameters:
stringValue string value to be copied (not checked !)

Member Function Documentation

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.

Parameters:
stringValue string value to be checked
Returns:
OFTrue if code is valid, OFFalse otherwise

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.

const OFString& DSRStringValue::getValue (   )  const [inline]
 

get string value

Returns:
reference to string value

Definition at line 150 of file dsrstrvl.h.

References Value.

virtual OFBool DSRStringValue::isValid (   )  const [virtual]
 

check whether the current code is valid.

See checkValue() for details.

Returns:
OFTrue if code is valid, OFFalse otherwise

Reimplemented in DSRDateTreeNode, DSRDateTimeTreeNode, DSRPNameTreeNode, DSRTextTreeNode, DSRTimeTreeNode, and DSRUIDRefTreeNode.

DSRStringValue& DSRStringValue::operator= (  const DSRStringValue &  stringValue  ) 
 

assignment operator

Parameters:
stringValue string value to be copied (not checked !)
Returns:
reference to this string value after 'stringValue' has been copied

void DSRStringValue::print (  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).

Parameters:
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,
OFConsole *  logStream
) 
 

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).

Parameters:
dataset DICOM dataset from which the string value should be read
tagKey DICOM tag specifying the attribute which should be read
logStream pointer to error/warning output stream (output disabled if NULL)
Returns:
status, EC_Normal if successful, an error code otherwise

OFCondition DSRStringValue::readXML (  const DSRXMLDocument &  doc,
DSRXMLCursor  cursor,
const OFBool  encoding = OFFalse
) 
 

read string value from XML document

Parameters:
doc document containing the XML file content
cursor cursor pointing to the starting node
encoding use encoding handler if OFTrue, ignore character set otherwise
Returns:
status, EC_Normal if successful, an error code otherwise

OFCondition DSRStringValue::renderHTML (  ostream &  docStream,
const size_t  flags,
OFConsole *  logStream
)  const
 

render string value in HTML format

Parameters:
docStream output stream to which the main HTML document is written
flags flag used to customize the output (see DSRTypes::HF_xxx)
logStream pointer to error/warning output stream (output disabled if NULL)
Returns:
status, EC_Normal if successful, an error code otherwise

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).

Parameters:
stringValue value to be set
Returns:
status, EC_Normal if successful, an error code otherwise

OFBool DSRStringValue::valueContainsExtendedCharacters (   )  const
 

check if this value contains non-ASCII characters.

Returns:
true if value contains non-ASCII characters, false otherwise

OFCondition DSRStringValue::write (  DcmItem &  dataset,
const DcmTagKey &  tagKey,
OFConsole *  logStream
)  const
 

write string value to dataset

Parameters:
dataset DICOM dataset to which the string value should be written
tagKey DICOM tag specifying the attribute which should be written
logStream pointer to error/warning output stream (output disabled if NULL)
Returns:
status, EC_Normal if successful, an error code otherwise

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