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

Item class. More...

+ Inheritance diagram for DRTIonRangeCompensatorSequence::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 getAccessoryCode (OFString &value, const signed long pos=0) const
 get AccessoryCode (300a,00f9)
OFCondition getCompensatorColumnOffset (Float32 &value, const unsigned long pos=0) const
 get CompensatorColumnOffset (300a,02e5)
OFCondition getCompensatorColumns (OFString &value, const signed long pos=0) const
 get CompensatorColumns (300a,00e8)
OFCondition getCompensatorColumns (Sint32 &value, const unsigned long pos=0) const
 get CompensatorColumns (300a,00e8)
OFCondition getCompensatorDivergence (OFString &value, const signed long pos=0) const
 get CompensatorDivergence (300a,02e0)
OFCondition getCompensatorID (OFString &value, const signed long pos=0) const
 get CompensatorID (300a,00e5)
OFCondition getCompensatorMillingToolDiameter (Float32 &value, const unsigned long pos=0) const
 get CompensatorMillingToolDiameter (300a,02e8)
OFCondition getCompensatorMountingPosition (OFString &value, const signed long pos=0) const
 get CompensatorMountingPosition (300a,02e1)
OFCondition getCompensatorNumber (OFString &value, const signed long pos=0) const
 get CompensatorNumber (300a,00e4)
OFCondition getCompensatorNumber (Sint32 &value, const unsigned long pos=0) const
 get CompensatorNumber (300a,00e4)
OFCondition getCompensatorPixelSpacing (OFString &value, const signed long pos=0) const
 get CompensatorPixelSpacing (300a,00e9)
OFCondition getCompensatorPixelSpacing (Float64 &value, const unsigned long pos=0) const
 get CompensatorPixelSpacing (300a,00e9)
OFCondition getCompensatorPixelSpacing (OFVector< Float64 > &value) const
 get CompensatorPixelSpacing (300a,00e9)
OFCondition getCompensatorPosition (OFString &value, const signed long pos=0) const
 get CompensatorPosition (300a,00ea)
OFCondition getCompensatorPosition (Float64 &value, const unsigned long pos=0) const
 get CompensatorPosition (300a,00ea)
OFCondition getCompensatorPosition (OFVector< Float64 > &value) const
 get CompensatorPosition (300a,00ea)
OFCondition getCompensatorRelativeStoppingPowerRatio (Float32 &value, const unsigned long pos=0) const
 get CompensatorRelativeStoppingPowerRatio (300a,02e7)
OFCondition getCompensatorRows (OFString &value, const signed long pos=0) const
 get CompensatorRows (300a,00e7)
OFCondition getCompensatorRows (Sint32 &value, const unsigned long pos=0) const
 get CompensatorRows (300a,00e7)
OFCondition getCompensatorThicknessData (OFString &value, const signed long pos=0) const
 get CompensatorThicknessData (300a,00ec)
OFCondition getCompensatorThicknessData (Float64 &value, const unsigned long pos=0) const
 get CompensatorThicknessData (300a,00ec)
OFCondition getCompensatorThicknessData (OFVector< Float64 > &value) const
 get CompensatorThicknessData (300a,00ec)
OFCondition getIsocenterToCompensatorDistances (Float32 &value, const unsigned long pos=0) const
 get IsocenterToCompensatorDistances (300a,02e6)
OFCondition getIsocenterToCompensatorTrayDistance (Float32 &value, const unsigned long pos=0) const
 get IsocenterToCompensatorTrayDistance (300a,02e4)
OFCondition getMaterialID (OFString &value, const signed long pos=0) const
 get MaterialID (300a,00e1)
OFCondition setAccessoryCode (const OFString &value, const OFBool check=OFTrue)
 set AccessoryCode (300a,00f9)
OFCondition setCompensatorColumnOffset (const Float32 value, const unsigned long pos=0)
 set CompensatorColumnOffset (300a,02e5)
OFCondition setCompensatorColumns (const OFString &value, const OFBool check=OFTrue)
 set CompensatorColumns (300a,00e8)
OFCondition setCompensatorDivergence (const OFString &value, const OFBool check=OFTrue)
 set CompensatorDivergence (300a,02e0)
OFCondition setCompensatorID (const OFString &value, const OFBool check=OFTrue)
 set CompensatorID (300a,00e5)
OFCondition setCompensatorMillingToolDiameter (const Float32 value, const unsigned long pos=0)
 set CompensatorMillingToolDiameter (300a,02e8)
OFCondition setCompensatorMountingPosition (const OFString &value, const OFBool check=OFTrue)
 set CompensatorMountingPosition (300a,02e1)
OFCondition setCompensatorNumber (const OFString &value, const OFBool check=OFTrue)
 set CompensatorNumber (300a,00e4)
OFCondition setCompensatorPixelSpacing (const OFString &value, const OFBool check=OFTrue)
 set CompensatorPixelSpacing (300a,00e9)
OFCondition setCompensatorPosition (const OFString &value, const OFBool check=OFTrue)
 set CompensatorPosition (300a,00ea)
OFCondition setCompensatorRelativeStoppingPowerRatio (const Float32 value, const unsigned long pos=0)
 set CompensatorRelativeStoppingPowerRatio (300a,02e7)
OFCondition setCompensatorRows (const OFString &value, const OFBool check=OFTrue)
 set CompensatorRows (300a,00e7)
OFCondition setCompensatorThicknessData (const OFString &value, const OFBool check=OFTrue)
 set CompensatorThicknessData (300a,00ec)
OFCondition setIsocenterToCompensatorDistances (const Float32 value, const unsigned long pos=0)
 set IsocenterToCompensatorDistances (300a,02e6)
OFCondition setIsocenterToCompensatorTrayDistance (const Float32 value, const unsigned long pos=0)
 set IsocenterToCompensatorTrayDistance (300a,02e4)
OFCondition setMaterialID (const OFString &value, const OFBool check=OFTrue)
 set MaterialID (300a,00e1)

Private Attributes

OFBool EmptyDefaultItem
 internal flag used to mark the empty default item
DcmLongString AccessoryCode
 AccessoryCode (300a,00f9) vr=LO, vm=1, type=3.
DcmFloatingPointSingle CompensatorColumnOffset
 CompensatorColumnOffset (300a,02e5) vr=FL, vm=1, type=1C.
DcmIntegerString CompensatorColumns
 CompensatorColumns (300a,00e8) vr=IS, vm=1, type=1.
DcmCodeString CompensatorDivergence
 CompensatorDivergence (300a,02e0) vr=CS, vm=1, type=1.
DcmShortString CompensatorID
 CompensatorID (300a,00e5) vr=SH, vm=1, type=3.
DcmFloatingPointSingle CompensatorMillingToolDiameter
 CompensatorMillingToolDiameter (300a,02e8) vr=FL, vm=1, type=3.
DcmCodeString CompensatorMountingPosition
 CompensatorMountingPosition (300a,02e1) vr=CS, vm=1, type=1.
DcmIntegerString CompensatorNumber
 CompensatorNumber (300a,00e4) vr=IS, vm=1, type=1.
DcmDecimalString CompensatorPixelSpacing
 CompensatorPixelSpacing (300a,00e9) vr=DS, vm=2, type=1.
DcmDecimalString CompensatorPosition
 CompensatorPosition (300a,00ea) vr=DS, vm=2, type=1.
DcmFloatingPointSingle CompensatorRelativeStoppingPowerRatio
 CompensatorRelativeStoppingPowerRatio (300a,02e7) vr=FL, vm=1, type=3.
DcmIntegerString CompensatorRows
 CompensatorRows (300a,00e7) vr=IS, vm=1, type=1.
DcmDecimalString CompensatorThicknessData
 CompensatorThicknessData (300a,00ec) vr=DS, vm=1-n, type=1.
DcmFloatingPointSingle IsocenterToCompensatorDistances
 IsocenterToCompensatorDistances (300a,02e6) vr=FL, vm=1-n, type=1C.
DcmFloatingPointSingle IsocenterToCompensatorTrayDistance
 IsocenterToCompensatorTrayDistance (300a,02e4) vr=FL, vm=1, type=1C.
DcmShortString MaterialID
 MaterialID (300a,00e1) vr=SH, vm=1, type=2.

Detailed Description

Item class.


Constructor & Destructor Documentation

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

OFCondition DRTIonRangeCompensatorSequence::Item::getAccessoryCode ( OFString value,
const signed long  pos = 0 
) const

get AccessoryCode (300a,00f9)

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 DRTIonRangeCompensatorSequence::Item::getCompensatorColumnOffset ( Float32 &  value,
const unsigned long  pos = 0 
) const

