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 (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 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) |
| 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. | |
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 |
Definition at line 47 of file dsrimgvl.h.
| DSRImageReferenceValue::DSRImageReferenceValue | ( | 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 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()).
| 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
| referenceValue | image reference value to be copied (not checked !) |
| DSRImageReferenceValue::DSRImageReferenceValue | ( | const DSRCompositeReferenceValue & | imageReferenceValue, | |
| const DSRCompositeReferenceValue & | pstateReferenceValue | |||
| ) |
copy constructor
| imageReferenceValue | imagee reference value to be copied (not checked !) | |
| pstateReferenceValue | presentation state reference value to be copied (not checked !) |
| DSRImageReferenceValue& DSRImageReferenceValue::operator= | ( | const DSRImageReferenceValue & | referenceValue | ) |
assignment operator
| referenceValue | image reference value to be copied (not checked !) |
| 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.
| 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()).
Reimplemented from DSRCompositeReferenceValue.
Reimplemented in DSRImageTreeNode.
| 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()).
| flags | flag used to customize the output (see DSRTypes::HF_xxx) |
Reimplemented in DSRImageTreeNode.
| 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.
| 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 DSRImageTreeNode.
| virtual OFCondition DSRImageReferenceValue::readXML | ( | const DSRXMLDocument & | doc, | |
| DSRXMLCursor | cursor | |||
| ) | [virtual] |
read image reference from XML document
| doc | document containing the XML file content | |
| cursor | cursor pointing to the starting node |
Reimplemented from DSRCompositeReferenceValue.
| virtual OFCondition DSRImageReferenceValue::writeXML | ( | STD_NAMESPACE ostream & | stream, | |
| const size_t | flags | |||
| ) | const [virtual] |
write image 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 DSRImageTreeNode.
| 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
| 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.
| const DSRImageReferenceValue& DSRImageReferenceValue::getValue | ( | ) | const [inline] |
get reference to image reference value
Reimplemented from DSRCompositeReferenceValue.
Definition at line 172 of file dsrimgvl.h.
| OFCondition DSRImageReferenceValue::getValue | ( | DSRImageReferenceValue & | referenceValue | ) | const |
get copy of image reference value
| referenceValue | reference to variable in which the value should be stored |
| 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.
| referenceValue | value to be set |
| const DSRCompositeReferenceValue& DSRImageReferenceValue::getPresentationState | ( | ) | const [inline] |
get reference to presentation state value
Definition at line 194 of file dsrimgvl.h.
References PresentationState.
| 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.
| referenceValue | value to be set |
| DSRImageFrameList& DSRImageReferenceValue::getFrameList | ( | ) | [inline] |
get reference to list of referenced frame numbers
Definition at line 210 of file dsrimgvl.h.
References FrameList.
| 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.
| frameNumber | number of the frame to be checked |
| DSRImageReferenceValue* DSRImageReferenceValue::getValuePtr | ( | ) | [inline, protected] |
get pointer to image reference value
Reimplemented from DSRCompositeReferenceValue.
Definition at line 229 of file dsrimgvl.h.
| virtual OFCondition DSRImageReferenceValue::readItem | ( | DcmItem & | dataset | ) | [protected, virtual] |
read image reference value from dataset
| dataset | DICOM dataset from which the value should be read |
Reimplemented from DSRCompositeReferenceValue.
| virtual OFCondition DSRImageReferenceValue::writeItem | ( | DcmItem & | dataset | ) | const [protected, virtual] |
write image reference value to dataset
| dataset | DICOM dataset to which the value should be written |
Reimplemented from DSRCompositeReferenceValue.
| 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.
| sopClassUID | SOP class UID to be checked |
Reimplemented from DSRCompositeReferenceValue.
| 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".
| referenceValue | value to be checked |