DRTControlPointSequence::Item Class Reference

Item class. More...

Inheritance diagram for DRTControlPointSequence::Item:

List of all members.

Public Member Functions
	Item (const OFBool emptyDefaultItem=OFFalse)
	(default) constructor
	Item (const Item &copy)
	copy constructor
virtual	~Item ()
	destructor
Item &	operator= (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	getDoseRateSet (OFString &value, const signed long pos=0) const
	get DoseRateSet (300a,0115)
OFCondition	getDoseRateSet (Float64 &value, const unsigned long pos=0) const
	get DoseRateSet (300a,0115)
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	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	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	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	getSourceToSurfaceDistance (OFString &value, const signed long pos=0) const
	get SourceToSurfaceDistance (300a,0130)
OFCondition	getSourceToSurfaceDistance (Float64 &value, const unsigned long pos=0) const
	get SourceToSurfaceDistance (300a,0130)
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	getTableTopEccentricAngle (OFString &value, const signed long pos=0) const
	get TableTopEccentricAngle (300a,0125)
OFCondition	getTableTopEccentricAngle (Float64 &value, const unsigned long pos=0) const
	get TableTopEccentricAngle (300a,0125)
OFCondition	getTableTopEccentricAxisDistance (OFString &value, const signed long pos=0) const
	get TableTopEccentricAxisDistance (300a,0124)
OFCondition	getTableTopEccentricAxisDistance (Float64 &value, const unsigned long pos=0) const
	get TableTopEccentricAxisDistance (300a,0124)
OFCondition	getTableTopEccentricRotationDirection (OFString &value, const signed long pos=0) const
	get TableTopEccentricRotationDirection (300a,0126)
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	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)
DRTBeamLimitingDevicePositionSequence &	getBeamLimitingDevicePositionSequence ()
	get BeamLimitingDevicePositionSequence (300a,011a)
const DRTBeamLimitingDevicePositionSequence &	getBeamLimitingDevicePositionSequence () const
	get BeamLimitingDevicePositionSequence (300a,011a)
DRTReferencedDoseReferenceSequenceInRTBeamsModule &	getReferencedDoseReferenceSequence ()
	get ReferencedDoseReferenceSequence (300c,0050)
const DRTReferencedDoseReferenceSequenceInRTBeamsModule &	getReferencedDoseReferenceSequence () const
	get ReferencedDoseReferenceSequence (300c,0050)
DRTReferencedDoseSequence &	getReferencedDoseSequence ()
	get ReferencedDoseSequence (300c,0080)
const DRTReferencedDoseSequence &	getReferencedDoseSequence () const
	get ReferencedDoseSequence (300c,0080)
DRTWedgePositionSequence &	getWedgePositionSequence ()
	get WedgePositionSequence (300a,0116)
const DRTWedgePositionSequence &	getWedgePositionSequence () const
	get WedgePositionSequence (300a,0116)
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	setDoseRateSet (const OFString &value, const OFBool check=OFTrue)
	set DoseRateSet (300a,0115)
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	setIsocenterPosition (const OFString &value, const OFBool check=OFTrue)
	set IsocenterPosition (300a,012c)
OFCondition	setNominalBeamEnergy (const OFString &value, const OFBool check=OFTrue)
	set NominalBeamEnergy (300a,0114)
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	setSourceToSurfaceDistance (const OFString &value, const OFBool check=OFTrue)
	set SourceToSurfaceDistance (300a,0130)
OFCondition	setSurfaceEntryPoint (const OFString &value, const OFBool check=OFTrue)
	set SurfaceEntryPoint (300a,012e)
OFCondition	setTableTopEccentricAngle (const OFString &value, const OFBool check=OFTrue)
	set TableTopEccentricAngle (300a,0125)
OFCondition	setTableTopEccentricAxisDistance (const OFString &value, const OFBool check=OFTrue)
	set TableTopEccentricAxisDistance (300a,0124)
OFCondition	setTableTopEccentricRotationDirection (const OFString &value, const OFBool check=OFTrue)
	set TableTopEccentricRotationDirection (300a,0126)
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	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=1C.
DcmDecimalString	CumulativeMetersetWeight
	CumulativeMetersetWeight (300a,0134) vr=DS, vm=1, type=2C.