get CompensatorColumnOffset (300a,02e5)

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
OFCondition DRTIonRangeCompensatorSequence::Item::getCompensatorColumns ( OFString value,
const signed long  pos = 0 
) const

get CompensatorColumns (300a,00e8)

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 DRTIonRangeCompensatorSequence::Item::getCompensatorColumns ( Sint32 &  value,
const unsigned long  pos = 0 
) const

get CompensatorColumns (300a,00e8)

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
OFCondition DRTIonRangeCompensatorSequence::Item::getCompensatorDivergence ( OFString value,
const signed long  pos = 0 
) const

get CompensatorDivergence (300a,02e0)

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 DRTIonRangeCompensatorSequence::Item::getCompensatorID ( OFString value,
const signed long  pos = 0 
) const

get CompensatorID (300a,00e5)

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 DRTIonRangeCompensatorSequence::Item::getCompensatorMillingToolDiameter ( Float32 &  value,
const unsigned long  pos = 0 
) const

get CompensatorMillingToolDiameter (300a,02e8)

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 CompensatorMountingPosition (300a,02e1)

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 DRTIonRangeCompensatorSequence::Item::getCompensatorNumber ( OFString value,
const signed long  pos = 0 
) const

get CompensatorNumber (300a,00e4)

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 DRTIonRangeCompensatorSequence::Item::getCompensatorNumber ( Sint32 &  value,
const unsigned long  pos = 0 
) const

get CompensatorNumber (300a,00e4)

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 CompensatorPixelSpacing (300a,00e9)

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 DRTIonRangeCompensatorSequence::Item::getCompensatorPixelSpacing ( Float64 &  value,
const unsigned long  pos = 0 
) const

get CompensatorPixelSpacing (300a,00e9)

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 CompensatorPixelSpacing (300a,00e9)

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

get CompensatorPosition (300a,00ea)

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 DRTIonRangeCompensatorSequence::Item::getCompensatorPosition ( Float64 &  value,
const unsigned long  pos = 0 
) const

get CompensatorPosition (300a,00ea)

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 CompensatorPosition (300a,00ea)

Parameters:
valuereference to variable in which the value(s) should be stored
Returns:
status, EC_Normal if successful, an error code otherwise
OFCondition DRTIonRangeCompensatorSequence::Item::getCompensatorRelativeStoppingPowerRatio ( Float32 &  value,
const unsigned long  pos = 0 
) const

get CompensatorRelativeStoppingPowerRatio (300a,02e7)

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
OFCondition DRTIonRangeCompensatorSequence::Item::getCompensatorRows ( OFString value,
const signed long  pos = 0 
) const

get CompensatorRows (300a,00e7)

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 DRTIonRangeCompensatorSequence::Item::getCompensatorRows ( Sint32 &  value,
const unsigned long  pos = 0 
) const

get CompensatorRows (300a,00e7)

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 CompensatorThicknessData (300a,00ec)

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 DRTIonRangeCompensatorSequence::Item::getCompensatorThicknessData ( Float64 &  value,
const unsigned long  pos = 0 
) const

get CompensatorThicknessData (300a,00ec)

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 CompensatorThicknessData (300a,00ec)

Parameters:
valuereference to variable in which the value(s) should be stored
Returns:
status, EC_Normal if successful, an error code otherwise
OFCondition DRTIonRangeCompensatorSequence::Item::getIsocenterToCompensatorDistances ( Float32 &  value,
const unsigned long  pos = 0 
) const

get IsocenterToCompensatorDistances (300a,02e6)

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
OFCondition DRTIonRangeCompensatorSequence::Item::getIsocenterToCompensatorTrayDistance ( Float32 &  value,
const unsigned long  pos = 0 
) const

get IsocenterToCompensatorTrayDistance (300a,02e4)

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
OFCondition DRTIonRangeCompensatorSequence::Item::getMaterialID ( OFString value,
const signed long  pos = 0 
) const

get MaterialID (300a,00e1)

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

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& DRTIonRangeCompensatorSequence::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
OFCondition DRTIonRangeCompensatorSequence::Item::setAccessoryCode ( const OFString value,
const OFBool  check = OFTrue 
)

set AccessoryCode (300a,00f9)

Parameters:
valuevalue to be set (single value only) or "" for no value
checkcheck 'value' for conformance with VR (LO) and VM (1) if enabled
Returns:
status, EC_Normal if successful, an error code otherwise
OFCondition DRTIonRangeCompensatorSequence::Item::setCompensatorColumnOffset ( const Float32  value,
const unsigned long  pos = 0 
)

