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

Class for waveform reference values. More...

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

Public Member Functions

 DSRWaveformReferenceValue ()
 default contructor
 
 DSRWaveformReferenceValue (const OFString &sopClassUID, const OFString &sopInstanceUID)
 constructor.
 
 DSRWaveformReferenceValue (const DSRWaveformReferenceValue &referenceValue)
 copy constructor
 
virtual ~DSRWaveformReferenceValue ()
 destructor
 
DSRWaveformReferenceValueoperator= (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 DSRWaveformReferenceValuegetValue () 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.
 
DSRWaveformChannelListgetChannelList ()
 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.
 
- Public Member Functions inherited from DSRCompositeReferenceValue
 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 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 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

DSRWaveformReferenceValuegetValuePtr ()
 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.
 
- Protected Member Functions inherited from DSRCompositeReferenceValue
DSRCompositeReferenceValuegetValuePtr ()
 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

- Protected Attributes inherited from DSRCompositeReferenceValue
OFString SOPClassUID
 reference SOP class UID (VR=UI, type 1)
 
OFString SOPInstanceUID
 reference SOP instance UID (VR=UI, type 1)
 

Detailed Description

Class for waveform reference values.

Definition at line 47 of file dsrwavvl.h.

Constructor & Destructor Documentation

DSRWaveformReferenceValue::DSRWaveformReferenceValue ( 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 waveform object. (VR=UI, mandatory)
sopInstanceUIDreferenced SOP instance UID of the waveform object. (VR=UI, mandatory)
DSRWaveformReferenceValue::DSRWaveformReferenceValue ( const DSRWaveformReferenceValue referenceValue)

copy constructor

Parameters
referenceValuewaveform reference value to be copied (not checked !)

Member Function Documentation

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.

Parameters
multiplexGroupNumbermultiplex group number of the referenced channel
channelNumberchannel number of the referenced channel
Returns
OFTrue if reference applies to the specified channel, OFFalse otherwise
virtual OFBool DSRWaveformReferenceValue::checkSOPClassUID ( const OFString sopClassUID) const
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.

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

Reimplemented from DSRCompositeReferenceValue.

virtual void DSRWaveformReferenceValue::clear ( )
virtual

clear all internal variables.

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

Reimplemented from DSRCompositeReferenceValue.

Reimplemented in DSRWaveformTreeNode.

DSRWaveformChannelList& DSRWaveformReferenceValue::getChannelList ( )
inline

get reference to list of referenced waveform channels

Returns
reference to channel list

Definition at line 162 of file dsrwavvl.h.

References ChannelList.

const DSRWaveformReferenceValue& DSRWaveformReferenceValue::getValue ( ) const
inline

get reference to waveform reference value

Returns
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

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

get pointer to waveform reference value

Returns
pointer to waveform reference value (never NULL)

Definition at line 183 of file dsrwavvl.h.

virtual OFBool DSRWaveformReferenceValue::isShort ( const size_t  flags) const
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()).

Parameters
flagsflag used to customize the output (see DSRTypes::HF_xxx)
Returns
OFTrue if the content is short, OFFalse otherwise

Reimplemented in DSRWaveformTreeNode.

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

assignment operator

Parameters
referenceValuewaveform reference value to be copied (not checked !)
Returns
reference to this waveform reference value after 'referenceValue' has been copied
virtual OFCondition DSRWaveformReferenceValue::print ( STD_NAMESPACE ostream &  stream,
const size_t  flags 
) const
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.

Parameters
streamoutput stream to which the image 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 from DSRCompositeReferenceValue.

Reimplemented in DSRWaveformTreeNode.

virtual OFCondition DSRWaveformReferenceValue::readItem ( DcmItem dataset)
protectedvirtual

read waveform 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 from DSRCompositeReferenceValue.

virtual OFCondition DSRWaveformReferenceValue::readXML ( const DSRXMLDocument doc,
DSRXMLCursor  cursor 
)
virtual

read waveform reference 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 from DSRCompositeReferenceValue.

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

render waveform 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 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.

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

write waveform 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 from DSRCompositeReferenceValue.

virtual OFCondition DSRWaveformReferenceValue::writeXML ( STD_NAMESPACE ostream &  stream,
const size_t  flags 
) const
virtual

write waveform reference 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 from DSRCompositeReferenceValue.

Reimplemented in DSRWaveformTreeNode.


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