DcmDecimalString	DoseRateSet
	DoseRateSet (300a,0115) vr=DS, vm=1, type=3.
DcmDecimalString	GantryAngle
	GantryAngle (300a,011e) vr=DS, vm=1, type=1C.
DcmFloatingPointSingle	GantryPitchAngle
	GantryPitchAngle (300a,014a) vr=FL, vm=1, type=3.
DcmCodeString	GantryPitchRotationDirection
	GantryPitchRotationDirection (300a,014c) vr=CS, vm=1, type=3.
DcmCodeString	GantryRotationDirection
	GantryRotationDirection (300a,011f) vr=CS, vm=1, type=1C.
DcmDecimalString	IsocenterPosition
	IsocenterPosition (300a,012c) vr=DS, vm=3, type=2C.
DcmDecimalString	NominalBeamEnergy
	NominalBeamEnergy (300a,0114) vr=DS, vm=1, type=3.
DcmDecimalString	PatientSupportAngle
	PatientSupportAngle (300a,0122) vr=DS, vm=1, type=1C.
DcmCodeString	PatientSupportRotationDirection
	PatientSupportRotationDirection (300a,0123) vr=CS, vm=1, type=1C.
DRTReferencedDoseReferenceSequenceInRTBeamsModule	ReferencedDoseReferenceSequence
	ReferencedDoseReferenceSequence (300c,0050) vr=SQ, vm=1, type=3.
DRTReferencedDoseSequence	ReferencedDoseSequence
	ReferencedDoseSequence (300c,0080) vr=SQ, vm=1, type=1C.
DcmDecimalString	SourceToSurfaceDistance
	SourceToSurfaceDistance (300a,0130) vr=DS, vm=1, type=3.
DcmDecimalString	SurfaceEntryPoint
	SurfaceEntryPoint (300a,012e) vr=DS, vm=3, type=3.
DcmDecimalString	TableTopEccentricAngle
	TableTopEccentricAngle (300a,0125) vr=DS, vm=1, type=1C.
DcmDecimalString	TableTopEccentricAxisDistance
	TableTopEccentricAxisDistance (300a,0124) vr=DS, vm=1, type=3.
DcmCodeString	TableTopEccentricRotationDirection
	TableTopEccentricRotationDirection (300a,0126) vr=CS, vm=1, type=1C.
DcmDecimalString	TableTopLateralPosition
	TableTopLateralPosition (300a,012a) vr=DS, vm=1, type=2C.
DcmDecimalString	TableTopLongitudinalPosition
	TableTopLongitudinalPosition (300a,0129) vr=DS, vm=1, type=2C.
DcmDecimalString	TableTopVerticalPosition
	TableTopVerticalPosition (300a,0128) vr=DS, vm=1, type=2C.
DRTWedgePositionSequence	WedgePositionSequence
	WedgePositionSequence (300a,0116) vr=SQ, vm=1, type=3.

---

Detailed Description

Item class.

---

Constructor & Destructor Documentation

DRTControlPointSequence::Item::Item

(

const OFBool

emptyDefaultItem = OFFalse

)

(default) constructor

Parameters:

emptyDefaultItem

flag used to mark the empty default item

DRTControlPointSequence::Item::Item

(

const Item &

copy

)

copy constructor

Parameters:

copy	item object to be copied

---

Member Function Documentation

OFCondition DRTControlPointSequence::Item::getBeamLimitingDeviceAngle	(	OFString &	value,
		const signed long	pos = 0
	)		const

get BeamLimitingDeviceAngle (300a,0120)

Parameters:

value	reference to variable in which the value should be stored
pos	index of the value to get (0..vm-1), -1 for all components

Returns:

status, EC_Normal if successful, an error code otherwise

OFCondition DRTControlPointSequence::Item::getBeamLimitingDeviceAngle	(	Float64 &	value,
		const unsigned long	pos = 0
	)		const

get BeamLimitingDeviceAngle (300a,0120)

