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

Item class. More...

+ Inheritance diagram for DRTIonControlPointSequence::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 getBeamLimitingDeviceAngle (OFString &value, const signed long pos=0) const
 get BeamLimitingDeviceAngle (300a,0120)
OFCondition getBeamLimitingDeviceAngle (Float64 &value, const unsigned long pos=0) const
 get BeamLimitingDeviceAngle (300a,0120)
OFCondition getBeamLimitingDeviceRotationDirection (OFString &value, const signed long pos=0) const
 get BeamLimitingDeviceRotationDirection (300a,0121)
OFCondition getControlPointIndex (OFString &value, const signed long pos=0) const
 get ControlPointIndex (300a,0112)
OFCondition getControlPointIndex (Sint32 &value, const unsigned long pos=0) const
 get ControlPointIndex (300a,0112)
OFCondition getCumulativeMetersetWeight (OFString &value, const signed long pos=0) const
 get CumulativeMetersetWeight (300a,0134)
OFCondition getCumulativeMetersetWeight (Float64 &value, const unsigned long pos=0) const
 get CumulativeMetersetWeight (300a,0134)
OFCondition getGantryAngle (OFString &value, const signed long pos=0) const
 get GantryAngle (300a,011e)
OFCondition getGantryAngle (Float64 &value, const unsigned long pos=0) const
 get GantryAngle (300a,011e)
OFCondition getGantryPitchAngle (Float32 &value, const unsigned long pos=0) const
 get GantryPitchAngle (300a,014a)
OFCondition getGantryPitchRotationDirection (OFString &value, const signed long pos=0) const
 get GantryPitchRotationDirection (300a,014c)
OFCondition getGantryRotationDirection (OFString &value, const signed long pos=0) const
 get GantryRotationDirection (300a,011f)
OFCondition getHeadFixationAngle (Float32 &value, const unsigned long pos=0) const
 get HeadFixationAngle (300a,0148)
OFCondition getIsocenterPosition (OFString &value, const signed long pos=0) const
 get IsocenterPosition (300a,012c)
OFCondition getIsocenterPosition (Float64 &value, const unsigned long pos=0) const
 get IsocenterPosition (300a,012c)
OFCondition getIsocenterPosition (OFVector< Float64 > &value) const
 get IsocenterPosition (300a,012c)
OFCondition getKVP (OFString &value, const signed long pos=0) const
 get KVP (0018,0060)
OFCondition getKVP (Float64 &value, const unsigned long pos=0) const
 get KVP (0018,0060)
OFCondition getMetersetRate (Float32 &value, const unsigned long pos=0) const
 get MetersetRate (300a,035a)
OFCondition getNominalBeamEnergy (OFString &value, const signed long pos=0) const
 get NominalBeamEnergy (300a,0114)
OFCondition getNominalBeamEnergy (Float64 &value, const unsigned long pos=0) const
 get NominalBeamEnergy (300a,0114)
OFCondition getNumberOfPaintings (OFString &value, const signed long pos=0) const
 get NumberOfPaintings (300a,039a)
OFCondition getNumberOfPaintings (Sint32 &value, const unsigned long pos=0) const
 get NumberOfPaintings (300a,039a)
OFCondition getNumberOfScanSpotPositions (OFString &value, const signed long pos=0) const
 get NumberOfScanSpotPositions (300a,0392)
OFCondition getNumberOfScanSpotPositions (Sint32 &value, const unsigned long pos=0) const
 get NumberOfScanSpotPositions (300a,0392)
OFCondition getPatientSupportAngle (OFString &value, const signed long pos=0) const
 get PatientSupportAngle (300a,0122)
OFCondition getPatientSupportAngle (Float64 &value, const unsigned long pos=0) const
 get PatientSupportAngle (300a,0122)
OFCondition getPatientSupportRotationDirection (OFString &value, const signed long pos=0) const
 get PatientSupportRotationDirection (300a,0123)
OFCondition getScanSpotMetersetWeights (Float32 &value, const unsigned long pos=0) const
 get ScanSpotMetersetWeights (300a,0396)
