OFFIS DCMTK  Version 3.6.0
Public Member Functions | Protected Member Functions | Protected Attributes | Friends | List of all members
DSRCompositeReferenceValue Class Reference

Class for composite reference values. More...

Inheritance diagram for DSRCompositeReferenceValue:
[legend]
Collaboration diagram for DSRCompositeReferenceValue:
[legend]

Public Member Functions

 DSRCompositeReferenceValue ()
 default contructor
 
 DSRCompositeReferenceValue (const OFString &sopClassUID, const OFString &sopInstanceUID)
 constructor.
 
 DSRCompositeReferenceValue (const DSRCompositeReferenceValue &referenceValue)
 copy constructor
 
virtual ~DSRCompositeReferenceValue ()
 destructor
 
DSRCompositeReferenceValueoperator= (const DSRCompositeReferenceValue &referenceValue)
 assignment operator
 
virtual void clear ()
 clear all internal variables.
 
virtual OFBool isValid () const
 check whether the current reference value is valid.
 
virtual OFBool isEmpty () const
 check whether the current reference value is empty.
 
virtual OFCondition print (STD_NAMESPACE ostream &stream, const size_t flags) const
 print reference value.
 
virtual OFCondition readXML (const DSRXMLDocument &doc, DSRXMLCursor cursor)
 read reference value from XML document
 
virtual OFCondition writeXML (STD_NAMESPACE ostream &stream, const size_t flags) const
 write reference value in XML format
 
virtual OFCondition readSequence (DcmItem &dataset, const OFString &type)
 read referenced SOP sequence from dataset.
 
virtual OFCondition writeSequence (DcmItem &dataset) const
 write referenced SOP sequence to dataset.
 
virtual OFCondition renderHTML (STD_NAMESPACE ostream &docStream, STD_NAMESPACE ostream &annexStream, size_t &annexNumber, const size_t flags) const
 render composite reference value in HTML/XHTML format
 
const OFStringgetSOPClassUID () const
 get SOP class UID
 
const OFStringgetSOPInstanceUID () const
 get SOP instance UID
 
const DSRCompositeReferenceValuegetValue () const
 get reference to composite reference value
 
OFCondition getValue (DSRCompositeReferenceValue &referenceValue) const
 get copy of composite reference value
 
OFCondition setValue (const DSRCompositeReferenceValue &referenceValue)
 set composite reference value.
 
OFCondition setReference (const OFString &sopClassUID, const OFString &sopInstanceUID)
 set SOP class UID and SOP instance UID value.
 
OFCondition setSOPClassUID (const OFString &sopClassUID)
 set SOP class UID value.
 
OFCondition setSOPInstanceUID (const OFString &sopInstanceUID)
 set SOP instance UID value.
 

Protected Member Functions

DSRCompositeReferenceValuegetValuePtr ()
 get pointer to reference value
 
virtual OFCondition readItem (DcmItem &dataset)
 read reference value from dataset
 
virtual OFCondition writeItem (DcmItem &dataset) const
 write reference value to dataset
 
virtual OFBool checkSOPClassUID (const OFString &sopClassUID) const
 check the specified SOP class UID for validity.
 
virtual OFBool checkSOPInstanceUID (const OFString &sopInstanceUID) const
 check the specified SOP instance UID for validity.
 

Protected Attributes

OFString SOPClassUID
 reference SOP class UID (VR=UI, type 1)
 
OFString SOPInstanceUID
 reference SOP instance UID (VR=UI, type 1)
 

Friends

class DSRContentItem
 

Detailed Description

Class for composite reference values.

Definition at line 47 of file dsrcomvl.h.

Constructor & Destructor Documentation

DSRCompositeReferenceValue::DSRCompositeReferenceValue ( const OFString sopClassUID,
const OFString sopInstanceUID 
)

constructor.

The UID pair is only set if it passed the validity check (see setValue()).

Parameters
sopClassUIDreferenced SOP class UID of the composite object. (VR=UI, type 1)
sopInstanceUIDreferenced SOP instance UID of the composite object. (VR=UI, type 1)
DSRCompositeReferenceValue::DSRCompositeReferenceValue ( const DSRCompositeReferenceValue referenceValue)

copy constructor

Parameters
referenceValuereference value to be copied (not checked !)

Member Function Documentation

virtual OFBool DSRCompositeReferenceValue::checkSOPClassUID ( const OFString sopClassUID) const
protectedvirtual

check the specified SOP class UID for validity.

