cdac.medinfo.sdk.dcm30_04.baselibs

Class IonMachineVerificationSequenceItem

java.lang.Object

cdac.medinfo.sdk.dcm30_04.baselibs.Item

cdac.medinfo.sdk.dcm30_04.baselibs.IonMachineVerificationSequenceItem

All Implemented Interfaces:

IItem, ICollectionIterable<IDataElement>, java.io.Serializable, java.lang.Iterable<IDataElement>

public class IonMachineVerificationSequenceItem
extends Item

This item class contains the methods to set, get and validate the attribute present in Ion Machine Verification Sequence .

See Also:

Serialized Form

Method Summary

Methods

Modifier and Type	Method and Description
float[]	getFixationLightAzimuthalAngle() Retrieves Fixation Light Azimuthal Angle.
float[]	getFixationLightPolarAngle() Retrieves Fixation Light Polar Angle.
IonControlPointVerificationSequence	getIonControlPointVerificationSequence() Retrieves pre-initialized object of Ion Control Point Verification Sequence.If the module contains the sequence object it returns the same otherwise it creates the sequence adds to the module with proper initialization and then returns the object of sequence.
java.lang.String	getNumberofLateralSpreadingDevices() Retrieves Number of Lateral Spreading Devices.
java.lang.String	getNumberofRangeModulators() Retrieves Number of Number of Range Modulators.
java.lang.String	getNumberofRangeShifters() Retrieves Number of Range Shifters.
java.lang.String	getPatientSupportAccessoryCode() Return user-defined label identifier for Patient Support Accessory Code.
java.lang.String	getPatientSupportID() Retrieves User-specified identifier for manufacturer specific patient support devices.
java.lang.String	getPatientSupportType() Retrieves type of the PatientSupportType value encoded in this Item
java.lang.String	getRadiationAtomicNumber() Retrieves Radiation Atomic Number.
short[]	getRadiationChargeState() Returns the Charge state of radiation .
java.lang.String	getRadiationMassNumber() Retrieves Radiation Mass Number.
RecordedLateralSpreadingDeviceSequence	getRecordedLateralSpreadingDeviceSequence() Retrieves pre-initialized object of Recorded Lateral Spreading Device Sequence.If the module contains the sequence object it returns the same otherwise it creates the sequence adds to the module with proper initialization and then returns the object of sequence.
RecordedRangeModulatorSequence	getRecordedRangeModulatorSequence() Retrieves pre-initialized object of Recorded Range Modulator Sequence.If the module contains the sequence object it returns the same otherwise it creates the sequence adds to the module with proper initialization and then returns the object of sequence.
RecordedRangeShifterSequence	getRecordedRangeShifterSequence() Retrieves pre-initialized object of Recorded Range Shifter Sequence.If the module contains the sequence object it returns the same otherwise it creates the sequence adds to the module with proper initialization and then returns the object of sequence.
RecordedSnoutSequence	getRecordedSnoutSequence() Retrieves pre-initialized object of IRecorded Snout Sequence.If the module contains the sequence object it returns the same otherwise it creates the sequence adds to the module with proper initialization and then returns the object of sequence.
java.lang.String	getScanMode() Retrieves type of the value encoded in this Item
void	setFixationLightAzimuthalAngle(float[] arrFixationLightAzimuthalAngle) Sets FixationLightAzimuthalAngle Azimuthal angle in degrees of the fixation light coordinate around the IEC BEAM LIMITING DEVICE Y-axis.
void	setFixationLightPolarAngle(float[] arrFixationLightAzimuthalAngle) Sets FixationLightPolarAngle Polar angle in degrees of the fixation light coordinate.
void	setNumberofLateralSpreadingDevices(java.lang.String strNumberofLateralSpreadingDevices) Sets Number of Lateral Spreading Devices.
void	setNumberofRangeModulators(java.lang.String strNumberofRangeModulators) Sets Number of Range Modulators.
void	setNumberofRangeShifters(java.lang.String strReferencedReferenceImageNumber) Sets Number of Range Shifters.
void	setPatientSupportAccessoryCode(java.lang.String strPatientSupportAccessoryCode) Sets Rescale Type.
void	setPatientSupportID(java.lang.String strPatientSupportID) Sets the PatientSupportID.
void	setPatientSupportType(EnumPatientSupportType enumPatientSupportType) Sets the Value Type Defined in Terms of Enum TABLE : Treatment delivery system table CHAIR : Treatment delivery system chair
void	setRadiationAtomicNumber(java.lang.String strRadiationAtomicNumber) Sets Radiation Atomic Number.
void	setRadiationChargeState(short[] sRadiationChargeState) Sets RadiationChargeState Charge state of radiation.
void	setRadiationMassNumber(java.lang.String strRadiationMassNumber) Sets Radiation Mass Number.
void	setScanMode(EnumScanMode enumScanMode) Sets the Value Type Defined in Terms of Enumerated Values: NONE : No beam scanning is performed UNIFORM : The beam is scanned between control points to create a uniform lateral fluence distribution across the field MODULATED : The beam is scanned between control points to create a modulated lateral fluence distribution across the field The method of beam scanning to be used during treatment.