OFCondition getScanSpotPositionMap (Float32 &value, const unsigned long pos=0) const
 get ScanSpotPositionMap (300a,0394)
OFCondition getScanSpotTuneID (OFString &value, const signed long pos=0) const
 get ScanSpotTuneID (300a,0390)
OFCondition getScanningSpotSize (Float32 &value, const unsigned long pos=0) const
 get ScanningSpotSize (300a,0398)
OFCondition getSnoutPosition (Float32 &value, const unsigned long pos=0) const
 get SnoutPosition (300a,030d)
OFCondition getSurfaceEntryPoint (OFString &value, const signed long pos=0) const
 get SurfaceEntryPoint (300a,012e)
OFCondition getSurfaceEntryPoint (Float64 &value, const unsigned long pos=0) const
 get SurfaceEntryPoint (300a,012e)
OFCondition getSurfaceEntryPoint (OFVector< Float64 > &value) const
 get SurfaceEntryPoint (300a,012e)
OFCondition getTableTopLateralPosition (OFString &value, const signed long pos=0) const
 get TableTopLateralPosition (300a,012a)
OFCondition getTableTopLateralPosition (Float64 &value, const unsigned long pos=0) const
 get TableTopLateralPosition (300a,012a)
OFCondition getTableTopLongitudinalPosition (OFString &value, const signed long pos=0) const
 get TableTopLongitudinalPosition (300a,0129)
OFCondition getTableTopLongitudinalPosition (Float64 &value, const unsigned long pos=0) const
 get TableTopLongitudinalPosition (300a,0129)
OFCondition getTableTopPitchAngle (Float32 &value, const unsigned long pos=0) const
 get TableTopPitchAngle (300a,0140)
OFCondition getTableTopPitchRotationDirection (OFString &value, const signed long pos=0) const
 get TableTopPitchRotationDirection (300a,0142)
OFCondition getTableTopRollAngle (Float32 &value, const unsigned long pos=0) const
 get TableTopRollAngle (300a,0144)
OFCondition getTableTopRollRotationDirection (OFString &value, const signed long pos=0) const
 get TableTopRollRotationDirection (300a,0146)
OFCondition getTableTopVerticalPosition (OFString &value, const signed long pos=0) const
 get TableTopVerticalPosition (300a,0128)
OFCondition getTableTopVerticalPosition (Float64 &value, const unsigned long pos=0) const
 get TableTopVerticalPosition (300a,0128)
DRTBeamLimitingDevicePositionSequencegetBeamLimitingDevicePositionSequence ()
 get BeamLimitingDevicePositionSequence (300a,011a)
const
DRTBeamLimitingDevicePositionSequence
getBeamLimitingDevicePositionSequence () const
 get BeamLimitingDevicePositionSequence (300a,011a)
DRTIonWedgePositionSequencegetIonWedgePositionSequence ()
 get IonWedgePositionSequence (300a,03ac)
const DRTIonWedgePositionSequencegetIonWedgePositionSequence () const
 get IonWedgePositionSequence (300a,03ac)
DRTLateralSpreadingDeviceSettingsSequenceInRTIonBeamsModulegetLateralSpreadingDeviceSettingsSequence ()
 get LateralSpreadingDeviceSettingsSequence (300a,0370)
const
DRTLateralSpreadingDeviceSettingsSequenceInRTIonBeamsModule
getLateralSpreadingDeviceSettingsSequence () const
 get LateralSpreadingDeviceSettingsSequence (300a,0370)
DRTRangeModulatorSettingsSequenceInRTIonBeamsModulegetRangeModulatorSettingsSequence ()
 get RangeModulatorSettingsSequence (300a,0380)
const
DRTRangeModulatorSettingsSequenceInRTIonBeamsModule
getRangeModulatorSettingsSequence () const
 get RangeModulatorSettingsSequence (300a,0380)
DRTRangeShifterSettingsSequenceInRTIonBeamsModulegetRangeShifterSettingsSequence ()
 get RangeShifterSettingsSequence (300a,0360)