Parameters:

value	reference to variable in which the value should be stored
pos	index of the value to get (0..vm-1)

Returns:

status, EC_Normal if successful, an error code otherwise

DRTBeamLimitingDevicePositionSequence& DRTControlPointSequence::Item::getBeamLimitingDevicePositionSequence

(

)

[inline]

get BeamLimitingDevicePositionSequence (300a,011a)

Returns:

reference to sequence element

const DRTBeamLimitingDevicePositionSequence& DRTControlPointSequence::Item::getBeamLimitingDevicePositionSequence

(

)

const [inline]

get BeamLimitingDevicePositionSequence (300a,011a)

Returns:

const reference to sequence element

OFCondition DRTControlPointSequence::Item::getBeamLimitingDeviceRotationDirection	(	OFString &	value,
		const signed long	pos = 0
	)		const

get BeamLimitingDeviceRotationDirection (300a,0121)

Parameters:

value	reference to variable in which the value should be stored
pos	index of the value to get (0..vm-1), -1 for all components

Returns:

status, EC_Normal if successful, an error code otherwise

OFCondition DRTControlPointSequence::Item::getControlPointIndex	(	OFString &	value,
		const signed long	pos = 0
	)		const

get ControlPointIndex (300a,0112)

Parameters:

value	reference to variable in which the value should be stored
pos	index of the value to get (0..vm-1), -1 for all components

Returns:

status, EC_Normal if successful, an error code otherwise

OFCondition DRTControlPointSequence::Item::getControlPointIndex	(	Sint32 &	value,
		const unsigned long	pos = 0
	)		const

get ControlPointIndex (300a,0112)

Parameters:

value	reference to variable in which the value should be stored
pos	index of the value to get (0..vm-1)

Returns:

status, EC_Normal if successful, an error code otherwise

OFCondition DRTControlPointSequence::Item::getCumulativeMetersetWeight	(	OFString &	value,
		const signed long	pos = 0
	)		const

get CumulativeMetersetWeight (300a,0134)

Parameters:

value	reference to variable in which the value should be stored
pos	index of the value to get (0..vm-1), -1 for all components

Returns:

status, EC_Normal if successful, an error code otherwise

OFCondition DRTControlPointSequence::Item::getCumulativeMetersetWeight	(	Float64 &	value,
		const unsigned long	pos = 0
	)		const

get CumulativeMetersetWeight (300a,0134)

Parameters:

value	reference to variable in which the value should be stored
pos	index of the value to get (0..vm-1)

Returns:

status, EC_Normal if successful, an error code otherwise

OFCondition DRTControlPointSequence::Item::getDoseRateSet	(	OFString &	value,
		const signed long	pos = 0
	)		const

get DoseRateSet (300a,0115)

Parameters:

value	reference to variable in which the value should be stored
pos	index of the value to get (0..vm-1), -1 for all components

Returns:

status, EC_Normal if successful, an error code otherwise

OFCondition DRTControlPointSequence::Item::getDoseRateSet	(	Float64 &	value,
		const unsigned long	pos = 0
	)		const

get DoseRateSet (300a,0115)

Parameters:

value	reference to variable in which the value should be stored
pos	index of the value to get (0..vm-1)

Returns:

status, EC_Normal if successful, an error code otherwise

OFCondition DRTControlPointSequence::Item::getGantryAngle	(	OFString &	value,
		const signed long	pos = 0
	)		const

get GantryAngle (300a,011e)

Parameters:

value	reference to variable in which the value should be stored
pos	index of the value to get (0..vm-1), -1 for all components

Returns:

status, EC_Normal if successful, an error code otherwise

OFCondition DRTControlPointSequence::Item::getGantryAngle	(	Float64 &	value,
		const unsigned long	pos = 0
	)		const

get GantryAngle (300a,011e)

Parameters:

value	reference to variable in which the value should be stored
pos	index of the value to get (0..vm-1)

Returns:

status, EC_Normal if successful, an error code otherwise

OFCondition DRTControlPointSequence::Item::getGantryPitchAngle	(	Float32 &	value,
		const unsigned long	pos = 0
	)		const

