DSRWaveformReferenceValue Class Reference

Class for waveform reference values. More...

Inheritance diagram for DSRWaveformReferenceValue:

DSRCompositeReferenceValue DSRWaveformTreeNode List of all members.

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.

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.

Private Attributes

DSRWaveformChannelList ChannelList
 list of referenced waveform channels (associated DICOM VR=US, VM=2-2n, type 1C)

Friends

class DSRContentItem

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:
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

Parameters:
referenceValue waveform reference value to be copied (not checked !)

Member Function Documentation

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

assignment operator

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

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.

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:
flags flag used to customize the output (see DSRTypes::HF_xxx)
Returns:
OFTrue if the content is short, OFFalse otherwise

Reimplemented in DSRWaveformTreeNode.

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

Reimplemented in DSRWaveformTreeNode.

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

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

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

write waveform reference in XML format

Parameters:
stream output stream to which the XML document is written
flags flag 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.

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:
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 from DSRCompositeReferenceValue.

const DSRWaveformReferenceValue& DSRWaveformReferenceValue::getValue (  )  const [inline]

get reference to waveform reference value

Returns:
reference to waveform reference value

Reimplemented from DSRCompositeReferenceValue.

Definition at line 140 of file dsrwavvl.h.

OFCondition DSRWaveformReferenceValue::getValue ( DSRWaveformReferenceValue &  referenceValue  )  const

get copy of waveform reference value

Parameters:
referenceValue reference to variable in which the value should be stored
Returns:
status, EC_Normal if successful, an error code otherwise

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:
referenceValue value to be set
Returns:
status, EC_Normal if successful, an error code otherwise

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.

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:
multiplexGroupNumber multiplex group number of the referenced channel
channelNumber channel number of the referenced channel
Returns:
OFTrue if reference applies to the specified channel, OFFalse otherwise

DSRWaveformReferenceValue* DSRWaveformReferenceValue::getValuePtr (  )  [inline, protected]

get pointer to waveform reference value

Returns:
pointer to waveform reference value (never NULL)

Reimplemented from DSRCompositeReferenceValue.

Definition at line 183 of file dsrwavvl.h.

virtual OFCondition DSRWaveformReferenceValue::readItem ( DcmItem &  dataset  )  [protected, virtual]

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

virtual OFCondition DSRWaveformReferenceValue::writeItem ( DcmItem &  dataset  )  const [protected, virtual]

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

virtual OFBool DSRWaveformReferenceValue::checkSOPClassUID ( const OFString &  sopClassUID  )  const [protected, virtual]

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:
sopClassUID SOP class UID to be checked
Returns:
OFTrue if SOP class UID is valid, OFFalse otherwise

Reimplemented from DSRCompositeReferenceValue.

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

Generated on 6 Jan 2011 for OFFIS DCMTK Version 3.6.0 by Doxygen 1.5.1