DSRImageReferenceValue Class Reference

Class for image reference values. More...

Inheritance diagram for DSRImageReferenceValue:


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
DSRImageReferenceValue &	operator= (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 (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 (ostream &stream, const size_t flags, OFConsole *logStream) const
	write image reference in XML format
virtual OFCondition	renderHTML (ostream &docStream, ostream &annexStream, size_t &annexNumber, const size_t flags, OFConsole *logStream) const
	render image reference value in HTML format
const DSRImageReferenceValue &	getValue () 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 DSRCompositeReferenceValue &	getPresentationState () const
	get reference to presentation state value
OFCondition	setPresentationState (const DSRCompositeReferenceValue &referenceValue)
	set presentation state value.
DSRImageFrameList &	getFrameList ()
	get reference to list of referenced frame numbers
OFBool	appliesToFrame (const Sint32 frameNumber) const
	check whether the image reference applies to a specific frame.
Protected Member Functions
DSRImageReferenceValue *	getValuePtr ()
	get pointer to image reference value
virtual OFCondition	readItem (DcmItem &dataset, OFConsole *logStream)
	read image reference value from dataset
virtual OFCondition	writeItem (DcmItem &dataset, OFConsole *logStream) 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.
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

Detailed Description

Class for image reference values.

Definition at line 51 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:

sopClassUID referenced SOP class UID of the image object. (VR=UI, mandatory)

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

imageSOPClassUID referenced SOP class UID of the image object. (VR=UI, mandatory)

imageSOPInstanceUID referenced SOP instance UID of the image object. (VR=UI, mandatory)

pstateSOPClassUID referenced SOP class UID of the presentation state object. (VR=UI, optional)

pstateSOPInstanceUID referenced SOP instance UID of the presentation state object. (VR=UI, optional)

DSRImageReferenceValue::DSRImageReferenceValue ( const DSRImageReferenceValue & referenceValue )

copy constructor

Parameters:

referenceValue image reference value to be copied (not checked !)

DSRImageReferenceValue::DSRImageReferenceValue ( const DSRCompositeReferenceValue & imageReferenceValue,

const DSRCompositeReferenceValue & pstateReferenceValue

)

copy constructor

Parameters:

imageReferenceValue imagee reference value to be copied (not checked !)

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

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

referenceValue value to be checked

Returns:
OFTrue if presentation state object is valid, OFFalse otherwise

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

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:

sopClassUID SOP 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 218 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 202 of file dsrimgvl.h.
References PresentationState.

OFCondition DSRImageReferenceValue::getValue ( DSRImageReferenceValue & referenceValue ) const

get copy of image reference value

Parameters:

referenceValue reference to variable in which the value should be stored

Returns:
status, EC_Normal if successful, an error code otherwise

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

get reference to image reference value

Returns:
reference to image reference value

Reimplemented from DSRCompositeReferenceValue.
Definition at line 180 of file dsrimgvl.h.

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

get pointer to image reference value

Returns:
pointer to image reference value (never NULL)

Reimplemented from DSRCompositeReferenceValue.
Definition at line 237 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:

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

referenceValue image reference value to be copied (not checked !)

Returns:
reference to this image reference value after 'referenceValue' has been copied

virtual OFCondition DSRImageReferenceValue::print ( 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:

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

virtual OFCondition DSRImageReferenceValue::readItem ( DcmItem & dataset,

OFConsole * logStream

) [protected, virtual]

read image reference value from dataset

Parameters:

dataset DICOM dataset from which the value should be read

logStream pointer to error/warning output stream (output disabled if NULL)

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:

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 DSRImageReferenceValue::renderHTML ( ostream & docStream,

ostream & annexStream,

size_t & annexNumber,

const size_t flags,

OFConsole * logStream

) const [virtual]

render image reference value in HTML format

Parameters:

docStream output stream to which the main HTML document is written

annexStream output stream to which the HTML 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)

logStream pointer to error/warning output stream (output disabled if NULL)

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:

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

referenceValue value to be set

Returns:
status, EC_Normal if successful, an error code otherwise

virtual OFCondition DSRImageReferenceValue::writeItem ( DcmItem & dataset,

OFConsole * logStream

) const [protected, virtual]

write image reference value to dataset

Parameters:

dataset DICOM dataset to which the value should be written

logStream pointer to error/warning output stream (output disabled if NULL)

Returns:
status, EC_Normal if successful, an error code otherwise

Reimplemented from DSRCompositeReferenceValue.

virtual OFCondition DSRImageReferenceValue::writeXML ( ostream & stream,

const size_t flags,

OFConsole * logStream

) const [virtual]

write image 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)

logStream pointer to error/warning output stream (output disabled if NULL)

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:

dcmsr/include/dcmtk/dcmsr/dsrimgvl.h

Generated on 20 Dec 2005 for OFFIS DCMTK Version 3.5.4 by Doxygen 1.4.5

DSRImageReferenceValue Class Reference

Public Member Functions

Protected Member Functions

Private Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation