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

Class for image reference values. More...

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

Public Member Functions

 DSRImageReferenceValue ()
 default contructor
 
 DSRImageReferenceValue (const OFString &sopClassUID, const OFString &sopInstanceUID)
 constructor.
 
 DSRImageReferenceValue (const OFString &imageSOPClassUID, const OFString &imageSOPInstanceUID, const OFString &pstateSOPClassUID, const OFString &pstateSOPInstanceUID)
 constructor.
 
 DSRImageReferenceValue (const DSRImageReferenceValue &referenceValue)
 copy constructor
 
 DSRImageReferenceValue (const DSRCompositeReferenceValue &imageReferenceValue, const DSRCompositeReferenceValue &pstateReferenceValue)
 copy constructor
 
virtual ~DSRImageReferenceValue ()
 destructor
 
DSRImageReferenceValueoperator= (const DSRImageReferenceValue &referenceValue)
 assignment operator
 
virtual void clear ()
 clear all internal variables.
 
virtual OFBool isValid () const
 check whether the current image reference value is valid.
 
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 image reference.
 
virtual OFCondition readXML (const DSRXMLDocument &doc, DSRXMLCursor cursor)
 read image reference from XML document
 
virtual OFCondition writeXML (STD_NAMESPACE ostream &stream, const size_t flags) const
 write image reference in XML format
 
virtual OFCondition renderHTML (STD_NAMESPACE ostream &docStream, STD_NAMESPACE ostream &annexStream, size_t &annexNumber, const size_t flags) const
 render image reference value in HTML/XHTML format
 
const DSRImageReferenceValuegetValue () const
 get reference to image reference value
 
OFCondition getValue (DSRImageReferenceValue &referenceValue) const
 get copy of image reference value
 
OFCondition setValue (const DSRImageReferenceValue &referenceValue)
 set image reference value.
 
const DSRCompositeReferenceValuegetPresentationState () const
 get reference to presentation state value
 
OFCondition setPresentationState (const DSRCompositeReferenceValue &referenceValue)
 set presentation state value.
 
DSRImageFrameListgetFrameList ()
 get reference to list of referenced frame numbers
 
OFBool appliesToFrame (const Sint32 frameNumber) const
 check whether the image reference applies to a specific frame.
 
- 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 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

DSRImageReferenceValuegetValuePtr ()
 get pointer to image reference value
 
virtual OFCondition readItem (DcmItem &dataset)
 read image reference value from dataset
 
virtual OFCondition writeItem (DcmItem &dataset) const
 write image reference value to dataset
 
virtual OFBool checkSOPClassUID (const OFString &sopClassUID) const
 check the specified SOP class UID for validity.
 
OFBool checkPresentationState (const DSRCompositeReferenceValue &referenceValue) const
 check the presentation state object 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

DSRCompositeReferenceValue PresentationState
 composite reference value (SOP class/instance UID) to presentation state (optional)
 