const
DRTRangeShifterSettingsSequenceInRTIonBeamsModule
getRangeShifterSettingsSequence () const
 get RangeShifterSettingsSequence (300a,0360)
DRTReferencedDoseReferenceSequenceInRTIonBeamsModulegetReferencedDoseReferenceSequence ()
 get ReferencedDoseReferenceSequence (300c,0050)
const
DRTReferencedDoseReferenceSequenceInRTIonBeamsModule
getReferencedDoseReferenceSequence () const
 get ReferencedDoseReferenceSequence (300c,0050)
OFCondition setBeamLimitingDeviceAngle (const OFString &value, const OFBool check=OFTrue)
 set BeamLimitingDeviceAngle (300a,0120)
OFCondition setBeamLimitingDeviceRotationDirection (const OFString &value, const OFBool check=OFTrue)
 set BeamLimitingDeviceRotationDirection (300a,0121)
OFCondition setControlPointIndex (const OFString &value, const OFBool check=OFTrue)
 set ControlPointIndex (300a,0112)
OFCondition setCumulativeMetersetWeight (const OFString &value, const OFBool check=OFTrue)
 set CumulativeMetersetWeight (300a,0134)
OFCondition setGantryAngle (const OFString &value, const OFBool check=OFTrue)
 set GantryAngle (300a,011e)
OFCondition setGantryPitchAngle (const Float32 value, const unsigned long pos=0)
 set GantryPitchAngle (300a,014a)
OFCondition setGantryPitchRotationDirection (const OFString &value, const OFBool check=OFTrue)
 set GantryPitchRotationDirection (300a,014c)
OFCondition setGantryRotationDirection (const OFString &value, const OFBool check=OFTrue)
 set GantryRotationDirection (300a,011f)
OFCondition setHeadFixationAngle (const Float32 value, const unsigned long pos=0)
 set HeadFixationAngle (300a,0148)
OFCondition setIsocenterPosition (const OFString &value, const OFBool check=OFTrue)
 set IsocenterPosition (300a,012c)
OFCondition setKVP (const OFString &value, const OFBool check=OFTrue)
 set KVP (0018,0060)
OFCondition setMetersetRate (const Float32 value, const unsigned long pos=0)
 set MetersetRate (300a,035a)
OFCondition setNominalBeamEnergy (const OFString &value, const OFBool check=OFTrue)
 set NominalBeamEnergy (300a,0114)
OFCondition setNumberOfPaintings (const OFString &value, const OFBool check=OFTrue)
 set NumberOfPaintings (300a,039a)
OFCondition setNumberOfScanSpotPositions (const OFString &value, const OFBool check=OFTrue)
 set NumberOfScanSpotPositions (300a,0392)
OFCondition setPatientSupportAngle (const OFString &value, const OFBool check=OFTrue)
 set PatientSupportAngle (300a,0122)
OFCondition setPatientSupportRotationDirection (const OFString &value, const OFBool check=OFTrue)
 set PatientSupportRotationDirection (300a,0123)
OFCondition setScanSpotMetersetWeights (const Float32 value, const unsigned long pos=0)
 set ScanSpotMetersetWeights (300a,0396)
OFCondition setScanSpotPositionMap (const Float32 value, const unsigned long pos=0)
 set ScanSpotPositionMap (300a,0394)
OFCondition setScanSpotTuneID (const OFString &value, const OFBool check=OFTrue)
 set ScanSpotTuneID (300a,0390)
OFCondition setScanningSpotSize (const Float32 value, const unsigned long pos=0)
 set ScanningSpotSize (300a,0398)
OFCondition setSnoutPosition (const Float32 value, const unsigned long pos=0)
 set SnoutPosition (300a,030d)
OFCondition setSurfaceEntryPoint (const OFString &value, const OFBool check=OFTrue)
 set SurfaceEntryPoint (300a,012e)
OFCondition setTableTopLateralPosition (const OFString &value, const OFBool check=OFTrue)
 set TableTopLateralPosition (300a,012a)
