TreatmentSessionIonBeamSequenceItem

java.lang.Object
- cdac.medinfo.sdk.dcm30_04.baselibs.Item
- - cdac.medinfo.sdk.dcm30_04.baselibs.TreatmentSessionIonBeamSequenceItem

All Implemented Interfaces:

IItem, ICollectionIterable<IDataElement>, java.io.Serializable, java.lang.Iterable<IDataElement>
```
public class TreatmentSessionIonBeamSequenceItem
extends Item
```
This item class contains methods to validate, set and get the attributes of Treatment Session Ion Beam Sequence.

See Also:
Serialized Form

Method Summary

Methods
Modifier and Type	Method and Description
`ApplicatorSequence`	`getApplicatorSequence()` Retrieves pre-initialized object of Applicator 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`	`getBeamDescription()` Retrieves User-defined Description for Beam.
`BeamLimitingDeviceLeafPairsSequence`	`getBeamLimitingDeviceLeafPairsSequence()` Retrieves pre-initialized object of Beam Limiting Device Leaf Pairs 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`	`getBeamName()` Retrieves User-defined name for Beam.
`java.lang.String`	`getBeamType()` Retrieves Motion characteristic of Beam.
`java.lang.String`	`getCurrentFractionNumber()` Retrieves Current Fraction Number.
`java.lang.String`	`getDeliveredPrimaryMeterset()` Retrieves Machine setting actually delivered as recorded by primary meterset
`java.lang.String`	`getDeliveredSecondaryMeterset()` Retrieves Machine setting actually delivered as recorded by Secondary meterset
`java.lang.String`	`getDeliveredTreatmentTime()` Retrieves Treatment Time actually delivered .
`float[]`	`getFixationLightAzimuthalAngle()` Retrieves Fixation Light Azimuthal Angle.
`float[]`	`getFixationLightPolarAngle()` Retrieves Fixation Light Polar Angle.
`GeneralAccessorySequence`	`getGeneralAccessorySequence()` Retrieves pre-initialized object of General Accessory 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
`IonControlPointDeliverySequence`	`getIonControlPointDeliverySequence()` Retrieves pre-initialized object of Ion Control Point Delivery 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`	`getNumberOfBlocks()` Retrieves Number of Blocks or Electron Electron Inserts associated with Beam.
`java.lang.String`	`getNumberOfBoli()` Retrieves Number of Boli used with current Beam.
`java.lang.String`	`getNumberofCompensators()` RetrievesNumber of Compensators associated with current delivered Beam.
`java.lang.String`	`getNumberOfControlPoints()` Retrieves Number of control points delivered .
`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`	`getNumberofWedges()` Retrieves Number of Wedges.
`java.lang.String`	`getRadiationAtomicNumber()` Retrieves Radiation Atomic Number.
`java.lang.Short`	`getRadiationChargeState()` Returns the format of the RadiationChargeState.
`java.lang.String`	`getRadiationMassNumber()` Retrieves Radiation Mass Number.
`java.lang.String`	`getRadiationType()` Retrieves Particle type of Beam.
`RecordedBlockSequence`	`getRecordedBlockSequence()` Retrieves pre-initialized object of Recorded Block 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
`RecordedCompensatorSequence`	`getRecordedCompensatorSequence()` Retrieves pre-initialized object of Recorded Compensator 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
`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.
`RecordedWedgeSequence`	`getRecordedWedgeSequence()` Retrieves pre-initialized object of Recorded Wedge 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`	`getReferencedBeamNumber()` Retrieves ReferencedBeamNumber.
`ReferencedBolusSequence`	`getReferencedBolusSequence()` Retrieves pre-initialized object of Referenced Bolus 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
`ReferencedCalculatedDoseReferenceSequence`	`getReferencedCalculatedDoseReferenceSequence()` Retrieves pre-initialized object of Referenced Calculated Dose Reference 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`	`getReferencedPatientSeupNumber()` Retrieves Referenced Patient Setup Number.
`java.lang.String`	`getReferencedToleranceTableNumber()` Retrieves Referenced Tolerance Table Number.
`java.lang.String`	`getScanMode()` Return type of Scan Mode.
`java.lang.String`	`getSpecifiedPrimaryMeterset()` Retrieves Desired machine setting of primary meterset.
`java.lang.String`	`getSpecifiedSecondaryMeterset()` Retrieves Desired machine setting of Secondary meterset.
`java.lang.String`	`getSpecifiedTreatmentTime()` Retrieves Treatment Time .
`java.lang.String`	`getTreatmentDeliveryType()` Retrieves Treatment Delivery Type.
`java.lang.String`	`getTreatmentTerminationCode()` Retrieves Treatment machine termination code.
`java.lang.String`	`getTreatmentTerminationStatus()` Return condition status under which treatment was terminated.
`java.lang.String`	`getTreatmentVerificationStatus()` Retrieves Conditions under which treatment was verified by a verification system.
`void`	`setBeamDescription(java.lang.String strBeamDescription)` Sets User-defined Description for Beam.
`void`	`setBeamName(java.lang.String strBeamName)` Sets User-defined name for Beam.
`void`	`setBeamType(EnumBeamType enumBeamType)` Sets Motion characteristic of Beam.
`void`	`setCurrentFractionNumber(java.lang.String strCurrentFractionNumber)` Sets Referenced Reference Image Number.
`void`	`setDeliveredPrimaryMeterset(java.lang.String strDeliveredPrimaryMeterset)` Sets Machine setting actually delivered as recorded by primary meterset.
`void`	`setDeliveredSecondaryMeterset(java.lang.String strDeliveredSecondaryMeterset)` Sets Machine setting actually delivered as recorded by Secondary meterset.
`void`	`setDeliveredTreatmentTime(java.lang.String strDeliveredTreatmentTime)` Sets Treatment Time actually delivered.
`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`	`setNumberOfBlocks(java.lang.String strNumberOfBlocks)` Sets Number of Blocks or Electron Electron Inserts associated with Beam.
`void`	`setNumberOfBoli(java.lang.String strNumberOfBoli)` Sets Number of Boli used with current Beam.
`void`	`setNumberofCompensators(java.lang.String strNumberofCompensators)` Sets Number of Compensators associated with current delivered Beam.
`void`	`setNumberOfControlPoints(java.lang.String strNumberOfControlPoints)` Sets Number of control points delivered.
`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`	`setNumberofWedges(java.lang.String strNumberofWedges)` Sets Number of Wedges associated with current delivered Beam.
`void`	`setRadiationAtomicNumber(java.lang.String strRadiationMassNumber)` Sets RadiationAtomicNumber.
`void`	`setRadiationChargeState(short sRadiationChargeState)` Sets the value of Radiation Charge State
`void`	`setRadiationMassNumber(java.lang.String strRadiationMassNumber)` Sets RadiationMassNumber.
`void`	`setRadiationType(EnumRadiationType enumRadiationType)` Sets Particle type of Beam.
`void`	`setReferencedBeamNumber(java.lang.String strReferencedBeamNumber)` Sets Referenced Beam Number .
`void`	`setReferencedPatientSetupNumber(java.lang.String strReferencedPatientSetupNumber)` Sets Referenced Patient Setup Number.
`void`	`setReferencedToleranceTableNumber(java.lang.String strReferencedToleranceTableNumber)` Sets ReferencedToleranceTableNumber.
`void`	`setScanMode(EnumScanMode enumScanMode)` Sets type of Scan Mode Defined Terms: 1) NONE.
`void`	`setSpecifiedPrimaryMeterset(java.lang.String strSpecifiedPrimaryMeterset)` Sets Desired machine setting of primary meterset.
`void`	`setSpecifiedSecondaryMeterset(java.lang.String strSpecifiedSecondaryMeterset)` Sets Desired machine setting of Secondary meterset.
`void`	`setSpecifiedTreatmentTime(java.lang.String strSpecifiedTreatmentTime)` Sets Treatment Time (sec)..
`void`	`setTreatmentDeliveryType(EnumTreatmentDeliveryType enumTreatmentDeliveryType)` Sets Treatment Delivery Type.
`void`	`setTreatmentTerminationCode(java.lang.String strTreatmentTerminationCode)` Sets Treatment machine termination code.
`void`	`setTreatmentTerminationStatus(EnumTreatmentTerminationStatus enumTreatmentTerminationStatus)` Sets conditions under which treatment was terminated.
`void`	`setTreatmentVerificationStatus(EnumTreatmentVerificationStatus enumTreatmentVerificationStatus)` Sets Conditions under which treatment was verified by a verification system.
`boolean`	`validateForModule()` Validates all the attributes in TreatmentSessionIonBeamSequenceItems that are present in the DataSet

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, write

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - validateForModule
```
public boolean validateForModule()
                          throws InvalidItemException
```
    Validates all the attributes in TreatmentSessionIonBeamSequenceItems that are present in the DataSet
    
    Specified by:
    
    validateForModule in interface IItem
    
    Overrides:
    
    validateForModule in class Item
    
    Returns:
    boolean - Success -true, Failure - false
    
    Throws:
    
    InvalidItemException - throws InvalidItemException If Mandatory or Conditional element fails.
  - setReferencedBeamNumber
```
public void setReferencedBeamNumber(java.lang.String strReferencedBeamNumber)
```
    Sets Referenced Beam Number .
    
    Parameters:
    strReferencedBeamNumber - String value of Referenced Beam Number.
  - getReferencedBeamNumber
```
public java.lang.String getReferencedBeamNumber()
```
    Retrieves ReferencedBeamNumber.
    
    Returns:
    String - value of Referenced Beam Number.
  - setBeamName
```
public void setBeamName(java.lang.String strBeamName)
```
    Sets User-defined name for Beam.
    
    Parameters:
    strBeamName - String value of Beam Name.
  - getBeamName
```
public java.lang.String getBeamName()
```
    Retrieves User-defined name for Beam.
    
    Returns:
    String value of Beam Name.
  - setBeamDescription
```
public void setBeamDescription(java.lang.String strBeamDescription)
```
    Sets User-defined Description for Beam.
    
    Parameters:
    strBeamDescription - String value of Beam Description.
  - getBeamDescription
```
public java.lang.String getBeamDescription()
```
    Retrieves User-defined Description for Beam.
    
    Returns:
    String - value of Beam Description.
  - setBeamType
```
public void setBeamType(EnumBeamType enumBeamType)
```
    Sets Motion characteristic of Beam. Enumerated Values: STATIC = all beam parameters remain unchanged during delivery. DYNAMIC = one or more beam parameters changes during delivery.
    
    Parameters:
    enumBeamType - Enum value of Beam Type.
  - getBeamType
```
public java.lang.String getBeamType()
```
    Retrieves Motion characteristic of Beam.
    
    Returns:
    String - value of Beam Type.
  - setRadiationType
```
public void setRadiationType(EnumRadiationType enumRadiationType)
```
    Sets Particle type of Beam. Defined Terms: PHOTON, PROTON ION
    
    Parameters:
    enumRadiationType - Enum value of Radiation Type.
  - getRadiationType
```
public java.lang.String getRadiationType()
```
    Retrieves Particle type of Beam.
    
    Returns:
    String - value of Radiation Type.
  - setRadiationMassNumber
```
public void setRadiationMassNumber(java.lang.String strRadiationMassNumber)
```
    Sets RadiationMassNumber.
    
    Parameters:
    strRadiationMassNumber - String value of Radiation Mass Number.
  - getRadiationMassNumber
```
public java.lang.String getRadiationMassNumber()
```
    Retrieves Radiation Mass Number.
    
    Returns:
    String - value of RadiationMassNumber.
  - setRadiationAtomicNumber
```
public void setRadiationAtomicNumber(java.lang.String strRadiationMassNumber)
```
    Sets RadiationAtomicNumber.
    
    Parameters:
    strRadiationAtomicNumber - String value of Radiation Atomic Number.
  - getRadiationAtomicNumber
```
public java.lang.String getRadiationAtomicNumber()
```
    Retrieves Radiation Atomic Number.
    
    Returns:
    String - value of Radiation Atomic Number.
  - setRadiationChargeState
```
public void setRadiationChargeState(short sRadiationChargeState)
```
    Sets the value of Radiation Charge State
    
    Parameters:
    sRadiationChargeState - short array of values.
  - getRadiationChargeState
```
public java.lang.Short getRadiationChargeState()
```
    Returns the format of the RadiationChargeState.
    
    Returns:
    short - short RadiationChargeState values.
  - setScanMode
```
public void setScanMode(EnumScanMode enumScanMode)
```
    Sets type of Scan Mode Defined Terms: 1) NONE. 2) UNIFORM. 3) MODULATED
    
    Parameters:
    enumScanMode - enum value of Scan Mode.
  - getScanMode
```
public java.lang.String getScanMode()
```
    Return type of Scan Mode.
    
    Returns:
    String - value of Scan Mode.
  - setReferencedToleranceTableNumber
```
public void setReferencedToleranceTableNumber(java.lang.String strReferencedToleranceTableNumber)
```
    Sets ReferencedToleranceTableNumber.
    
    Parameters:
    strReferencedToleranceTableNumber - String value of Referenced Tolerance Table Number.
  - getReferencedToleranceTableNumber
```
public java.lang.String getReferencedToleranceTableNumber()
```
    Retrieves Referenced Tolerance Table Number.
    
    Returns:
    String - value of Referenced Tolerance Table Number.
  - getBeamLimitingDeviceLeafPairsSequence
```
public BeamLimitingDeviceLeafPairsSequence getBeamLimitingDeviceLeafPairsSequence()
```
    Retrieves pre-initialized object of Beam Limiting Device Leaf Pairs 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:
    BeamLimitingDeviceLeafPairsSequence - instance of BeamLimitingDeviceLeafPairsSequence.
  - setReferencedPatientSetupNumber
```
public void setReferencedPatientSetupNumber(java.lang.String strReferencedPatientSetupNumber)
```
    Sets Referenced Patient Setup Number. Uniquely identifies Patient Setup used within current beam, specified by Patient Setup Number (300A, 0182) within Patient Setup Sequence (300A, 0180) of RT Treatment Record.
    
    Parameters:
    strReferencedPatientSetupNumber - String value of Referenced Patient Setup Number.
  - getReferencedPatientSeupNumber
```
public java.lang.String getReferencedPatientSeupNumber()
```
    Retrieves Referenced Patient Setup Number.
    
    Returns:
    String - value of Referenced Patient Setup Number.
  - getReferencedCalculatedDoseReferenceSequence
```
public ReferencedCalculatedDoseReferenceSequence getReferencedCalculatedDoseReferenceSequence()
```
    Retrieves pre-initialized object of Referenced Calculated Dose Reference 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:
    ReferencedCalculatedDoseReferenceSequence - instance of Referenced Calculated Dose Reference Sequence.
  - setNumberofWedges
```
public void setNumberofWedges(java.lang.String strNumberofWedges)
```
    Sets Number of Wedges associated with current delivered Beam.
    
    Parameters:
    strNumberofWedges - String value of Number of Wedges.
  - getNumberofWedges
```
public java.lang.String getNumberofWedges()
```
    Retrieves Number of Wedges.
    
    Returns:
    String - value of Number of Wedges.
  - getRecordedWedgeSequence
```
public RecordedWedgeSequence getRecordedWedgeSequence()
```
    Retrieves pre-initialized object of Recorded Wedge 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:
    RecordedWedgeSequence - instance of Recorded Wedge Sequence.
  - setNumberofCompensators
```
public void setNumberofCompensators(java.lang.String strNumberofCompensators)
```
    Sets Number of Compensators associated with current delivered Beam.
    
    Parameters:
    strNumberofCompensators - String value of Number of Compensators.
  - getNumberofCompensators
```
public java.lang.String getNumberofCompensators()
```
    RetrievesNumber of Compensators associated with current delivered Beam.
    
    Returns:
    String - value of Number of Compensators.
  - getRecordedCompensatorSequence
```
public RecordedCompensatorSequence getRecordedCompensatorSequence()
```
    Retrieves pre-initialized object of Recorded Compensator 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:
    RecordedCompensatorSequence - instance of Recorded Compensator Sequence.
  - setNumberOfBoli
```
public void setNumberOfBoli(java.lang.String strNumberOfBoli)
```
    Sets Number of Boli used with current Beam.
    
    Parameters:
    strNumberOfBoli - String value of Number of Boli.
  - getNumberOfBoli
```
public java.lang.String getNumberOfBoli()
```
    Retrieves Number of Boli used with current Beam.
    
    Returns:
    String - value of Number of Boli
  - getReferencedBolusSequence
```
public ReferencedBolusSequence getReferencedBolusSequence()
```
    Retrieves pre-initialized object of Referenced Bolus 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:
    ReferencedBolusSequence - instance of Referenced Bolus Sequence.
  - setNumberOfBlocks
```
public void setNumberOfBlocks(java.lang.String strNumberOfBlocks)
```
    Sets Number of Blocks or Electron Electron Inserts associated with Beam.
    
    Parameters:
    strNumberOfBlocks - String value of Number of Blocks.
  - getNumberOfBlocks
```
public java.lang.String getNumberOfBlocks()
```
    Retrieves Number of Blocks or Electron Electron Inserts associated with Beam.
    
    Returns:
    String - value of Number of Blocks
  - getRecordedBlockSequence
```
public RecordedBlockSequence getRecordedBlockSequence()
```
    Retrieves pre-initialized object of Recorded Block 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:
    RecordedBlockSequence - instance of Recorded Block Sequence.
  - 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.
  - getApplicatorSequence
```
public ApplicatorSequence getApplicatorSequence()
```
    Retrieves pre-initialized object of Applicator 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:
    ApplicatorSequence - instance of Applicator Sequence.
  - getGeneralAccessorySequence
```
public GeneralAccessorySequence getGeneralAccessorySequence()
```
    Retrieves pre-initialized object of General Accessory 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:
    General Accessory Sequence - instance of General Accessory Sequence.
  - 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.
  - 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.
  - 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.
  - 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.
  - 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.
  - 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.
  - 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.
  - setCurrentFractionNumber
```
public void setCurrentFractionNumber(java.lang.String strCurrentFractionNumber)
```
    Sets Referenced Reference Image Number. The index of the fraction that is to be delivered or completed in this session.
    
    Parameters:
    strCurrentFractionNumber - String value of Current Fraction Number.
  - getCurrentFractionNumber
```
public java.lang.String getCurrentFractionNumber()
```
    Retrieves Current Fraction Number. The index of the fraction that is to be delivered or completed in this session.
    
    Returns:
    String - value of Current Fraction Number.
  - setTreatmentDeliveryType
```
public void setTreatmentDeliveryType(EnumTreatmentDeliveryType enumTreatmentDeliveryType)
```
    Sets Treatment Delivery Type. Defined Terms: TREATMENT = normal patient treatment OPEN_PORTFILM = portal image acquisition with open field TRMT_PORTFILM = portal image acquisition with treatment port CONTINUATION = continuation of interrupted treatment.
    
    Parameters:
    enumTreatmentDeliveryType - Enum value of Treatment Delivery Type.
  - getTreatmentDeliveryType
```
public java.lang.String getTreatmentDeliveryType()
```
    Retrieves Treatment Delivery Type.
    
    Returns:
    String - value Treatment Delivery Type.
  - setTreatmentTerminationStatus
```
public void setTreatmentTerminationStatus(EnumTreatmentTerminationStatus enumTreatmentTerminationStatus)
```
    Sets conditions under which treatment was terminated. Enumerated Values: 1) NORMAL = treatment terminated normally, 2) OPERATOR = operator terminated treatment, 3) MACHINE = machine terminated treatment for other than NORMAL condition, 4) UNKNOWN = status at termination unknown.
    
    Parameters:
    enumTreatmentTerminationStatus - Enum value of condition status under which treatment was terminated.
  - getTreatmentTerminationStatus
```
public java.lang.String getTreatmentTerminationStatus()
```
    Return condition status under which treatment was terminated.
    
    Returns:
    String - value Termination Status
  - setTreatmentTerminationCode
```
public void setTreatmentTerminationCode(java.lang.String strTreatmentTerminationCode)
```
    Sets Treatment machine termination code. This code is dependent upon the particular application and equipment.
    
    Parameters:
    strTreatmentTerminationCode - String value of Treatment Termination code.
  - getTreatmentTerminationCode
```
public java.lang.String getTreatmentTerminationCode()
```
    Retrieves Treatment machine termination code.
    
    Returns:
    String - value of Treatment machine termination code.
  - setTreatmentVerificationStatus
```
public void setTreatmentVerificationStatus(EnumTreatmentVerificationStatus enumTreatmentVerificationStatus)
```
    Sets Conditions under which treatment was verified by a verification system. Enumerated Values: VERIFIED = treatment verified, VERIFIED_OVR = treatment verified with at least one out-of-range value overridden NOT_VERIFIED = treatment verified manually
    
    Parameters:
    enumTreatmentVerificationStatus - Enum value of Treatment Verification Status.
  - getTreatmentVerificationStatus
```
public java.lang.String getTreatmentVerificationStatus()
```
    Retrieves Conditions under which treatment was verified by a verification system.
    
    Returns:
    String - value of Treatment Verification Status.
  - setSpecifiedPrimaryMeterset
```
public void setSpecifiedPrimaryMeterset(java.lang.String strSpecifiedPrimaryMeterset)
```
    Sets Desired machine setting of primary meterset.
    
    Parameters:
    strSpecifiedPrimaryMeterset - String value of Specified Primary Meterset.
  - getSpecifiedPrimaryMeterset
```
public java.lang.String getSpecifiedPrimaryMeterset()
```
    Retrieves Desired machine setting of primary meterset.
    
    Returns:
    String - value of Specified Primary Meterset.
  - setSpecifiedSecondaryMeterset
```
public void setSpecifiedSecondaryMeterset(java.lang.String strSpecifiedSecondaryMeterset)
```
    Sets Desired machine setting of Secondary meterset.
    
    Parameters:
    strSpecifiedSecondaryMeterset - String value of Specified Secondary Meterset.
  - getSpecifiedSecondaryMeterset
```
public java.lang.String getSpecifiedSecondaryMeterset()
```
    Retrieves Desired machine setting of Secondary meterset.
    
    Returns:
    String - value of Specified Secondary Meterset.
  - setDeliveredPrimaryMeterset
```
public void setDeliveredPrimaryMeterset(java.lang.String strDeliveredPrimaryMeterset)
```
    Sets Machine setting actually delivered as recorded by primary meterset.
    
    Parameters:
    strDeliveredPrimaryMeterset - String value of Delivered Primary Meterset.
  - getDeliveredPrimaryMeterset
```
public java.lang.String getDeliveredPrimaryMeterset()
```
    Retrieves Machine setting actually delivered as recorded by primary meterset
    
    Returns:
    String - value of Delivered Primary Meterset.
  - setDeliveredSecondaryMeterset
```
public void setDeliveredSecondaryMeterset(java.lang.String strDeliveredSecondaryMeterset)
```
    Sets Machine setting actually delivered as recorded by Secondary meterset.
    
    Parameters:
    strDeliveredSecondaryMeterset - String value of Delivered Secondary Meterset.
  - getDeliveredSecondaryMeterset
```
public java.lang.String getDeliveredSecondaryMeterset()
```
    Retrieves Machine setting actually delivered as recorded by Secondary meterset
    
    Returns:
    String - value of Delivered Secondary Meterset.
  - setSpecifiedTreatmentTime
```
public void setSpecifiedTreatmentTime(java.lang.String strSpecifiedTreatmentTime)
```
    Sets Treatment Time (sec)..
    
    Parameters:
    strSpecifiedTreatmentTime - String value of Specified Treatment Time.
  - getSpecifiedTreatmentTime
```
public java.lang.String getSpecifiedTreatmentTime()
```
    Retrieves Treatment Time .
    
    Returns:
    String - value of Specified Treatment Time.
  - setDeliveredTreatmentTime
```
public void setDeliveredTreatmentTime(java.lang.String strDeliveredTreatmentTime)
```
    Sets Treatment Time actually delivered.
    
    Parameters:
    strDeliveredTreatmentTime - String value of Delivered Treatment Time.
  - getDeliveredTreatmentTime
```
public java.lang.String getDeliveredTreatmentTime()
```
    Retrieves Treatment Time actually delivered .
    
    Returns:
    String - value of Delivered Treatment Time.
  - setNumberOfControlPoints
```
public void setNumberOfControlPoints(java.lang.String strNumberOfControlPoints)
```
    Sets Number of control points delivered.
    
    Parameters:
    strNumberOfControlPoints - String value of Number Of Control Points.
  - getNumberOfControlPoints
```
public java.lang.String getNumberOfControlPoints()
```
    Retrieves Number of control points delivered .
    
    Returns:
    String - value of Number Of Control Points.
  - getIonControlPointDeliverySequence
```
public IonControlPointDeliverySequence getIonControlPointDeliverySequence()
```
    Retrieves pre-initialized object of Ion Control Point Delivery 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:
    IonControlPointDeliverySequence - instance of Ion Control Point Delivery Sequence.

Class TreatmentSessionIonBeamSequenceItem

Method Summary

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

Methods inherited from class java.lang.Object

Method Detail

validateForModule

setReferencedBeamNumber

getReferencedBeamNumber

setBeamName

getBeamName

setBeamDescription

getBeamDescription

setBeamType

getBeamType

setRadiationType

getRadiationType

setRadiationMassNumber

getRadiationMassNumber

setRadiationAtomicNumber

getRadiationAtomicNumber

setRadiationChargeState

getRadiationChargeState

setScanMode

getScanMode

setReferencedToleranceTableNumber

getReferencedToleranceTableNumber

getBeamLimitingDeviceLeafPairsSequence

setReferencedPatientSetupNumber

getReferencedPatientSeupNumber

getReferencedCalculatedDoseReferenceSequence

setNumberofWedges

getNumberofWedges

getRecordedWedgeSequence

setNumberofCompensators

getNumberofCompensators

getRecordedCompensatorSequence

setNumberOfBoli

getNumberOfBoli

getReferencedBolusSequence

setNumberOfBlocks

getNumberOfBlocks

getRecordedBlockSequence

getRecordedSnoutSequence

getApplicatorSequence

getGeneralAccessorySequence

setNumberofRangeShifters

getNumberofRangeShifters

getRecordedRangeShifterSequence

setNumberofLateralSpreadingDevices

getNumberofLateralSpreadingDevices

getRecordedLateralSpreadingDeviceSequence

setNumberofRangeModulators

getNumberofRangeModulators

getRecordedRangeModulatorSequence

setFixationLightAzimuthalAngle

getFixationLightAzimuthalAngle

setFixationLightPolarAngle

getFixationLightPolarAngle

setCurrentFractionNumber

getCurrentFractionNumber

setTreatmentDeliveryType

getTreatmentDeliveryType

setTreatmentTerminationStatus

getTreatmentTerminationStatus

setTreatmentTerminationCode

getTreatmentTerminationCode

setTreatmentVerificationStatus

getTreatmentVerificationStatus

setSpecifiedPrimaryMeterset

getSpecifiedPrimaryMeterset

setSpecifiedSecondaryMeterset

getSpecifiedSecondaryMeterset

setDeliveredPrimaryMeterset

getDeliveredPrimaryMeterset

setDeliveredSecondaryMeterset

getDeliveredSecondaryMeterset

setSpecifiedTreatmentTime

getSpecifiedTreatmentTime

setDeliveredTreatmentTime

getDeliveredTreatmentTime