get GantryPitchAngle (300a,014a)

Parameters:

value	reference to variable in which the value should be stored
pos	index of the value to get (0..vm-1)

Returns:

status, EC_Normal if successful, an error code otherwise

OFCondition DRTControlPointSequence::Item::getGantryPitchRotationDirection	(	OFString &	value,
		const signed long	pos = 0
	)		const

get GantryPitchRotationDirection (300a,014c)

Parameters:

value	reference to variable in which the value should be stored
pos	index of the value to get (0..vm-1), -1 for all components

Returns:

status, EC_Normal if successful, an error code otherwise

OFCondition DRTControlPointSequence::Item::getGantryRotationDirection	(	OFString &	value,
		const signed long	pos = 0
	)		const

get GantryRotationDirection (300a,011f)

Parameters:

value	reference to variable in which the value should be stored
pos	index of the value to get (0..vm-1), -1 for all components

Returns:

status, EC_Normal if successful, an error code otherwise

OFCondition DRTControlPointSequence::Item::getIsocenterPosition	(	OFString &	value,
		const signed long	pos = 0
	)		const

get IsocenterPosition (300a,012c)

Parameters:

value	reference to variable in which the value should be stored
pos	index of the value to get (0..vm-1), -1 for all components

Returns:

status, EC_Normal if successful, an error code otherwise

OFCondition DRTControlPointSequence::Item::getIsocenterPosition	(	Float64 &	value,
		const unsigned long	pos = 0
	)		const

get IsocenterPosition (300a,012c)

Parameters:

value	reference to variable in which the value should be stored
pos	index of the value to get (0..vm-1)

Returns:

status, EC_Normal if successful, an error code otherwise

OFCondition DRTControlPointSequence::Item::getIsocenterPosition

(

OFVector< Float64 > &

value

)

const

get IsocenterPosition (300a,012c)

Parameters:

value

reference to variable in which the value(s) should be stored

Returns:

status, EC_Normal if successful, an error code otherwise

OFCondition DRTControlPointSequence::Item::getNominalBeamEnergy	(	OFString &	value,
		const signed long	pos = 0
	)		const

get NominalBeamEnergy (300a,0114)

Parameters:

value	reference to variable in which the value should be stored
pos	index of the value to get (0..vm-1), -1 for all components

Returns:

status, EC_Normal if successful, an error code otherwise

OFCondition DRTControlPointSequence::Item::getNominalBeamEnergy	(	Float64 &	value,
		const unsigned long	pos = 0
	)		const

get NominalBeamEnergy (300a,0114)

Parameters:

value	reference to variable in which the value should be stored
pos	index of the value to get (0..vm-1)

Returns:

status, EC_Normal if successful, an error code otherwise

OFCondition DRTControlPointSequence::Item::getPatientSupportAngle	(	OFString &	value,
		const signed long	pos = 0
	)		const

get PatientSupportAngle (300a,0122)

Parameters:

value	reference to variable in which the value should be stored
pos	index of the value to get (0..vm-1), -1 for all components

Returns:

status, EC_Normal if successful, an error code otherwise

OFCondition DRTControlPointSequence::Item::getPatientSupportAngle	(	Float64 &	value,
		const unsigned long	pos = 0
	)		const

get PatientSupportAngle (300a,0122)

Parameters:

value	reference to variable in which the value should be stored
pos	index of the value to get (0..vm-1)

Returns:

status, EC_Normal if successful, an error code otherwise

OFCondition DRTControlPointSequence::Item::getPatientSupportRotationDirection	(	OFString &	value,
		const signed long	pos = 0
	)		const

get PatientSupportRotationDirection (300a,0123)

Parameters:

value	reference to variable in which the value should be stored
pos	index of the value to get (0..vm-1), -1 for all components

Returns:

status, EC_Normal if successful, an error code otherwise

DRTReferencedDoseReferenceSequenceInRTBeamsModule& DRTControlPointSequence::Item::getReferencedDoseReferenceSequence

(

)

[inline]

get ReferencedDoseReferenceSequence (300c,0050)

Returns:

reference to sequence element