OFCondition setTableTopLongitudinalPosition (const OFString &value, const OFBool check=OFTrue)
 set TableTopLongitudinalPosition (300a,0129)
OFCondition setTableTopPitchAngle (const Float32 value, const unsigned long pos=0)
 set TableTopPitchAngle (300a,0140)
OFCondition setTableTopPitchRotationDirection (const OFString &value, const OFBool check=OFTrue)
 set TableTopPitchRotationDirection (300a,0142)
OFCondition setTableTopRollAngle (const Float32 value, const unsigned long pos=0)
 set TableTopRollAngle (300a,0144)
OFCondition setTableTopRollRotationDirection (const OFString &value, const OFBool check=OFTrue)
 set TableTopRollRotationDirection (300a,0146)
OFCondition setTableTopVerticalPosition (const OFString &value, const OFBool check=OFTrue)
 set TableTopVerticalPosition (300a,0128)

Private Attributes

OFBool EmptyDefaultItem
 internal flag used to mark the empty default item
DcmDecimalString BeamLimitingDeviceAngle
 BeamLimitingDeviceAngle (300a,0120) vr=DS, vm=1, type=1C.
DRTBeamLimitingDevicePositionSequence BeamLimitingDevicePositionSequence
 BeamLimitingDevicePositionSequence (300a,011a) vr=SQ, vm=1, type=1C.
DcmCodeString BeamLimitingDeviceRotationDirection
 BeamLimitingDeviceRotationDirection (300a,0121) vr=CS, vm=1, type=1C.
DcmIntegerString ControlPointIndex
 ControlPointIndex (300a,0112) vr=IS, vm=1, type=1.
DcmDecimalString CumulativeMetersetWeight
 CumulativeMetersetWeight (300a,0134) vr=DS, vm=1, type=2.
DcmDecimalString GantryAngle
 GantryAngle (300a,011e) vr=DS, vm=1, type=1C.
DcmFloatingPointSingle GantryPitchAngle
 GantryPitchAngle (300a,014a) vr=FL, vm=1, type=2C.
DcmCodeString GantryPitchRotationDirection
 GantryPitchRotationDirection (300a,014c) vr=CS, vm=1, type=2C.
DcmCodeString GantryRotationDirection
 GantryRotationDirection (300a,011f) vr=CS, vm=1, type=1C.
DcmFloatingPointSingle HeadFixationAngle
 HeadFixationAngle (300a,0148) vr=FL, vm=1, type=3.
DRTIonWedgePositionSequence IonWedgePositionSequence
 IonWedgePositionSequence (300a,03ac) vr=SQ, vm=1, type=1C.
DcmDecimalString IsocenterPosition
 IsocenterPosition (300a,012c) vr=DS, vm=3, type=2C.
DcmDecimalString KVP
 KVP (0018,0060) vr=DS, vm=1, type=1C.
DRTLateralSpreadingDeviceSettingsSequenceInRTIonBeamsModule LateralSpreadingDeviceSettingsSequence
 LateralSpreadingDeviceSettingsSequence (300a,0370) vr=SQ, vm=1, type=1C.
DcmFloatingPointSingle MetersetRate
 MetersetRate (300a,035a) vr=FL, vm=1, type=3.
DcmDecimalString NominalBeamEnergy
 NominalBeamEnergy (300a,0114) vr=DS, vm=1, type=1C.
DcmIntegerString NumberOfPaintings
 NumberOfPaintings (300a,039a) vr=IS, vm=1, type=1C.
DcmIntegerString NumberOfScanSpotPositions
 NumberOfScanSpotPositions (300a,0392) vr=IS, vm=1, type=1C.
DcmDecimalString PatientSupportAngle
 PatientSupportAngle (300a,0122) vr=DS, vm=1, type=1C.
DcmCodeString PatientSupportRotationDirection
 PatientSupportRotationDirection (300a,0123) vr=CS, vm=1, type=1C.
