DCMTK  Version 3.6.1 20120515
OFFIS DICOM Toolkit
Public Member Functions | Private Attributes
DRTPlannedVerificationImageSequence::Item Class Reference

Item class. More...

+ Inheritance diagram for DRTPlannedVerificationImageSequence::Item:

List of all members.

Public Member Functions

 Item (const OFBool emptyDefaultItem=OFFalse)
 (default) constructor
 Item (const Item &copy)
 copy constructor
virtual ~Item ()
 destructor
Itemoperator= (const Item &copy)
 assigment operator
void clear ()
 clear all internal member variables
OFBool isEmpty ()
 check if item is empty
OFBool isValid () const
 check if item is valid, i.e. not the empty default item
OFCondition read (DcmItem &item)
 read elements from sequence item
OFCondition write (DcmItem &item)
 write elements to sequence item
OFCondition getEndCumulativeMetersetWeight (OFString &value, const signed long pos=0) const
 get EndCumulativeMetersetWeight (300c,0009)
OFCondition getEndCumulativeMetersetWeight (Float64 &value, const unsigned long pos=0) const
 get EndCumulativeMetersetWeight (300c,0009)
OFCondition getImagingDeviceSpecificAcquisitionParameters (OFString &value, const signed long pos=0) const
 get ImagingDeviceSpecificAcquisitionParameters (300a,00cc)
OFCondition getMetersetExposure (OFString &value, const signed long pos=0) const
 get MetersetExposure (3002,0032)
OFCondition getMetersetExposure (Float64 &value, const unsigned long pos=0) const
 get MetersetExposure (3002,0032)
OFCondition getRTImageOrientation (OFString &value, const signed long pos=0) const
 get RTImageOrientation (3002,0010)
OFCondition getRTImageOrientation (Float64 &value, const unsigned long pos=0) const
 get RTImageOrientation (3002,0010)
OFCondition getRTImageOrientation (OFVector< Float64 > &value) const
 get RTImageOrientation (3002,0010)
OFCondition getRTImagePlane (OFString &value, const signed long pos=0) const
 get RTImagePlane (3002,000c)
OFCondition getRTImagePosition (OFString &value, const signed long pos=0) const
 get RTImagePosition (3002,0012)
OFCondition getRTImagePosition (Float64 &value, const unsigned long pos=0) const
 get RTImagePosition (3002,0012)
OFCondition getRTImagePosition (OFVector< Float64 > &value) const
 get RTImagePosition (3002,0012)
OFCondition getRTImageSID (OFString &value, const signed long pos=0) const
 get RTImageSID (3002,0026)
OFCondition getRTImageSID (Float64 &value, const unsigned long pos=0) const
 get RTImageSID (3002,0026)
OFCondition getReferencedReferenceImageNumber (OFString &value, const signed long pos=0) const
 get ReferencedReferenceImageNumber (300c,0007)
OFCondition getReferencedReferenceImageNumber (Sint32 &value, const unsigned long pos=0) const
 get ReferencedReferenceImageNumber (300c,0007)
OFCondition getStartCumulativeMetersetWeight (OFString &value, const signed long pos=0) const
 get StartCumulativeMetersetWeight (300c,0008)
OFCondition getStartCumulativeMetersetWeight (Float64 &value, const unsigned long pos=0) const
 get StartCumulativeMetersetWeight (300c,0008)
OFCondition getXRayImageReceptorAngle (OFString &value, const signed long pos=0) const
 get XRayImageReceptorAngle (3002,000e)
OFCondition getXRayImageReceptorAngle (Float64 &value, const unsigned long pos=0) const
 get XRayImageReceptorAngle (3002,000e)
OFCondition setEndCumulativeMetersetWeight (const OFString &value, const OFBool check=OFTrue)
 set EndCumulativeMetersetWeight (300c,0009)
OFCondition setImagingDeviceSpecificAcquisitionParameters (const OFString &value, const OFBool check=OFTrue)
 set ImagingDeviceSpecificAcquisitionParameters (300a,00cc)
OFCondition setMetersetExposure (const OFString &value, const OFBool check=OFTrue)
 set MetersetExposure (3002,0032)
OFCondition setRTImageOrientation (const OFString &value, const OFBool check=OFTrue)
 set RTImageOrientation (3002,0010)