const DRTReferencedDoseReferenceSequenceInRTBeamsModule& DRTControlPointSequence::Item::getReferencedDoseReferenceSequence

(

)

const [inline]

get ReferencedDoseReferenceSequence (300c,0050)

Returns:

const reference to sequence element

DRTReferencedDoseSequence& DRTControlPointSequence::Item::getReferencedDoseSequence

(

)

[inline]

get ReferencedDoseSequence (300c,0080)

Returns:

reference to sequence element

const DRTReferencedDoseSequence& DRTControlPointSequence::Item::getReferencedDoseSequence

(

)

const [inline]

get ReferencedDoseSequence (300c,0080)

Returns:

const reference to sequence element

OFCondition DRTControlPointSequence::Item::getSourceToSurfaceDistance	(	OFString &	value,
		const signed long	pos = 0
	)		const

get SourceToSurfaceDistance (300a,0130)

Parameters:

value	reference to variable in which the value should be stored
pos	index of the value to get (0..vm-1), -1 for all components

Returns:

status, EC_Normal if successful, an error code otherwise

OFCondition DRTControlPointSequence::Item::getSourceToSurfaceDistance	(	Float64 &	value,
		const unsigned long	pos = 0
	)		const

get SourceToSurfaceDistance (300a,0130)

Parameters:

value	reference to variable in which the value should be stored
pos	index of the value to get (0..vm-1)

Returns:

status, EC_Normal if successful, an error code otherwise

OFCondition DRTControlPointSequence::Item::getSurfaceEntryPoint	(	OFString &	value,
		const signed long	pos = 0
	)		const

get SurfaceEntryPoint (300a,012e)

Parameters:

value	reference to variable in which the value should be stored
pos	index of the value to get (0..vm-1), -1 for all components

Returns:

status, EC_Normal if successful, an error code otherwise

OFCondition DRTControlPointSequence::Item::getSurfaceEntryPoint	(	Float64 &	value,
		const unsigned long	pos = 0
	)		const

get SurfaceEntryPoint (300a,012e)

Parameters:

value	reference to variable in which the value should be stored
pos	index of the value to get (0..vm-1)

Returns:

status, EC_Normal if successful, an error code otherwise

OFCondition DRTControlPointSequence::Item::getSurfaceEntryPoint

(

OFVector< Float64 > &

value

)

const

get SurfaceEntryPoint (300a,012e)

Parameters:

value

reference to variable in which the value(s) should be stored

Returns:

status, EC_Normal if successful, an error code otherwise

OFCondition DRTControlPointSequence::Item::getTableTopEccentricAngle	(	OFString &	value,
		const signed long	pos = 0
	)		const

get TableTopEccentricAngle (300a,0125)

Parameters:

value	reference to variable in which the value should be stored
pos	index of the value to get (0..vm-1), -1 for all components

Returns:

status, EC_Normal if successful, an error code otherwise

OFCondition DRTControlPointSequence::Item::getTableTopEccentricAngle	(	Float64 &	value,
		const unsigned long	pos = 0
	)		const

get TableTopEccentricAngle (300a,0125)

Parameters:

value	reference to variable in which the value should be stored
pos	index of the value to get (0..vm-1)

Returns:

status, EC_Normal if successful, an error code otherwise

OFCondition DRTControlPointSequence::Item::getTableTopEccentricAxisDistance	(	OFString &	value,
		const signed long	pos = 0
	)		const

get TableTopEccentricAxisDistance (300a,0124)

Parameters:

value	reference to variable in which the value should be stored
pos	index of the value to get (0..vm-1), -1 for all components

Returns:

status, EC_Normal if successful, an error code otherwise

OFCondition DRTControlPointSequence::Item::getTableTopEccentricAxisDistance	(	Float64 &	value,
		const unsigned long	pos = 0
	)		const

get TableTopEccentricAxisDistance (300a,0124)

Parameters:

value	reference to variable in which the value should be stored
pos	index of the value to get (0..vm-1)

Returns:

status, EC_Normal if successful, an error code otherwise