set CompensatorColumnOffset (300a,02e5)

Parameters:
valuevalue to be set (should be valid for this VR)
posindex of the value to be set (0..vm-1), vm=1
Returns:
status, EC_Normal if successful, an error code otherwise
OFCondition DRTIonRangeCompensatorSequence::Item::setCompensatorColumns ( const OFString value,
const OFBool  check = OFTrue 
)

set CompensatorColumns (300a,00e8)

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 DRTIonRangeCompensatorSequence::Item::setCompensatorDivergence ( const OFString value,
const OFBool  check = OFTrue 
)

set CompensatorDivergence (300a,02e0)

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 DRTIonRangeCompensatorSequence::Item::setCompensatorID ( const OFString value,
const OFBool  check = OFTrue 
)

set CompensatorID (300a,00e5)

Parameters:
valuevalue to be set (single value only) or "" for no value
checkcheck 'value' for conformance with VR (SH) and VM (1) if enabled
Returns:
status, EC_Normal if successful, an error code otherwise
OFCondition DRTIonRangeCompensatorSequence::Item::setCompensatorMillingToolDiameter ( const Float32  value,
const unsigned long  pos = 0 
)

set CompensatorMillingToolDiameter (300a,02e8)

Parameters:
valuevalue to be set (should be valid for this VR)
posindex of the value to be set (0..vm-1), vm=1
Returns:
status, EC_Normal if successful, an error code otherwise

set CompensatorMountingPosition (300a,02e1)

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 DRTIonRangeCompensatorSequence::Item::setCompensatorNumber ( const OFString value,
const OFBool  check = OFTrue 
)

set CompensatorNumber (300a,00e4)

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 DRTIonRangeCompensatorSequence::Item::setCompensatorPixelSpacing ( const OFString value,
const OFBool  check = OFTrue 
)

set CompensatorPixelSpacing (300a,00e9)

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 DRTIonRangeCompensatorSequence::Item::setCompensatorPosition ( const OFString value,
const OFBool  check = OFTrue 
)

set CompensatorPosition (300a,00ea)

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 DRTIonRangeCompensatorSequence::Item::setCompensatorRelativeStoppingPowerRatio ( const Float32  value,
const unsigned long  pos = 0 
)

set CompensatorRelativeStoppingPowerRatio (300a,02e7)

Parameters:
valuevalue to be set (should be valid for this VR)
posindex of the value to be set (0..vm-1), vm=1
Returns:
status, EC_Normal if successful, an error code otherwise
OFCondition DRTIonRangeCompensatorSequence::Item::setCompensatorRows ( const OFString value,
const OFBool  check = OFTrue 
)

set CompensatorRows (300a,00e7)

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 DRTIonRangeCompensatorSequence::Item::setCompensatorThicknessData ( const OFString value,
const OFBool  check = OFTrue 
)

set CompensatorThicknessData (300a,00ec)

Parameters:
valuevalue to be set (possibly multi-valued) or "" for no value
checkcheck 'value' for conformance with VR (DS) and VM (1-n) if enabled
Returns:
status, EC_Normal if successful, an error code otherwise
OFCondition DRTIonRangeCompensatorSequence::Item::setIsocenterToCompensatorDistances ( const Float32  value,
const unsigned long  pos = 0 
)

set IsocenterToCompensatorDistances (300a,02e6)

Parameters:
valuevalue to be set (should be valid for this VR)
posindex of the value to be set (0..vm-1), vm=1-n
Returns:
status, EC_Normal if successful, an error code otherwise
OFCondition DRTIonRangeCompensatorSequence::Item::setIsocenterToCompensatorTrayDistance ( const Float32  value,
const unsigned long  pos = 0 
)

set IsocenterToCompensatorTrayDistance (300a,02e4)

Parameters:
valuevalue to be set (should be valid for this VR)
posindex of the value to be set (0..vm-1), vm=1
Returns:
status, EC_Normal if successful, an error code otherwise
OFCondition DRTIonRangeCompensatorSequence::Item::setMaterialID ( const OFString value,
const OFBool  check = OFTrue 
)

set MaterialID (300a,00e1)

Parameters:
valuevalue to be set (single value only) or "" for no value
checkcheck 'value' for conformance with VR (SH) 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