OFCondition setRTImagePlane (const OFString &value, const OFBool check=OFTrue)
 set RTImagePlane (3002,000c)
OFCondition setRTImagePosition (const OFString &value, const OFBool check=OFTrue)
 set RTImagePosition (3002,0012)
OFCondition setRTImageSID (const OFString &value, const OFBool check=OFTrue)
 set RTImageSID (3002,0026)
OFCondition setReferencedReferenceImageNumber (const OFString &value, const OFBool check=OFTrue)
 set ReferencedReferenceImageNumber (300c,0007)
OFCondition setStartCumulativeMetersetWeight (const OFString &value, const OFBool check=OFTrue)
 set StartCumulativeMetersetWeight (300c,0008)
OFCondition setXRayImageReceptorAngle (const OFString &value, const OFBool check=OFTrue)
 set XRayImageReceptorAngle (3002,000e)

Private Attributes

OFBool EmptyDefaultItem
 internal flag used to mark the empty default item
DcmDecimalString EndCumulativeMetersetWeight
 EndCumulativeMetersetWeight (300c,0009) vr=DS, vm=1, type=3.
DcmLongString ImagingDeviceSpecificAcquisitionParameters
 ImagingDeviceSpecificAcquisitionParameters (300a,00cc) vr=LO, vm=1-n, type=3.
DcmDecimalString MetersetExposure
 MetersetExposure (3002,0032) vr=DS, vm=1, type=3.
DcmDecimalString RTImageOrientation
 RTImageOrientation (3002,0010) vr=DS, vm=6, type=3.
DcmCodeString RTImagePlane
 RTImagePlane (3002,000c) vr=CS, vm=1, type=3.
DcmDecimalString RTImagePosition
 RTImagePosition (3002,0012) vr=DS, vm=2, type=3.
DcmDecimalString RTImageSID
 RTImageSID (3002,0026) vr=DS, vm=1, type=3.
DcmIntegerString ReferencedReferenceImageNumber
 ReferencedReferenceImageNumber (300c,0007) vr=IS, vm=1, type=3.
DcmDecimalString StartCumulativeMetersetWeight
 StartCumulativeMetersetWeight (300c,0008) vr=DS, vm=1, type=3.
DcmDecimalString XRayImageReceptorAngle
 XRayImageReceptorAngle (3002,000e) vr=DS, vm=1, type=3.

Detailed Description

Item class.


Constructor & Destructor Documentation

DRTPlannedVerificationImageSequence::Item::Item ( const OFBool  emptyDefaultItem = OFFalse)

(default) constructor

Parameters:
emptyDefaultItemflag used to mark the empty default item

copy constructor

Parameters:
copyitem object to be copied

Member Function Documentation

get EndCumulativeMetersetWeight (300c,0009)

Parameters:
valuereference to variable in which the value should be stored
posindex of the value to get (0..vm-1), -1 for all components
Returns:
status, EC_Normal if successful, an error code otherwise
OFCondition DRTPlannedVerificationImageSequence::Item::getEndCumulativeMetersetWeight ( Float64 &  value,
const unsigned long  pos = 0 
) const

get EndCumulativeMetersetWeight (300c,0009)

Parameters:
valuereference to variable in which the value should be stored
posindex of the value to get (0..vm-1)
Returns:
status, EC_Normal if successful, an error code otherwise

get ImagingDeviceSpecificAcquisitionParameters (300a,00cc)

Parameters:
valuereference to variable in which the value should be stored
posindex of the value to get (0..vm-1), -1 for all components
Returns:
status, EC_Normal if successful, an error code otherwise
OFCondition DRTPlannedVerificationImageSequence::Item::getMetersetExposure ( OFString value,
const signed long  pos = 0 
) const

get MetersetExposure (3002,0032)

Parameters:
valuereference to variable in which the value should be stored
posindex of the value to get (0..vm-1), -1 for all components
Returns:
status, EC_Normal if successful, an error code otherwise
OFCondition DRTPlannedVerificationImageSequence::Item::getMetersetExposure ( Float64 &  value,
const unsigned long  pos = 0 
) const

get MetersetExposure (3002,0032)

Parameters:
valuereference to variable in which the value should be stored
posindex of the value to get (0..vm-1)
Returns:
status, EC_Normal if successful, an error code otherwise

get ReferencedReferenceImageNumber (300c,0007)