OFCondition DRTControlPointSequence::Item::getTableTopEccentricRotationDirection	(	OFString &	value,
		const signed long	pos = 0
	)		const

get TableTopEccentricRotationDirection (300a,0126)

Parameters:

value	reference to variable in which the value should be stored
pos	index of the value to get (0..vm-1), -1 for all components

Returns:

status, EC_Normal if successful, an error code otherwise

OFCondition DRTControlPointSequence::Item::getTableTopLateralPosition	(	OFString &	value,
		const signed long	pos = 0
	)		const

get TableTopLateralPosition (300a,012a)

Parameters:

value	reference to variable in which the value should be stored
pos	index of the value to get (0..vm-1), -1 for all components

Returns:

status, EC_Normal if successful, an error code otherwise

OFCondition DRTControlPointSequence::Item::getTableTopLateralPosition	(	Float64 &	value,
		const unsigned long	pos = 0
	)		const

get TableTopLateralPosition (300a,012a)

Parameters:

value	reference to variable in which the value should be stored
pos	index of the value to get (0..vm-1)

Returns:

status, EC_Normal if successful, an error code otherwise

OFCondition DRTControlPointSequence::Item::getTableTopLongitudinalPosition	(	OFString &	value,
		const signed long	pos = 0
	)		const

get TableTopLongitudinalPosition (300a,0129)

Parameters:

value	reference to variable in which the value should be stored
pos	index of the value to get (0..vm-1), -1 for all components

Returns:

status, EC_Normal if successful, an error code otherwise

OFCondition DRTControlPointSequence::Item::getTableTopLongitudinalPosition	(	Float64 &	value,
		const unsigned long	pos = 0
	)		const

get TableTopLongitudinalPosition (300a,0129)

Parameters:

value	reference to variable in which the value should be stored
pos	index of the value to get (0..vm-1)

Returns:

status, EC_Normal if successful, an error code otherwise

OFCondition DRTControlPointSequence::Item::getTableTopVerticalPosition	(	OFString &	value,
		const signed long	pos = 0
	)		const

get TableTopVerticalPosition (300a,0128)

Parameters:

value	reference to variable in which the value should be stored
pos	index of the value to get (0..vm-1), -1 for all components

Returns:

status, EC_Normal if successful, an error code otherwise

OFCondition DRTControlPointSequence::Item::getTableTopVerticalPosition	(	Float64 &	value,
		const unsigned long	pos = 0
	)		const

get TableTopVerticalPosition (300a,0128)

Parameters:

value	reference to variable in which the value should be stored
pos	index of the value to get (0..vm-1)

Returns:

status, EC_Normal if successful, an error code otherwise

DRTWedgePositionSequence& DRTControlPointSequence::Item::getWedgePositionSequence

(

)

[inline]

get WedgePositionSequence (300a,0116)

Returns:

reference to sequence element

const DRTWedgePositionSequence& DRTControlPointSequence::Item::getWedgePositionSequence

(

)

const [inline]

get WedgePositionSequence (300a,0116)

Returns:

const reference to sequence element

OFBool DRTControlPointSequence::Item::isEmpty

(

)

check if item is empty

Returns:

OFTrue if item is empty, OFFalse otherwise

OFBool DRTControlPointSequence::Item::isValid

(

)

const

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

Returns:

OFTrue if item is valid, OFFalse otherwise

Item& DRTControlPointSequence::Item::operator=

(

const Item &

copy

)

assigment operator

Parameters:

copy	item object to be copied

OFCondition DRTControlPointSequence::Item::read

(

DcmItem &

item

)

read elements from sequence item

Parameters:

item	reference to DICOM sequence item from which the elements should be read

Returns:

status, EC_Normal if successful, an error code otherwise

OFCondition DRTControlPointSequence::Item::setBeamLimitingDeviceAngle	(	const OFString &	value,
		const OFBool	check = OFTrue
	)

set BeamLimitingDeviceAngle (300a,0120)

Parameters:

value	value to be set (single value only) or "" for no value
check	check 'value' for conformance with VR (DS) and VM (1) if enabled

Returns:

status, EC_Normal if successful, an error code otherwise