DRTRangeModulatorSettingsSequenceInRTIonBeamsModule RangeModulatorSettingsSequence
 RangeModulatorSettingsSequence (300a,0380) vr=SQ, vm=1, type=1C.
DRTRangeShifterSettingsSequenceInRTIonBeamsModule RangeShifterSettingsSequence
 RangeShifterSettingsSequence (300a,0360) vr=SQ, vm=1, type=1C.
DRTReferencedDoseReferenceSequenceInRTIonBeamsModule ReferencedDoseReferenceSequence
 ReferencedDoseReferenceSequence (300c,0050) vr=SQ, vm=1, type=3.
DcmFloatingPointSingle ScanSpotMetersetWeights
 ScanSpotMetersetWeights (300a,0396) vr=FL, vm=1-n, type=1C.
DcmFloatingPointSingle ScanSpotPositionMap
 ScanSpotPositionMap (300a,0394) vr=FL, vm=1-n, type=1C.
DcmShortString ScanSpotTuneID
 ScanSpotTuneID (300a,0390) vr=SH, vm=1, type=1C.
DcmFloatingPointSingle ScanningSpotSize
 ScanningSpotSize (300a,0398) vr=FL, vm=2, type=3.
DcmFloatingPointSingle SnoutPosition
 SnoutPosition (300a,030d) vr=FL, vm=1, type=2C.
DcmDecimalString SurfaceEntryPoint
 SurfaceEntryPoint (300a,012e) vr=DS, vm=3, type=3.
DcmDecimalString TableTopLateralPosition
 TableTopLateralPosition (300a,012a) vr=DS, vm=1, type=2C.
DcmDecimalString TableTopLongitudinalPosition
 TableTopLongitudinalPosition (300a,0129) vr=DS, vm=1, type=2C.
DcmFloatingPointSingle TableTopPitchAngle
 TableTopPitchAngle (300a,0140) vr=FL, vm=1, type=2C.
DcmCodeString TableTopPitchRotationDirection
 TableTopPitchRotationDirection (300a,0142) vr=CS, vm=1, type=2C.
DcmFloatingPointSingle TableTopRollAngle
 TableTopRollAngle (300a,0144) vr=FL, vm=1, type=2C.
DcmCodeString TableTopRollRotationDirection
 TableTopRollRotationDirection (300a,0146) vr=CS, vm=1, type=2C.
DcmDecimalString TableTopVerticalPosition
 TableTopVerticalPosition (300a,0128) vr=DS, vm=1, type=2C.

Detailed Description

Item class.


Constructor & Destructor Documentation

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

get BeamLimitingDeviceAngle (300a,0120)

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

get BeamLimitingDeviceAngle (300a,0120)

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 BeamLimitingDevicePositionSequence (300a,011a)

Returns:
reference to sequence element

get BeamLimitingDevicePositionSequence (300a,011a)

Returns:
const reference to sequence element

get BeamLimitingDeviceRotationDirection (300a,0121)

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

get ControlPointIndex (300a,0112)

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

get ControlPointIndex (300a,0112)

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

get CumulativeMetersetWeight (300a,0134)

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

get CumulativeMetersetWeight (300a,0134)

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

get GantryAngle (300a,011e)

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

get GantryAngle (300a,011e)

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

get GantryPitchAngle (300a,014a)

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 GantryPitchRotationDirection (300a,014c)

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

get GantryRotationDirection (300a,011f)

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

get HeadFixationAngle (300a,0148)

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 IonWedgePositionSequence (300a,03ac)

Returns:
reference to sequence element

get IonWedgePositionSequence (300a,03ac)

Returns:
const reference to sequence element
OFCondition DRTIonControlPointSequence::Item::getIsocenterPosition ( OFString value,
const signed long  pos = 0 
) const

get IsocenterPosition (300a,012c)

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

get IsocenterPosition (300a,012c)

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 IsocenterPosition (300a,012c)

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

get KVP (0018,0060)

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

get KVP (0018,0060)

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 LateralSpreadingDeviceSettingsSequence (300a,0370)

Returns:
reference to sequence element