Parameters:
valuereference to variable in which the value should be stored
posindex of the value to get (0..vm-1), -1 for all components
Returns:
status, EC_Normal if successful, an error code otherwise
OFCondition DRTPlannedVerificationImageSequence::Item::getReferencedReferenceImageNumber ( Sint32 &  value,
const unsigned long  pos = 0 
) const

get ReferencedReferenceImageNumber (300c,0007)

Parameters:
valuereference to variable in which the value should be stored
posindex of the value to get (0..vm-1)
Returns:
status, EC_Normal if successful, an error code otherwise

get RTImageOrientation (3002,0010)

Parameters:
valuereference to variable in which the value should be stored
posindex of the value to get (0..vm-1), -1 for all components
Returns:
status, EC_Normal if successful, an error code otherwise
OFCondition DRTPlannedVerificationImageSequence::Item::getRTImageOrientation ( Float64 &  value,
const unsigned long  pos = 0 
) const

get RTImageOrientation (3002,0010)

Parameters:
valuereference to variable in which the value should be stored
posindex of the value to get (0..vm-1)
Returns:
status, EC_Normal if successful, an error code otherwise

get RTImageOrientation (3002,0010)

Parameters:
valuereference to variable in which the value(s) should be stored
Returns:
status, EC_Normal if successful, an error code otherwise
OFCondition DRTPlannedVerificationImageSequence::Item::getRTImagePlane ( OFString value,
const signed long  pos = 0 
) const

get RTImagePlane (3002,000c)

Parameters:
valuereference to variable in which the value should be stored
posindex of the value to get (0..vm-1), -1 for all components
Returns:
status, EC_Normal if successful, an error code otherwise
OFCondition DRTPlannedVerificationImageSequence::Item::getRTImagePosition ( OFString value,
const signed long  pos = 0 
) const

get RTImagePosition (3002,0012)

Parameters:
valuereference to variable in which the value should be stored
posindex of the value to get (0..vm-1), -1 for all components
Returns:
status, EC_Normal if successful, an error code otherwise
OFCondition DRTPlannedVerificationImageSequence::Item::getRTImagePosition ( Float64 &  value,
const unsigned long  pos = 0 
) const

get RTImagePosition (3002,0012)

Parameters:
valuereference to variable in which the value should be stored
posindex of the value to get (0..vm-1)
Returns:
status, EC_Normal if successful, an error code otherwise

get RTImagePosition (3002,0012)

Parameters:
valuereference to variable in which the value(s) should be stored
Returns:
status, EC_Normal if successful, an error code otherwise
OFCondition DRTPlannedVerificationImageSequence::Item::getRTImageSID ( OFString value,
const signed long  pos = 0 
) const

get RTImageSID (3002,0026)

Parameters:
valuereference to variable in which the value should be stored
posindex of the value to get (0..vm-1), -1 for all components
Returns:
status, EC_Normal if successful, an error code otherwise
OFCondition DRTPlannedVerificationImageSequence::Item::getRTImageSID ( Float64 &  value,
const unsigned long  pos = 0 
) const

get RTImageSID (3002,0026)

Parameters:
valuereference to variable in which the value should be stored
posindex of the value to get (0..vm-1)
Returns:
status, EC_Normal if successful, an error code otherwise

get StartCumulativeMetersetWeight (300c,0008)

Parameters:
valuereference to variable in which the value should be stored
posindex of the value to get (0..vm-1), -1 for all components
Returns:
status, EC_Normal if successful, an error code otherwise
OFCondition DRTPlannedVerificationImageSequence::Item::getStartCumulativeMetersetWeight ( Float64 &  value,
const unsigned long  pos = 0 
) const

get StartCumulativeMetersetWeight (300c,0008)

Parameters:
valuereference to variable in which the value should be stored
posindex of the value to get (0..vm-1)
Returns:
status, EC_Normal if successful, an error code otherwise

get XRayImageReceptorAngle (3002,000e)

Parameters:
valuereference to variable in which the value should be stored
posindex of the value to get (0..vm-1), -1 for all components
Returns:
status, EC_Normal if successful, an error code otherwise
OFCondition DRTPlannedVerificationImageSequence::Item::getXRayImageReceptorAngle ( Float64 &  value,
const unsigned long  pos = 0 
) const

get XRayImageReceptorAngle (3002,000e)