The only check that is currently performed is that the UID is not empty. Derived classes might overwrite this method for more specific tests (e.g. allowing only particular SOP classes).

Parameters
sopClassUIDSOP class UID to be checked
Returns
OFTrue if SOP class UID is valid, OFFalse otherwise

Reimplemented in DSRImageReferenceValue, and DSRWaveformReferenceValue.

virtual OFBool DSRCompositeReferenceValue::checkSOPInstanceUID ( const OFString sopInstanceUID) const
protectedvirtual

check the specified SOP instance UID for validity.

The only check that is currently performed is that the UID is not empty. Derived classes might overwrite this method for more specific tests.

Parameters
sopInstanceUIDSOP instance UID to be checked
Returns
OFTrue if SOP instance UID is valid, OFFalse otherwise
virtual void DSRCompositeReferenceValue::clear ( )
virtual

clear all internal variables.

Since an empty reference value is invalid the reference becomes invalid afterwards.

Reimplemented in DSRImageReferenceValue, DSRWaveformReferenceValue, DSRCompositeTreeNode, DSRImageTreeNode, and DSRWaveformTreeNode.

const OFString& DSRCompositeReferenceValue::getSOPClassUID ( ) const
inline

get SOP class UID

Returns
current SOP class UID (might be invalid or an empty string)

Definition at line 162 of file dsrcomvl.h.

References SOPClassUID.

const OFString& DSRCompositeReferenceValue::getSOPInstanceUID ( ) const
inline

get SOP instance UID

Returns
current SOP instance UID (might be invalid or an empty string)

Definition at line 170 of file dsrcomvl.h.

References SOPInstanceUID.

const DSRCompositeReferenceValue& DSRCompositeReferenceValue::getValue ( ) const
inline

get reference to composite reference value

Returns
reference to composite reference value

Definition at line 178 of file dsrcomvl.h.

OFCondition DSRCompositeReferenceValue::getValue ( DSRCompositeReferenceValue referenceValue) const

get copy of composite reference value

Parameters
referenceValuereference to variable in which the value should be stored
Returns
status, EC_Normal if successful, an error code otherwise
DSRCompositeReferenceValue* DSRCompositeReferenceValue::getValuePtr ( )
inlineprotected

get pointer to reference value

Returns
pointer to reference value (never NULL)

Definition at line 229 of file dsrcomvl.h.

virtual OFBool DSRCompositeReferenceValue::isEmpty ( ) const
virtual

check whether the current reference value is empty.

Checks whether both UIDs of the reference value are empty.

Returns
OFTrue if value is empty, OFFalse otherwise
virtual OFBool DSRCompositeReferenceValue::isValid ( ) const
virtual

check whether the current reference value is valid.

The reference value is valid if SOP class UID and SOP instance UID are valid (see checkSOP...UID() for details).

Returns
OFTrue if reference value is valid, OFFalse otherwise

Reimplemented in DSRImageReferenceValue, DSRCompositeTreeNode, DSRImageTreeNode, and DSRWaveformTreeNode.

DSRCompositeReferenceValue& DSRCompositeReferenceValue::operator= ( const DSRCompositeReferenceValue referenceValue)

assignment operator

Parameters
referenceValuereference value to be copied (not checked !)
Returns
reference to this reference value after 'referenceValue' has been copied
virtual OFCondition DSRCompositeReferenceValue::print ( STD_NAMESPACE ostream &  stream,
const size_t  flags 
) const
virtual

print reference value.

The output of a typical composite reference value looks like this: (BasicTextSR,"1.2.3"). If the SOP class UID is unknown the UID is printed instead of the related name.

Parameters
streamoutput stream to which the reference value should be printed
flagsflag used to customize the output (see DSRTypes::PF_xxx)
Returns
status, EC_Normal if successful, an error code otherwise

Reimplemented in DSRImageReferenceValue, DSRWaveformReferenceValue, DSRImageTreeNode, DSRWaveformTreeNode, and DSRCompositeTreeNode.

virtual OFCondition DSRCompositeReferenceValue::readItem ( DcmItem dataset)
protectedvirtual

read reference value from dataset

Parameters
datasetDICOM dataset from which the value should be read
Returns
status, EC_Normal if successful, an error code otherwise

Reimplemented in DSRImageReferenceValue, and DSRWaveformReferenceValue.

virtual OFCondition DSRCompositeReferenceValue::readSequence ( DcmItem dataset,
const OFString type 
)
virtual

read referenced SOP sequence from dataset.