get LateralSpreadingDeviceSettingsSequence (300a,0370)

Returns:
const reference to sequence element
OFCondition DRTIonControlPointSequence::Item::getMetersetRate ( Float32 &  value,
const unsigned long  pos = 0 
) const

get MetersetRate (300a,035a)

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

get NominalBeamEnergy (300a,0114)

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

get NominalBeamEnergy (300a,0114)

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

get NumberOfPaintings (300a,039a)

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

get NumberOfPaintings (300a,039a)

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

get NumberOfScanSpotPositions (300a,0392)

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

get NumberOfScanSpotPositions (300a,0392)

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

get PatientSupportAngle (300a,0122)

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

get PatientSupportAngle (300a,0122)

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 PatientSupportRotationDirection (300a,0123)

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

get RangeModulatorSettingsSequence (300a,0380)

Returns:
reference to sequence element

get RangeModulatorSettingsSequence (300a,0380)

Returns:
const reference to sequence element

get RangeShifterSettingsSequence (300a,0360)

Returns:
reference to sequence element

get RangeShifterSettingsSequence (300a,0360)

Returns:
const reference to sequence element

get ReferencedDoseReferenceSequence (300c,0050)

Returns:
reference to sequence element

get ReferencedDoseReferenceSequence (300c,0050)

Returns:
const reference to sequence element
OFCondition DRTIonControlPointSequence::Item::getScanningSpotSize ( Float32 &  value,
const unsigned long  pos = 0 
) const

get ScanningSpotSize (300a,0398)

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

get ScanSpotMetersetWeights (300a,0396)

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

get ScanSpotPositionMap (300a,0394)

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

get ScanSpotTuneID (300a,0390)

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

get SnoutPosition (300a,030d)

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

get SurfaceEntryPoint (300a,012e)

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

get SurfaceEntryPoint (300a,012e)

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 SurfaceEntryPoint (300a,012e)

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

get TableTopLateralPosition (300a,012a)

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

get TableTopLateralPosition (300a,012a)

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 TableTopLongitudinalPosition (300a,0129)

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

get TableTopLongitudinalPosition (300a,0129)

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

get TableTopPitchAngle (300a,0140)

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 TableTopPitchRotationDirection (300a,0142)

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

get TableTopRollAngle (300a,0144)

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 TableTopRollRotationDirection (300a,0146)

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

get TableTopVerticalPosition (300a,0128)

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

get TableTopVerticalPosition (300a,0128)

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

set BeamLimitingDeviceAngle (300a,0120)

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 BeamLimitingDeviceRotationDirection (300a,0121)

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

set ControlPointIndex (300a,0112)

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

set CumulativeMetersetWeight (300a,0134)

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

set GantryAngle (300a,011e)

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

set GantryPitchAngle (300a,014a)

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

set GantryPitchRotationDirection (300a,014c)

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

set GantryRotationDirection (300a,011f)

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

set HeadFixationAngle (300a,0148)

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

set IsocenterPosition (300a,012c)

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

set KVP (0018,0060)

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

set MetersetRate (300a,035a)

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

set NominalBeamEnergy (300a,0114)

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

set NumberOfPaintings (300a,039a)

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

set NumberOfScanSpotPositions (300a,0392)

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

set PatientSupportAngle (300a,0122)

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 PatientSupportRotationDirection (300a,0123)

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

set ScanningSpotSize (300a,0398)

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

set ScanSpotMetersetWeights (300a,0396)

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

set ScanSpotPositionMap (300a,0394)

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

set ScanSpotTuneID (300a,0390)

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

set SnoutPosition (300a,030d)

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

set SurfaceEntryPoint (300a,012e)

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

set TableTopLateralPosition (300a,012a)

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

set TableTopLongitudinalPosition (300a,0129)

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

set TableTopPitchAngle (300a,0140)

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 TableTopPitchRotationDirection (300a,0142)

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

set TableTopRollAngle (300a,0144)

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

set TableTopRollRotationDirection (300a,0146)

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

set TableTopVerticalPosition (300a,0128)

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