Parameters:
valuereference to variable in which the value should be stored
posindex of the value to get (0..vm-1)
Returns:
status, EC_Normal if successful, an error code otherwise

check if item is empty

Returns:
OFTrue if item is empty, OFFalse otherwise

check if item is valid, i.e. not the empty default item

Returns:
OFTrue if item is valid, OFFalse otherwise
Item& DRTPlannedVerificationImageSequence::Item::operator= ( const Item copy)

assigment operator

Parameters:
copyitem object to be copied

read elements from sequence item

Parameters:
itemreference to DICOM sequence item from which the elements should be read
Returns:
status, EC_Normal if successful, an error code otherwise

set EndCumulativeMetersetWeight (300c,0009)

Parameters:
valuevalue to be set (single value only) or "" for no value
checkcheck 'value' for conformance with VR (DS) and VM (1) if enabled
Returns:
status, EC_Normal if successful, an error code otherwise

set ImagingDeviceSpecificAcquisitionParameters (300a,00cc)

Parameters:
valuevalue to be set (possibly multi-valued) or "" for no value
checkcheck 'value' for conformance with VR (LO) and VM (1-n) if enabled
Returns:
status, EC_Normal if successful, an error code otherwise
OFCondition DRTPlannedVerificationImageSequence::Item::setMetersetExposure ( const OFString value,
const OFBool  check = OFTrue 
)

set MetersetExposure (3002,0032)

Parameters:
valuevalue to be set (single value only) or "" for no value
checkcheck 'value' for conformance with VR (DS) and VM (1) if enabled
Returns:
status, EC_Normal if successful, an error code otherwise

set ReferencedReferenceImageNumber (300c,0007)

Parameters:
valuevalue to be set (single value only) or "" for no value
checkcheck 'value' for conformance with VR (IS) and VM (1) if enabled
Returns:
status, EC_Normal if successful, an error code otherwise
OFCondition DRTPlannedVerificationImageSequence::Item::setRTImageOrientation ( const OFString value,
const OFBool  check = OFTrue 
)

set RTImageOrientation (3002,0010)

Parameters:
valuevalue to be set (possibly multi-valued) or "" for no value
checkcheck 'value' for conformance with VR (DS) and VM (6) if enabled
Returns:
status, EC_Normal if successful, an error code otherwise
OFCondition DRTPlannedVerificationImageSequence::Item::setRTImagePlane ( const OFString value,
const OFBool  check = OFTrue 
)

set RTImagePlane (3002,000c)

Parameters:
valuevalue to be set (single value only) or "" for no value
checkcheck 'value' for conformance with VR (CS) and VM (1) if enabled
Returns:
status, EC_Normal if successful, an error code otherwise
OFCondition DRTPlannedVerificationImageSequence::Item::setRTImagePosition ( const OFString value,
const OFBool  check = OFTrue 
)

set RTImagePosition (3002,0012)

Parameters:
valuevalue to be set (possibly multi-valued) or "" for no value
checkcheck 'value' for conformance with VR (DS) and VM (2) if enabled
Returns:
status, EC_Normal if successful, an error code otherwise
OFCondition DRTPlannedVerificationImageSequence::Item::setRTImageSID ( const OFString value,
const OFBool  check = OFTrue 
)

set RTImageSID (3002,0026)

Parameters:
valuevalue to be set (single value only) or "" for no value
checkcheck 'value' for conformance with VR (DS) and VM (1) if enabled
Returns:
status, EC_Normal if successful, an error code otherwise

set StartCumulativeMetersetWeight (300c,0008)

Parameters:
valuevalue to be set (single value only) or "" for no value
checkcheck 'value' for conformance with VR (DS) and VM (1) if enabled
Returns:
status, EC_Normal if successful, an error code otherwise

set XRayImageReceptorAngle (3002,000e)

Parameters:
valuevalue to be set (single value only) or "" for no value
checkcheck 'value' for conformance with VR (DS) and VM (1) if enabled
Returns:
status, EC_Normal if successful, an error code otherwise

write elements to sequence item

Parameters:
itemreference to DICOM sequence item to which the elements should be written
Returns:
status, EC_Normal if successful, an error code otherwise

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


Generated on Tue May 15 2012 for DCMTK Version 3.6.1 20120515 by Doxygen 1.7.5.1-20111027