The number of items within the sequence is checked. If error/warning output are enabled a warning message is printed if the sequence is absent or contains more than one item.

Parameters
datasetDICOM dataset from which the sequence should be read
typevalue type of the sequence (valid value: "1", "2", something else) This parameter is used for checking purpose, any difference is reported.
Returns
status, EC_Normal if successful, an error code otherwise
virtual OFCondition DSRCompositeReferenceValue::readXML ( const DSRXMLDocument doc,
DSRXMLCursor  cursor 
)
virtual

read reference value from XML document

Parameters
docdocument containing the XML file content
cursorcursor pointing to the starting node
Returns
status, EC_Normal if successful, an error code otherwise

Reimplemented in DSRImageReferenceValue, and DSRWaveformReferenceValue.

virtual OFCondition DSRCompositeReferenceValue::renderHTML ( STD_NAMESPACE ostream &  docStream,
STD_NAMESPACE ostream &  annexStream,
size_t &  annexNumber,
const size_t  flags 
) const
virtual

render composite reference value in HTML/XHTML format

Parameters
docStreamoutput stream to which the main HTML/XHTML document is written
annexStreamoutput stream to which the HTML/XHTML document annex is written
annexNumberreference to the variable where the current annex number is stored. Value is increased automatically by 1 after a new entry has been added.
flagsflag used to customize the output (see DSRTypes::HF_xxx)
Returns
status, EC_Normal if successful, an error code otherwise

Reimplemented in DSRImageReferenceValue, and DSRWaveformReferenceValue.

OFCondition DSRCompositeReferenceValue::setReference ( const OFString sopClassUID,
const OFString sopInstanceUID 
)

set SOP class UID and SOP instance UID value.

Before setting the values they are checked (see checkXXX()). If the value pair is invalid the current value pair is not replaced and remains unchanged.

Parameters
sopClassUIDreferenced SOP class UID to be set
sopInstanceUIDreferenced SOP instance UID to be set
Returns
status, EC_Normal if successful, an error code otherwise
OFCondition DSRCompositeReferenceValue::setSOPClassUID ( const OFString sopClassUID)

set SOP class UID value.

Before setting the value is is checked (see checkSOPClassUID()). If the value is invalid the current value is not replaced and remains unchanged.

Parameters
sopClassUIDSOP class UID to be set
Returns
status, EC_Normal if successful, an error code otherwise
OFCondition DSRCompositeReferenceValue::setSOPInstanceUID ( const OFString sopInstanceUID)

set SOP instance UID value.

Before setting the value is is checked (see checkSOPInstanceUID()). If the value is invalid the current value is not replaced and remains unchanged.

Parameters
sopInstanceUIDSOP instance UID to be set
Returns
status, EC_Normal if successful, an error code otherwise
OFCondition DSRCompositeReferenceValue::setValue ( const DSRCompositeReferenceValue referenceValue)

set composite reference value.

Before setting the reference it is checked (see checkXXX()). If the value is invalid the current value is not replaced and remains unchanged.

Parameters
referenceValuevalue to be set
Returns
status, EC_Normal if successful, an error code otherwise
virtual OFCondition DSRCompositeReferenceValue::writeItem ( DcmItem dataset) const
protectedvirtual

write reference value to dataset

Parameters
datasetDICOM dataset to which the value should be written
Returns
status, EC_Normal if successful, an error code otherwise

Reimplemented in DSRImageReferenceValue, and DSRWaveformReferenceValue.

virtual OFCondition DSRCompositeReferenceValue::writeSequence ( DcmItem dataset) const
virtual

write referenced SOP sequence to dataset.

If the value is empty an empty sequence (without any items) is written.

Parameters
datasetDICOM dataset to which the sequence should be written
Returns
status, EC_Normal if successful, an error code otherwise
virtual OFCondition DSRCompositeReferenceValue::writeXML ( STD_NAMESPACE ostream &  stream,
const size_t  flags 
) const
virtual

write reference value in XML format

Parameters
streamoutput stream to which the XML document is written
flagsflag used to customize the output (see DSRTypes::XF_xxx)
Returns
status, EC_Normal if successful, an error code otherwise

Reimplemented in DSRImageReferenceValue, DSRWaveformReferenceValue, DSRImageTreeNode, DSRWaveformTreeNode, and DSRCompositeTreeNode.


The documentation for this class was generated from the following file:


Generated on Thu Dec 20 2012 for OFFIS DCMTK Version 3.6.0 by Doxygen 1.8.2