OFCondition DRTControlPointSequence::Item::setBeamLimitingDeviceRotationDirection	(	const OFString &	value,
		const OFBool	check = OFTrue
	)

set BeamLimitingDeviceRotationDirection (300a,0121)

Parameters:

value	value to be set (single value only) or "" for no value
check	check 'value' for conformance with VR (CS) and VM (1) if enabled

Returns:

status, EC_Normal if successful, an error code otherwise

OFCondition DRTControlPointSequence::Item::setControlPointIndex	(	const OFString &	value,
		const OFBool	check = OFTrue
	)

set ControlPointIndex (300a,0112)

Parameters:

value	value to be set (single value only) or "" for no value
check	check 'value' for conformance with VR (IS) and VM (1) if enabled

Returns:

status, EC_Normal if successful, an error code otherwise

OFCondition DRTControlPointSequence::Item::setCumulativeMetersetWeight	(	const OFString &	value,
		const OFBool	check = OFTrue
	)

set CumulativeMetersetWeight (300a,0134)

Parameters:

value	value to be set (single value only) or "" for no value
check	check 'value' for conformance with VR (DS) and VM (1) if enabled

Returns:

status, EC_Normal if successful, an error code otherwise

OFCondition DRTControlPointSequence::Item::setDoseRateSet	(	const OFString &	value,
		const OFBool	check = OFTrue
	)

set DoseRateSet (300a,0115)

Parameters:

value	value to be set (single value only) or "" for no value
check	check 'value' for conformance with VR (DS) and VM (1) if enabled

Returns:

status, EC_Normal if successful, an error code otherwise

OFCondition DRTControlPointSequence::Item::setGantryAngle	(	const OFString &	value,
		const OFBool	check = OFTrue
	)

set GantryAngle (300a,011e)

Parameters:

value	value to be set (single value only) or "" for no value
check	check 'value' for conformance with VR (DS) and VM (1) if enabled

Returns:

status, EC_Normal if successful, an error code otherwise

OFCondition DRTControlPointSequence::Item::setGantryPitchAngle	(	const Float32	value,
		const unsigned long	pos = 0
	)

set GantryPitchAngle (300a,014a)

Parameters:

value	value to be set (should be valid for this VR)
pos	index of the value to be set (0..vm-1), vm=1

Returns:

status, EC_Normal if successful, an error code otherwise

OFCondition DRTControlPointSequence::Item::setGantryPitchRotationDirection	(	const OFString &	value,
		const OFBool	check = OFTrue
	)

set GantryPitchRotationDirection (300a,014c)

Parameters:

value	value to be set (single value only) or "" for no value
check	check 'value' for conformance with VR (CS) and VM (1) if enabled

Returns:

status, EC_Normal if successful, an error code otherwise

OFCondition DRTControlPointSequence::Item::setGantryRotationDirection	(	const OFString &	value,
		const OFBool	check = OFTrue
	)

set GantryRotationDirection (300a,011f)

Parameters:

value	value to be set (single value only) or "" for no value
check	check 'value' for conformance with VR (CS) and VM (1) if enabled

Returns:

status, EC_Normal if successful, an error code otherwise

OFCondition DRTControlPointSequence::Item::setIsocenterPosition	(	const OFString &	value,
		const OFBool	check = OFTrue
	)

set IsocenterPosition (300a,012c)

Parameters:

value	value to be set (possibly multi-valued) or "" for no value
check	check 'value' for conformance with VR (DS) and VM (3) if enabled

Returns:

status, EC_Normal if successful, an error code otherwise

OFCondition DRTControlPointSequence::Item::setNominalBeamEnergy	(	const OFString &	value,
		const OFBool	check = OFTrue
	)

set NominalBeamEnergy (300a,0114)

Parameters:

value	value to be set (single value only) or "" for no value
check	check 'value' for conformance with VR (DS) and VM (1) if enabled

Returns:

status, EC_Normal if successful, an error code otherwise

OFCondition DRTControlPointSequence::Item::setPatientSupportAngle	(	const OFString &	value,
		const OFBool	check = OFTrue
	)

set PatientSupportAngle (300a,0122)