Methods inherited from class cdac.medinfo.sdk.dcm30_04.baselibs.Item

addDataElement, changeToUndefined, clone, contains, dumpDICOMInfo, getDataForTag, getDictionaryReader, getItemLength, getTransferSyntax, getValue, getValueLength, iterator, read, setDictionaryReader, setTransferSyntax, setValue, sortedIterator, validate, validateForModule, write

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getIonControlPointVerificationSequence

public IonControlPointVerificationSequence getIonControlPointVerificationSequence()

Retrieves pre-initialized object of Ion Control Point Verification Sequence.If the module contains the sequence object it returns the same otherwise it creates the sequence adds to the module with proper initialization and then returns the object of sequence.

Returns:

IonControlPointVerificationSequence - instance of IonControlPointVerificationSequence.

getRecordedSnoutSequence

public RecordedSnoutSequence getRecordedSnoutSequence()

Retrieves pre-initialized object of IRecorded Snout Sequence.If the module contains the sequence object it returns the same otherwise it creates the sequence adds to the module with proper initialization and then returns the object of sequence.

Returns:

RecordedSnoutSequence - instance of RecordedSnoutSequence.

getRecordedRangeShifterSequence

public RecordedRangeShifterSequence getRecordedRangeShifterSequence()

Retrieves pre-initialized object of Recorded Range Shifter Sequence.If the module contains the sequence object it returns the same otherwise it creates the sequence adds to the module with proper initialization and then returns the object of sequence.

Returns:

RecordedRangeShifterSequence - instance of Recorded Range Shifter Sequence.

getRecordedLateralSpreadingDeviceSequence

public RecordedLateralSpreadingDeviceSequence getRecordedLateralSpreadingDeviceSequence()

Retrieves pre-initialized object of Recorded Lateral Spreading Device Sequence.If the module contains the sequence object it returns the same otherwise it creates the sequence adds to the module with proper initialization and then returns the object of sequence.

Returns:

RecordedLateralSpreadingDeviceSequence - instance of Recorded Lateral Spreading Device Sequence.

getRecordedRangeModulatorSequence

public RecordedRangeModulatorSequence getRecordedRangeModulatorSequence()

Retrieves pre-initialized object of Recorded Range Modulator Sequence.If the module contains the sequence object it returns the same otherwise it creates the sequence adds to the module with proper initialization and then returns the object of sequence.

Returns:

RecordedRangeModulatorSequence - instance of Recorded Range Modulator Sequence.

setRadiationMassNumber

public void setRadiationMassNumber(java.lang.String strRadiationMassNumber)

Sets Radiation Mass Number. Mass number of radiation.

Parameters:

strRadiationAtomicNumber - String value of Radiation Atomic Number.

getRadiationMassNumber

public java.lang.String getRadiationMassNumber()

Retrieves Radiation Mass Number. Mass number of radiation.

Returns:

String - value of Radiation Mass Number.

setRadiationAtomicNumber

public void setRadiationAtomicNumber(java.lang.String strRadiationAtomicNumber)

Sets Radiation Atomic Number. Atomic number of radiation.

Parameters:

strRadiationAtomicNumber - String value of Radiation Atomic Number.

getRadiationAtomicNumber

public java.lang.String getRadiationAtomicNumber()

Retrieves Radiation Atomic Number. Atomic number of radiation.

Returns:

String - value of Atomic number of radiation.

setRadiationChargeState

public void setRadiationChargeState(short[] sRadiationChargeState)

Sets RadiationChargeState Charge state of radiation.

Parameters:

sRadiationChargeState - short array of LUT Descriptor values.

getRadiationChargeState

public short[] getRadiationChargeState()

Returns the Charge state of radiation .

Returns:

short[] - short array of RadiationChargeState.

setScanMode

public void setScanMode(EnumScanMode enumScanMode)

Sets the Value Type Defined in Terms of Enumerated Values: NONE : No beam scanning is performed UNIFORM : The beam is scanned between control points to create a uniform lateral fluence distribution across the field MODULATED : The beam is scanned between control points to create a modulated lateral fluence distribution across the field The method of beam scanning to be used during treatment.

Parameters:

enumScanMode - Specifies type of the value encoded in this Item

getScanMode

public java.lang.String getScanMode()

Retrieves type of the value encoded in this Item

Returns:

String - Type of the value encoded in this Item

setNumberofRangeShifters

public void setNumberofRangeShifters(java.lang.String strReferencedReferenceImageNumber)

Sets Number of Range Shifters. Number of range shifters associated with current beam.

Parameters:

strReferencedReferenceImageNumber - String value of Referenced Reference Image Number.

getNumberofRangeShifters

public java.lang.String getNumberofRangeShifters()

Retrieves Number of Range Shifters. Number of range shifters associated with current beam.

Returns:

String - value of Referenced Reference Image Number.

setNumberofLateralSpreadingDevices

public void setNumberofLateralSpreadingDevices(java.lang.String strNumberofLateralSpreadingDevices)

Sets Number of Lateral Spreading Devices. Number of lateral spreading devices associated with current beam.

Parameters:

strNumberofLateralSpreadingDevices - String value of Number of Lateral Spreading Devices.

getNumberofLateralSpreadingDevices

public java.lang.String getNumberofLateralSpreadingDevices()

Retrieves Number of Lateral Spreading Devices.

Returns:

String - value of Number of Lateral Spreading Devices.

setNumberofRangeModulators

public void setNumberofRangeModulators(java.lang.String strNumberofRangeModulators)

Sets Number of Range Modulators. Number of range modulators associated with current beam.

Parameters:

strNumber - of Range Modulators String value of NumberofNumberofRangeModulators.

getNumberofRangeModulators

public java.lang.String getNumberofRangeModulators()

Retrieves Number of Number of Range Modulators.

Returns:

String - value of Number of Range Modulators.

setPatientSupportType

public void setPatientSupportType(EnumPatientSupportType enumPatientSupportType)

Sets the Value Type Defined in Terms of Enum TABLE : Treatment delivery system table CHAIR : Treatment delivery system chair

Parameters:

strPatientSupportType - type of the value encoded in this Item

getPatientSupportType

public java.lang.String getPatientSupportType()

Retrieves type of the PatientSupportType value encoded in this Item

Returns:

String - Type of the PatientSupportType encoded in this Item

setPatientSupportID

public void setPatientSupportID(java.lang.String strPatientSupportID)

Sets the PatientSupportID.

Parameters:

strPatientSupportID -

getPatientSupportID

public java.lang.String getPatientSupportID()

Retrieves User-specified identifier for manufacturer specific patient support devices.

Returns:

String - value of PatientSupportID.

setPatientSupportAccessoryCode

public void setPatientSupportAccessoryCode(java.lang.String strPatientSupportAccessoryCode)

Sets Rescale Type.

Parameters:

strPatientSupportAccessoryCode - String value of Rescale Type.

getPatientSupportAccessoryCode

public java.lang.String getPatientSupportAccessoryCode()

Return user-defined label identifier for Patient Support Accessory Code.

Returns:

String - value of PatientSupportAccessoryCode.

setFixationLightAzimuthalAngle

public void setFixationLightAzimuthalAngle(float[] arrFixationLightAzimuthalAngle)

Sets FixationLightAzimuthalAngle Azimuthal angle in degrees of the fixation light coordinate around the IEC BEAM LIMITING DEVICE Y-axis. Used for eye treatments.

Parameters:

arrFixationLightAzimuthalAngle - pair of floating point numbers

getFixationLightAzimuthalAngle

public float[] getFixationLightAzimuthalAngle()

Retrieves Fixation Light Azimuthal Angle.

Returns:

float[] - Float array of FixationLightAzimuthalAngle.

setFixationLightPolarAngle

public void setFixationLightPolarAngle(float[] arrFixationLightAzimuthalAngle)

Sets FixationLightPolarAngle Polar angle in degrees of the fixation light coordinate. Used for eye treatments.

Parameters:

arrFixationLightPolarAngle - pair of floating point numbers

getFixationLightPolarAngle

public float[] getFixationLightPolarAngle()

Retrieves Fixation Light Polar Angle.

Returns:

float[] - Float array of FixationLightPolarAngle.