DSRImageFrameList FrameList
 list of referenced frame numbers (associated DICOM VR=IS, VM=1-n, 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 image reference values.

Definition at line 47 of file dsrimgvl.h.

Constructor & Destructor Documentation

DSRImageReferenceValue::DSRImageReferenceValue ( 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 image object. (VR=UI, mandatory)
sopInstanceUIDreferenced SOP instance UID of the image object. (VR=UI, mandatory)
DSRImageReferenceValue::DSRImageReferenceValue ( const OFString imageSOPClassUID,
const OFString imageSOPInstanceUID,
const OFString pstateSOPClassUID,
const OFString pstateSOPInstanceUID 
)

constructor.

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

Parameters
imageSOPClassUIDreferenced SOP class UID of the image object. (VR=UI, mandatory)
imageSOPInstanceUIDreferenced SOP instance UID of the image object. (VR=UI, mandatory)
pstateSOPClassUIDreferenced SOP class UID of the presentation state object. (VR=UI, optional)
pstateSOPInstanceUIDreferenced SOP instance UID of the presentation state object. (VR=UI, optional)
DSRImageReferenceValue::DSRImageReferenceValue ( const DSRImageReferenceValue referenceValue)

copy constructor

Parameters
referenceValueimage reference value to be copied (not checked !)
DSRImageReferenceValue::DSRImageReferenceValue ( const DSRCompositeReferenceValue imageReferenceValue,
const DSRCompositeReferenceValue pstateReferenceValue 
)

copy constructor

Parameters
imageReferenceValueimagee reference value to be copied (not checked !)
pstateReferenceValuepresentation state reference value to be copied (not checked !)

Member Function Documentation

OFBool DSRImageReferenceValue::appliesToFrame ( const Sint32  frameNumber) const

check whether the image reference applies to a specific frame.

The image reference applies to a frame (of multiframe images) if the list of referenced frame numbers is empty or the frame number is part of the list.

Parameters
frameNumbernumber of the frame to be checked
Returns
OFTrue if reference applies to the specified frame, OFFalse otherwise
OFBool DSRImageReferenceValue::checkPresentationState ( const DSRCompositeReferenceValue referenceValue) const
protected

check the presentation state object for validity.

The presentation state object is "valid" if both UIDs are empty or both are not empty and SOP class UID equals to "GrayscaleSoftcopyPresentationStateStorage".

Parameters
referenceValuevalue to be checked
Returns
OFTrue if presentation state object is valid, OFFalse otherwise
virtual OFBool DSRImageReferenceValue::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. Later on it might be checked whether the specified SOP class is really an image storage SOP class.

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

Reimplemented from DSRCompositeReferenceValue.

virtual void DSRImageReferenceValue::clear ( )
virtual

clear all internal variables.

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

Reimplemented from DSRCompositeReferenceValue.

Reimplemented in DSRImageTreeNode.

DSRImageFrameList& DSRImageReferenceValue::getFrameList ( )
inline

get reference to list of referenced frame numbers

Returns
reference to frame list

Definition at line 210 of file dsrimgvl.h.

References FrameList.

const DSRCompositeReferenceValue& DSRImageReferenceValue::getPresentationState ( ) const
inline

get reference to presentation state value

Returns
reference to presentation state value (might be empty or invalid)

Definition at line 194 of file dsrimgvl.h.

References PresentationState.

const DSRImageReferenceValue& DSRImageReferenceValue::getValue ( ) const
inline

get reference to image reference value

Returns
reference to image reference value

Definition at line 172 of file dsrimgvl.h.

OFCondition DSRImageReferenceValue::getValue ( DSRImageReferenceValue referenceValue) const

get copy of image reference value

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

get pointer to image reference value

Returns
pointer to image reference value (never NULL)

Definition at line 229 of file dsrimgvl.h.

virtual OFBool DSRImageReferenceValue::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 DSRImageTreeNode.

virtual OFBool DSRImageReferenceValue::isValid ( ) const
virtual

check whether the current image reference value is valid.

The reference value is valid if SOP class UID and SOP instance UID are valid (see checkSOP...UID() for details) and the optional presentation state is valid (see checkPresentationState()).

Returns
OFTrue if reference value is valid, OFFalse otherwise

Reimplemented from DSRCompositeReferenceValue.

Reimplemented in DSRImageTreeNode.

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

assignment operator

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

print image reference.

The output of a typical image reference value looks like this: (CT image,"1.2.3") or (CT image,"1.2.3"),(GSPS,"1.2.3.4") if a presentation state is present. 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 DSRImageTreeNode.

virtual OFCondition DSRImageReferenceValue::readItem ( DcmItem dataset)
protectedvirtual

read image 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 DSRImageReferenceValue::readXML ( const DSRXMLDocument doc,
DSRXMLCursor  cursor 
)
virtual

read image 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 DSRImageReferenceValue::renderHTML ( STD_NAMESPACE ostream &  docStream,
STD_NAMESPACE ostream &  annexStream,
size_t &  annexNumber,
const size_t  flags 
) const
virtual

render image 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 DSRImageReferenceValue::setPresentationState ( const DSRCompositeReferenceValue referenceValue)

set presentation state value.

Before setting the reference it is checked (see checkPresentationState()). 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
OFCondition DSRImageReferenceValue::setValue ( const DSRImageReferenceValue referenceValue)

set image 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 DSRImageReferenceValue::writeItem ( DcmItem dataset) const
protectedvirtual

write image 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 DSRImageReferenceValue::writeXML ( STD_NAMESPACE ostream &  stream,
const size_t  flags 
) const
virtual

write image 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 DSRImageTreeNode.


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