OFFIS DCMTK
Version 3.6.0
|
Class for waveform reference values. More...
Public Member Functions | |
DSRWaveformReferenceValue () | |
default contructor | |
DSRWaveformReferenceValue (const OFString &sopClassUID, const OFString &sopInstanceUID) | |
constructor. | |
DSRWaveformReferenceValue (const DSRWaveformReferenceValue &referenceValue) | |
copy constructor | |
virtual | ~DSRWaveformReferenceValue () |
destructor | |
DSRWaveformReferenceValue & | operator= (const DSRWaveformReferenceValue &referenceValue) |
assignment operator | |
virtual void | clear () |
clear all internal variables. | |
virtual OFBool | isShort (const size_t flags) const |
check whether the content is short. | |
virtual OFCondition | print (STD_NAMESPACE ostream &stream, const size_t flags) const |
print waveform reference. | |
virtual OFCondition | readXML (const DSRXMLDocument &doc, DSRXMLCursor cursor) |
read waveform reference from XML document | |
virtual OFCondition | writeXML (STD_NAMESPACE ostream &stream, const size_t flags) const |
write waveform reference in XML format | |
virtual OFCondition | renderHTML (STD_NAMESPACE ostream &docStream, STD_NAMESPACE ostream &annexStream, size_t &annexNumber, const size_t flags) const |
render waveform reference value in HTML/XHTML format | |
const DSRWaveformReferenceValue & | getValue () const |
get reference to waveform reference value | |
OFCondition | getValue (DSRWaveformReferenceValue &referenceValue) const |
get copy of waveform reference value | |
OFCondition | setValue (const DSRWaveformReferenceValue &referenceValue) |
set waveform reference value. | |
DSRWaveformChannelList & | getChannelList () |
get reference to list of referenced waveform channels | |
OFBool | appliesToChannel (const Uint16 multiplexGroupNumber, const Uint16 channelNumber) const |
check whether the waveform reference applies to a specific channel. | |
![]() | |
DSRCompositeReferenceValue () | |
default contructor | |
DSRCompositeReferenceValue (const OFString &sopClassUID, const OFString &sopInstanceUID) | |
constructor. | |
DSRCompositeReferenceValue (const DSRCompositeReferenceValue &referenceValue) | |
copy constructor | |
virtual | ~DSRCompositeReferenceValue () |
destructor | |
DSRCompositeReferenceValue & | operator= (const DSRCompositeReferenceValue &referenceValue) |
assignment operator | |
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 | readSequence (DcmItem &dataset, const OFString &type) |
read referenced SOP sequence from dataset. | |
virtual OFCondition | writeSequence (DcmItem &dataset) const |
write referenced SOP sequence to dataset. | |
const OFString & | getSOPClassUID () const |
get SOP class UID | |
const OFString & | getSOPInstanceUID () const |
get SOP instance UID | |
const DSRCompositeReferenceValue & | getValue () 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 | |
DSRWaveformReferenceValue * | getValuePtr () |
get pointer to waveform reference value | |
virtual OFCondition | readItem (DcmItem &dataset) |
read waveform reference value from dataset | |
virtual OFCondition | writeItem (DcmItem &dataset) const |
write waveform reference value to dataset | |
virtual OFBool | checkSOPClassUID (const OFString &sopClassUID) const |
check the specified SOP class UID for validity. | |
![]() | |
DSRCompositeReferenceValue * | getValuePtr () |
get pointer to reference value | |
virtual OFBool | checkSOPInstanceUID (const OFString &sopInstanceUID) const |
check the specified SOP instance UID for validity. | |
Private Attributes | |
DSRWaveformChannelList | ChannelList |
list of referenced waveform channels (associated DICOM VR=US, VM=2-2n, type 1C) | |
Friends | |
class | DSRContentItem |
Additional Inherited Members | |
![]() | |
OFString | SOPClassUID |
reference SOP class UID (VR=UI, type 1) | |
OFString | SOPInstanceUID |
reference SOP instance UID (VR=UI, type 1) | |
Class for waveform reference values.
Definition at line 47 of file dsrwavvl.h.
DSRWaveformReferenceValue::DSRWaveformReferenceValue | ( | const OFString & | sopClassUID, |
const OFString & | sopInstanceUID | ||
) |
constructor.
The UID pair is only set if it passed the validity check (see setValue()).
sopClassUID | referenced SOP class UID of the waveform object. (VR=UI, mandatory) |
sopInstanceUID | referenced SOP instance UID of the waveform object. (VR=UI, mandatory) |
DSRWaveformReferenceValue::DSRWaveformReferenceValue | ( | const DSRWaveformReferenceValue & | referenceValue | ) |
copy constructor
referenceValue | waveform reference value to be copied (not checked !) |
OFBool DSRWaveformReferenceValue::appliesToChannel | ( | const Uint16 | multiplexGroupNumber, |
const Uint16 | channelNumber | ||
) | const |
check whether the waveform reference applies to a specific channel.
The waveform reference applies to a channel if the list of referenced waveform channels is empty or the group/channel pair is part of the list.
multiplexGroupNumber | multiplex group number of the referenced channel |
channelNumber | channel number of the referenced channel |
|
protectedvirtual |
check the specified SOP class UID for validity.
Currently all waveform SOP classes that are defined in DICOM PS 3.x 2003 are allowed.
sopClassUID | SOP class UID to be checked |
Reimplemented from DSRCompositeReferenceValue.
|
virtual |
clear all internal variables.
Since an empty waveform reference is invalid the reference becomes invalid afterwards.
Reimplemented from DSRCompositeReferenceValue.
Reimplemented in DSRWaveformTreeNode.
|
inline |
get reference to list of referenced waveform channels
Definition at line 162 of file dsrwavvl.h.
References ChannelList.
|
inline |
get reference to waveform reference value
Definition at line 140 of file dsrwavvl.h.
OFCondition DSRWaveformReferenceValue::getValue | ( | DSRWaveformReferenceValue & | referenceValue | ) | const |
get copy of waveform reference value
referenceValue | reference to variable in which the value should be stored |
|
inlineprotected |
get pointer to waveform reference value
Definition at line 183 of file dsrwavvl.h.
|
virtual |
check whether the content is short.
This method is used to check whether the rendered output of this content item can be expanded inline or not (used for renderHTML()).
flags | flag used to customize the output (see DSRTypes::HF_xxx) |
Reimplemented in DSRWaveformTreeNode.
DSRWaveformReferenceValue& DSRWaveformReferenceValue::operator= | ( | const DSRWaveformReferenceValue & | referenceValue | ) |
assignment operator
referenceValue | waveform reference value to be copied (not checked !) |
|
virtual |
print waveform reference.
The output of a typical waveform reference value looks like this: (HemodynamicWaveform Storage,"1.2.3") If the SOP class UID is unknown the UID is printed instead of the related name.
stream | output stream to which the image reference value should be printed |
flags | flag used to customize the output (see DSRTypes::PF_xxx) |
Reimplemented from DSRCompositeReferenceValue.
Reimplemented in DSRWaveformTreeNode.
|
protectedvirtual |
read waveform reference value from dataset
dataset | DICOM dataset from which the value should be read |
Reimplemented from DSRCompositeReferenceValue.
|
virtual |
read waveform reference from XML document
doc | document containing the XML file content |
cursor | cursor pointing to the starting node |
Reimplemented from DSRCompositeReferenceValue.
|
virtual |
render waveform reference value in HTML/XHTML format
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) |
Reimplemented from DSRCompositeReferenceValue.
OFCondition DSRWaveformReferenceValue::setValue | ( | const DSRWaveformReferenceValue & | referenceValue | ) |
set waveform 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.
referenceValue | value to be set |
|
protectedvirtual |
write waveform reference value to dataset
dataset | DICOM dataset to which the value should be written |
Reimplemented from DSRCompositeReferenceValue.
|
virtual |
write waveform reference in XML format
stream | output stream to which the XML document is written |
flags | flag used to customize the output (see DSRTypes::XF_xxx) |
Reimplemented from DSRCompositeReferenceValue.
Reimplemented in DSRWaveformTreeNode.