Parameters:

value	value to be set (single value only) or "" for no value
check	check 'value' for conformance with VR (DS) and VM (1) if enabled

Returns:

status, EC_Normal if successful, an error code otherwise

OFCondition DRTControlPointSequence::Item::setPatientSupportRotationDirection	(	const OFString &	value,
		const OFBool	check = OFTrue
	)

set PatientSupportRotationDirection (300a,0123)

Parameters:

value	value to be set (single value only) or "" for no value
check	check 'value' for conformance with VR (CS) and VM (1) if enabled

Returns:

status, EC_Normal if successful, an error code otherwise

OFCondition DRTControlPointSequence::Item::setSourceToSurfaceDistance	(	const OFString &	value,
		const OFBool	check = OFTrue
	)

set SourceToSurfaceDistance (300a,0130)

Parameters:

value	value to be set (single value only) or "" for no value
check	check 'value' for conformance with VR (DS) and VM (1) if enabled

Returns:

status, EC_Normal if successful, an error code otherwise

OFCondition DRTControlPointSequence::Item::setSurfaceEntryPoint	(	const OFString &	value,
		const OFBool	check = OFTrue
	)

set SurfaceEntryPoint (300a,012e)

Parameters:

value	value to be set (possibly multi-valued) or "" for no value
check	check 'value' for conformance with VR (DS) and VM (3) if enabled

Returns:

status, EC_Normal if successful, an error code otherwise

OFCondition DRTControlPointSequence::Item::setTableTopEccentricAngle	(	const OFString &	value,
		const OFBool	check = OFTrue
	)

set TableTopEccentricAngle (300a,0125)

Parameters:

value	value to be set (single value only) or "" for no value
check	check 'value' for conformance with VR (DS) and VM (1) if enabled

Returns:

status, EC_Normal if successful, an error code otherwise

OFCondition DRTControlPointSequence::Item::setTableTopEccentricAxisDistance	(	const OFString &	value,
		const OFBool	check = OFTrue
	)

set TableTopEccentricAxisDistance (300a,0124)

Parameters:

value	value to be set (single value only) or "" for no value
check	check 'value' for conformance with VR (DS) and VM (1) if enabled

Returns:

status, EC_Normal if successful, an error code otherwise

OFCondition DRTControlPointSequence::Item::setTableTopEccentricRotationDirection	(	const OFString &	value,
		const OFBool	check = OFTrue
	)

set TableTopEccentricRotationDirection (300a,0126)

Parameters:

value	value to be set (single value only) or "" for no value
check	check 'value' for conformance with VR (CS) and VM (1) if enabled

Returns:

status, EC_Normal if successful, an error code otherwise

OFCondition DRTControlPointSequence::Item::setTableTopLateralPosition	(	const OFString &	value,
		const OFBool	check = OFTrue
	)

set TableTopLateralPosition (300a,012a)

Parameters:

value	value to be set (single value only) or "" for no value
check	check 'value' for conformance with VR (DS) and VM (1) if enabled

Returns:

status, EC_Normal if successful, an error code otherwise

OFCondition DRTControlPointSequence::Item::setTableTopLongitudinalPosition	(	const OFString &	value,
		const OFBool	check = OFTrue
	)

set TableTopLongitudinalPosition (300a,0129)

Parameters:

value	value to be set (single value only) or "" for no value
check	check 'value' for conformance with VR (DS) and VM (1) if enabled

Returns:

status, EC_Normal if successful, an error code otherwise

OFCondition DRTControlPointSequence::Item::setTableTopVerticalPosition	(	const OFString &	value,
		const OFBool	check = OFTrue
	)

set TableTopVerticalPosition (300a,0128)

Parameters:

value	value to be set (single value only) or "" for no value
check	check 'value' for conformance with VR (DS) and VM (1) if enabled

Returns:

status, EC_Normal if successful, an error code otherwise

OFCondition DRTControlPointSequence::Item::write

(

DcmItem &

item

)

write elements to sequence item

Parameters:

item	reference 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:

• dcmrt/include/dcmtk/dcmrt/seq/drtcps.h