Class for composite reference values.
More...
Class for composite reference values.
Definition at line 47 of file dsrcomvl.h.
DSRCompositeReferenceValue::DSRCompositeReferenceValue |
( |
const OFString & |
sopClassUID, |
|
|
const OFString & |
sopInstanceUID |
|
) |
| |
constructor.
The UID pair is only set if it passed the validity check (see setValue()).
- Parameters
-
sopClassUID | referenced SOP class UID of the composite object. (VR=UI, type 1) |
sopInstanceUID | referenced SOP instance UID of the composite object. (VR=UI, type 1) |
copy constructor
- Parameters
-
referenceValue | reference value to be copied (not checked !) |
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
-
sopClassUID | SOP 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
-
sopInstanceUID | SOP instance UID to be checked |
- Returns
- OFTrue if SOP instance UID is valid, OFFalse otherwise
virtual void DSRCompositeReferenceValue::clear |
( |
| ) |
|
|
virtual |
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.
get reference to composite reference value
- Returns
- reference to composite reference value
Definition at line 178 of file dsrcomvl.h.
get copy of composite reference value
- Parameters
-
referenceValue | reference to variable in which the value should be stored |
- Returns
- status, EC_Normal if successful, an error code otherwise
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 |
assignment operator
- Parameters
-
referenceValue | reference 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
-
stream | output stream to which the reference value should be printed |
flags | flag 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.
read reference value from dataset
- Parameters
-
dataset | DICOM dataset from which the value should be read |
- Returns
- status, EC_Normal if successful, an error code otherwise
Reimplemented in DSRImageReferenceValue, and DSRWaveformReferenceValue.
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
-
dataset | DICOM dataset from which the sequence should be read |
type | value 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
read reference value from XML document
- Parameters
-
doc | document containing the XML file content |
cursor | cursor 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
-
docStream | output stream to which the main HTML/XHTML document is written |
annexStream | output stream to which the HTML/XHTML document annex is written |
annexNumber | reference to the variable where the current annex number is stored. Value is increased automatically by 1 after a new entry has been added. |
flags | flag used to customize the output (see DSRTypes::HF_xxx) |
- Returns
- status, EC_Normal if successful, an error code otherwise
Reimplemented in DSRImageReferenceValue, and DSRWaveformReferenceValue.
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
-
sopClassUID | referenced SOP class UID to be set |
sopInstanceUID | referenced SOP instance UID to be set |
- Returns
- status, EC_Normal if successful, an error code otherwise
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
-
sopClassUID | SOP class UID to be set |
- Returns
- status, EC_Normal if successful, an error code otherwise
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
-
sopInstanceUID | SOP instance UID to be set |
- Returns
- status, EC_Normal if successful, an error code otherwise
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
-
referenceValue | value to be set |
- Returns
- status, EC_Normal if successful, an error code otherwise
write reference value to dataset
- Parameters
-
dataset | DICOM dataset to which the value should be written |
- Returns
- status, EC_Normal if successful, an error code otherwise
Reimplemented in DSRImageReferenceValue, and DSRWaveformReferenceValue.
write referenced SOP sequence to dataset.
If the value is empty an empty sequence (without any items) is written.
- Parameters
-
dataset | DICOM 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 |
The documentation for this class was generated from the following file: