IonBeamSequenceItem

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

All Implemented Interfaces:

IItem, ICollectionIterable<IDataElement>, java.io.Serializable, java.lang.Iterable<IDataElement>
```
public class IonBeamSequenceItem
extends Item
```
This item class contains the methods to set, get and validate the attribute present in 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.
`java.lang.String`	`getBeamName()` Retrieves User-defined name for Beam.
`java.lang.String`	`getBeamNumber()` Retrieves Identification number of the Beam.It should be unique within the beam in which it is created.
`java.lang.String`	`getBeamType()` Retrieves Motion characteristic of Beam.
`java.lang.String`	`getDeviceSerialNumber()` Retrieves Manufacturer's serial number of the equipment used for beam delivery.
`java.lang.String`	`getFinalCumulativeMetersetWeight()` Retrieves Value of Cumulative Meterset Weight (300A,0134) for final Control Point in Control Point Sequence (300A,0111).
`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
`java.lang.String`	`getInstitutionAddress()` Retrieves Mailing address of the institution where the equipment is located that was used for beam delivery.
`java.lang.String`	`getInstitutionalDepartmentName()` Retrieves Institution where the equipment is located that was used for beam delivery.
`java.lang.String`	`getInstitutionName()` Retrieves Institution where the equipment is located that was used for beam delivery.
`IonBeamLimitingDeviceSequence`	`getIonBeamLimitingDeviceSequence()` Retrieves pre-initialized object of Ion Beam Limiting 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.
`IonBlockSequence`	`getIonBlockSequence()` Retrieves pre-initialized object of Ion 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
`IonControlPointSequence`	`getIonControlPointSequence()` Retrieves pre-initialized object of Ion Control Point 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
`IonRangeCompensatorSequence`	`getIonRangeCompensatorSequence()` Retrieves pre-initialized object of Ion Range 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.
`IonWedgeSequence`	`getIonWedgeSequence()` Retrieves pre-initialized object of Ion 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`	`getManufacturer()` Retrieves Manufacturer of the equipment used for beam delivery.
`java.lang.String`	`getManufacturersModelName()` Retrieves Manufacturer's model name of the equipment used for beam delivery.
`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`	`getPrimaryDosimeterUnit()` Retrieves Measurement unit of machine dosimeter.
`java.lang.String`	`getRadiationAtomicNumber()` Retrieves Radiation Atomic Number.
`short[]`	`getRadiationChargeState()` Returns the Charge state of radiation .
`java.lang.String`	`getRadiationMassNumber()` Retrieves Radiation Mass Number.
`java.lang.String`	`getRadiationType()` Retrieves Particle type of Beam.
`RangeModulatorSequence`	`getRangeModulatorSequence()` 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.
`RangeShifterSequence`	`getRangeShifterSequence()` Retrieves pre-initialized object of 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.
`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.
`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.
`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
`ReferencedDoseSequence`	`getReferencedDoseSequence()` Retrieves pre-initialized object of Referenced Dose 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.
`ReferencedReferenceImageSequence`	`getReferencedReferenceImageSequence()` Retrieves pre-initialized object of Referenced Reference Image 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`	`getReferencedToleranceTableNumber()` Retrieves Referenced Tolerance Table Number.
`java.lang.String`	`getScanMode()` Retrieves type of the value encoded in this Item
`float`	`getTotalBlockTrayWaterEquivalentThickness()` Retrieves the TotalBlockTrayWaterEquivalentThickness.
`float`	`getTotalCompensatorTrayWaterEquivalentThickness()` Retrieves the TotalCompensatorTrayWaterEquivalentThickness.
`float`	`getTotalWedgeTrayWaterEquivalentThickness()` Retrieves the TotalWedgeTrayWaterEquivalentThickness.
`java.lang.String`	`getTreatmentDeliveryType()` Retrieves Treatment Delivery Type.
`java.lang.String`	`getTreatmentMachineName()` Retrieves Treatment Machine Name.
`float[]`	`getVirtualSourceAxisDistances()` Retrieves VirtualSourceAxisDistances.
`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`	`setBeamNumber(java.lang.String strBeamNumber)` Identification number of the Beam.It should be unique within the beam in which it is created.
`void`	`setBeamType(EnumBeamType enumBeamType)` Sets Motion characteristic of Beam.
`void`	`setDeviceSerialNumber(java.lang.String strDeviceSerialNumber)` Sets Manufacturer's serial number of the equipment used for beam delivery.
`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`	`setInstitutionAddress(java.lang.String strInstitutionAddress)` Sets Mailing address of the institution where the equipment is located that was used for beam delivery.
`void`	`setInstitutionalDepartmentName(java.lang.String strInstitutionalDepartmentName)` Sets Institution where the equipment is located that was used for beam delivery.
`void`	`setInstitutionName(java.lang.String strInstitutionName)` Sets Institution where the equipment is located that was used for beam delivery.
`void`	`setManufacturer(java.lang.String strManufacturer)` Sets the Manufacturer of the equipment used for beam delivery..
`void`	`setManufacturersModelName(java.lang.String strManufacturersModelName)` Sets Manufacturer's model name of the equipment used for beam delivery.
`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`	`setPrimaryDosimeterUnit(EnumPrimaryDosimeterUnit enumPrimaryDosimeterUnit)` Sets Measurement unit of machine dosimeter.
`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`	`setRadiationType(EnumRadiationType enumRadiationType)` Sets Particle type of Beam.
`void`	`setReferencedPatientSetupNumber(java.lang.String strReferencedPatientSetupNumber)` Sets Referenced Patient Setup Number.
`void`	`setReferencedToleranceTableNumber(java.lang.String strReferencedToleranceTableNumber)` Sets Uniquely identifies Tolerance Table specified by Tolerance Table Number (300A,0042) within Tolerance Table Sequence in RT Tolerance Tables Module.
`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.
`void`	`setTotalBlockTrayWaterEquivalentThickness(float fTotalBlockTrayWaterEquivalentThickness)` Sets the TotalBlockTrayWaterEquivalentThickness.
`void`	`setTotalCompensatorTrayWaterEquivalentThickness(float fTotalCompensatorTrayWaterEquivalentThickness)` Sets the TotalCompensatorTrayWaterEquivalentThickness.
`void`	`setTotalWedgeTrayWaterEquivalentThickness(float fTotalWedgeTrayWaterEquivalentThickness)` Sets the TotalWedgeTrayWaterEquivalentThickness.
`void`	`setTreatmentDeliveryType(EnumTreatmentDeliveryType enumTreatmentDeliveryType)` Sets Treatment Delivery Type.
`void`	`setTreatmentMachineName(java.lang.String strTreatmentMachineName)` Sets User-defined name identifying treatment machine used for beam delivery.
`void`	`setVirtualSourceAxisDistances(float[] arrVirtualSourceAxisDistances)` Sets VirtualSourceAxisDistances
`boolean`	`validateForModule()` Validates all the attributes in BeamSequenceItem 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 BeamSequenceItem 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.
  - setBeamNumber
```
public void setBeamNumber(java.lang.String strBeamNumber)
```
    Identification number of the Beam.It should be unique within the beam in which it is created.
    
    Parameters:
    strBeamNumber - String value of Beam Number.
  - getBeamNumber
```
public java.lang.String getBeamNumber()
```
    Retrieves Identification number of the Beam.It should be unique within the beam in which it is created.
    
    Returns:
    String - value of 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 Control Point Sequence (300A,0111) attributes remain unchanged between consecutive pairs of control points with changing Cumulative Meterset Weight (300A,0134). DYNAMIC = One or more Control Point Sequence (300A,0111) attributes change between one or more consecutive pairs of control points with changing Cumulative Meterset Weight (300A,0134).
    
    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, ELECTRON, NEUTRON, PROTON.
    
    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 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
  - setTreatmentMachineName
```
public void setTreatmentMachineName(java.lang.String strTreatmentMachineName)
```
    Sets User-defined name identifying treatment machine used for beam delivery.
    
    Parameters:
    strTreatmentMachineName - String value of Treatment Machine Name.
  - getTreatmentMachineName
```
public java.lang.String getTreatmentMachineName()
```
    Retrieves Treatment Machine Name.
    
    Returns:
    String - value of Treatment Machine Name
  - setManufacturer
```
public void setManufacturer(java.lang.String strManufacturer)
```
    Sets the Manufacturer of the equipment used for beam delivery..
    
    Parameters:
    strManufacturer - String value of Manufacturer .
  - getManufacturer
```
public java.lang.String getManufacturer()
```
    Retrieves Manufacturer of the equipment used for beam delivery.
    
    Returns:
    String - value of Manufacturer.
  - setInstitutionName
```
public void setInstitutionName(java.lang.String strInstitutionName)
```
    Sets Institution where the equipment is located that was used for beam delivery.
    
    Parameters:
    strInstitutionName - String value of Institution Name .
  - getInstitutionName
```
public java.lang.String getInstitutionName()
```
    Retrieves Institution where the equipment is located that was used for beam delivery.
    
    Returns:
    String - value of Institution Name.
  - setInstitutionAddress
```
public void setInstitutionAddress(java.lang.String strInstitutionAddress)
```
    Sets Mailing address of the institution where the equipment is located that was used for beam delivery.
    
    Parameters:
    strInstitutionAddress - String value of Institution Address .
  - getInstitutionAddress
```
public java.lang.String getInstitutionAddress()
```
    Retrieves Mailing address of the institution where the equipment is located that was used for beam delivery.
    
    Returns:
    String - value of Institution Address.
  - setInstitutionalDepartmentName
```
public void setInstitutionalDepartmentName(java.lang.String strInstitutionalDepartmentName)
```
    Sets Institution where the equipment is located that was used for beam delivery.
    
    Parameters:
    strInstitutionalDepartmentName - String value of Institution Name .
  - getInstitutionalDepartmentName
```
public java.lang.String getInstitutionalDepartmentName()
```
    Retrieves Institution where the equipment is located that was used for beam delivery.
    
    Returns:
    String - value of Institution Name.
  - setManufacturersModelName
```
public void setManufacturersModelName(java.lang.String strManufacturersModelName)
```
    Sets Manufacturer's model name of the equipment used for beam delivery.
    
    Parameters:
    strManufacturersModelName - String value of Manufacturers Model Name .
  - getManufacturersModelName
```
public java.lang.String getManufacturersModelName()
```
    Retrieves Manufacturer's model name of the equipment used for beam delivery.
    
    Returns:
    String - value of Manufacturers Model Name.
  - setDeviceSerialNumber
```
public void setDeviceSerialNumber(java.lang.String strDeviceSerialNumber)
```
    Sets Manufacturer's serial number of the equipment used for beam delivery.
    
    Parameters:
    strDeviceSerialNumber - String value of Device Serial Number.
  - getDeviceSerialNumber
```
public java.lang.String getDeviceSerialNumber()
```
    Retrieves Manufacturer's serial number of the equipment used for beam delivery.
    
    Returns:
    String - value of Device Serial Number.
  - setPrimaryDosimeterUnit
```
public void setPrimaryDosimeterUnit(EnumPrimaryDosimeterUnit enumPrimaryDosimeterUnit)
```
    Sets Measurement unit of machine dosimeter. Enumerated Values: MU = Monitor Unit MINUTE = minute
    
    Parameters:
    enumPrimaryDosimeterUnit - Enum value of Primary Dosimeter Unit.
  - getPrimaryDosimeterUnit
```
public java.lang.String getPrimaryDosimeterUnit()
```
    Retrieves Measurement unit of machine dosimeter.
    
    Returns:
    String - value of Primary Dosimeter Unit.
  - setReferencedToleranceTableNumber
```
public void setReferencedToleranceTableNumber(java.lang.String strReferencedToleranceTableNumber)
```
    Sets Uniquely identifies Tolerance Table specified by Tolerance Table Number (300A,0042) within Tolerance Table Sequence in RT Tolerance Tables Module.
    
    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.
  - setVirtualSourceAxisDistances
```
public void setVirtualSourceAxisDistances(float[] arrVirtualSourceAxisDistances)
```
    Sets VirtualSourceAxisDistances
    
    Parameters:
    arrVirtualSourceAxisDistances - pair of floating point numbers
  - getVirtualSourceAxisDistances
```
public float[] getVirtualSourceAxisDistances()
```
    Retrieves VirtualSourceAxisDistances.
    
    Returns:
    float[] - Float array of Virtual Source Axis Distances.
  - getIonBeamLimitingDeviceSequence
```
public IonBeamLimitingDeviceSequence getIonBeamLimitingDeviceSequence()
```
    Retrieves pre-initialized object of Ion Beam Limiting 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:
    IonBeamLimitingDeviceSequence - 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.
  - getReferencedReferenceImageSequence
```
public ReferencedReferenceImageSequence getReferencedReferenceImageSequence()
```
    Retrieves pre-initialized object of Referenced Reference Image 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:
    ReferencedReferenceImageSequence - instance of Referenced Reference Image Sequence.
  - 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.
  - getReferencedDoseSequence
```
public ReferencedDoseSequence getReferencedDoseSequence()
```
    Retrieves pre-initialized object of Referenced Dose 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:
    ReferencedDoseSequence - instance of Referenced Dose 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.
  - setTotalWedgeTrayWaterEquivalentThickness
```
public void setTotalWedgeTrayWaterEquivalentThickness(float fTotalWedgeTrayWaterEquivalentThickness)
```
    Sets the TotalWedgeTrayWaterEquivalentThickness.
    
    Parameters:
    fTotalWedgeTrayWaterEquivalentThickness - Float value of the Total Wedge Tray Water Equivalent Thickness
  - getTotalWedgeTrayWaterEquivalentThickness
```
public float getTotalWedgeTrayWaterEquivalentThickness()
```
    Retrieves the TotalWedgeTrayWaterEquivalentThickness.
    
    Returns:
    float - Float value of the TotalWedgeTrayWaterEquivalentThickness
  - getIonWedgeSequence
```
public IonWedgeSequence getIonWedgeSequence()
```
    Retrieves pre-initialized object of Ion 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:
    IonWedgeSequence - instance of Ion 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.
  - setTotalCompensatorTrayWaterEquivalentThickness
```
public void setTotalCompensatorTrayWaterEquivalentThickness(float fTotalCompensatorTrayWaterEquivalentThickness)
```
    Sets the TotalCompensatorTrayWaterEquivalentThickness.
    
    Parameters:
    fTotalCompensatorTrayWaterEquivalentThickness - Float value of the Total Compensator Tray Water Equivalent Thickness
  - getTotalCompensatorTrayWaterEquivalentThickness
```
public float getTotalCompensatorTrayWaterEquivalentThickness()
```
    Retrieves the TotalCompensatorTrayWaterEquivalentThickness.
    
    Returns:
    float - Float value of Total Compensator Tray Water Equivalent Thickness .
  - getIonRangeCompensatorSequence
```
public IonRangeCompensatorSequence getIonRangeCompensatorSequence()
```
    Retrieves pre-initialized object of Ion Range 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:
    IonRangeCompensatorSequence - instance of Ion Range Compensator Sequence.
  - 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
  - setTotalBlockTrayWaterEquivalentThickness
```
public void setTotalBlockTrayWaterEquivalentThickness(float fTotalBlockTrayWaterEquivalentThickness)
```
    Sets the TotalBlockTrayWaterEquivalentThickness.
    
    Parameters:
    fTotalBlockTrayWaterEquivalentThickness - Float value of the Total Wedge Tray Water Equivalent Thickness
  - getTotalBlockTrayWaterEquivalentThickness
```
public float getTotalBlockTrayWaterEquivalentThickness()
```
    Retrieves the TotalBlockTrayWaterEquivalentThickness.
    
    Returns:
    float - Float value of the TotalBlockTrayWaterEquivalentThickness
  - getIonBlockSequence
```
public IonBlockSequence getIonBlockSequence()
```
    Retrieves pre-initialized object of Ion 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:
    IonBlockSequence - instance of Ion 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.
  - getRangeShifterSequence
```
public RangeShifterSequence getRangeShifterSequence()
```
    Retrieves pre-initialized object of 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:
    RangeShifterSequence - instance of 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.
  - getRangeModulatorSequence
```
public RangeModulatorSequence getRangeModulatorSequence()
```
    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.
  - getFinalCumulativeMetersetWeight
```
public java.lang.String getFinalCumulativeMetersetWeight()
```
    Retrieves Value of Cumulative Meterset Weight (300A,0134) for final Control Point in Control Point Sequence (300A,0111).
    
    Returns:
    String - value of Final Cumulative Meterset Weight.
  - 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.
  - getIonControlPointSequence
```
public IonControlPointSequence getIonControlPointSequence()
```
    Retrieves pre-initialized object of Ion Control Point 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:
    ControlPointSequence - instance of Ion Control Point Sequence.

Class IonBeamSequenceItem

Method Summary

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

Methods inherited from class java.lang.Object

Method Detail

validateForModule

setBeamNumber

getBeamNumber

setBeamName

getBeamName

setBeamDescription

getBeamDescription

setBeamType

getBeamType

setRadiationType

getRadiationType

setRadiationMassNumber

getRadiationMassNumber

setRadiationAtomicNumber

getRadiationAtomicNumber

setRadiationChargeState

getRadiationChargeState

setScanMode

getScanMode

setTreatmentMachineName

getTreatmentMachineName

setManufacturer

getManufacturer

setInstitutionName

getInstitutionName

setInstitutionAddress

getInstitutionAddress

setInstitutionalDepartmentName

getInstitutionalDepartmentName

setManufacturersModelName

getManufacturersModelName

setDeviceSerialNumber

getDeviceSerialNumber

setPrimaryDosimeterUnit

getPrimaryDosimeterUnit

setReferencedToleranceTableNumber

getReferencedToleranceTableNumber

setVirtualSourceAxisDistances

getVirtualSourceAxisDistances

getIonBeamLimitingDeviceSequence

setReferencedPatientSetupNumber

getReferencedPatientSeupNumber

getReferencedReferenceImageSequence

setTreatmentDeliveryType

getTreatmentDeliveryType

getReferencedDoseSequence

setNumberofWedges

getNumberofWedges

setTotalWedgeTrayWaterEquivalentThickness

getTotalWedgeTrayWaterEquivalentThickness

getIonWedgeSequence

setNumberofCompensators

getNumberofCompensators

setTotalCompensatorTrayWaterEquivalentThickness

getTotalCompensatorTrayWaterEquivalentThickness

getIonRangeCompensatorSequence

getRecordedCompensatorSequence

setNumberOfBoli

getNumberOfBoli

getReferencedBolusSequence

setNumberOfBlocks

getNumberOfBlocks

setTotalBlockTrayWaterEquivalentThickness

getTotalBlockTrayWaterEquivalentThickness

getIonBlockSequence

getRecordedSnoutSequence

getApplicatorSequence

getGeneralAccessorySequence

setNumberofRangeShifters

getNumberofRangeShifters

getRangeShifterSequence

setNumberofLateralSpreadingDevices

getNumberofLateralSpreadingDevices

getRecordedLateralSpreadingDeviceSequence

setNumberofRangeModulators