public class BeamSequenceItem extends Item
| 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.
|
BeamLimitingDeviceSequence |
getBeamLimitingDeviceSequence()
Retrieves pre-initialized object of 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
|
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.
|
BlockSequence |
getBlockSequence()
Retrieves pre-initialized object of 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
|
CompensatorSequence |
getCompensatorSequence()
Retrieves pre-initialized object of 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
|
ControlPointSequence |
getControlPointSequence()
Retrieves pre-initialized object of 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
|
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).
|
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 |
getHighDoseTechniqueType()
Retrieves type of high-dose treatment technique.
|
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.
|
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()
Retrieves Number of Compensators associated with current delivered Beam.
|
java.lang.String |
getNumberOfControlPoints()
Retrieves Number of control points delivered .
|
java.lang.String |
getNumberofWedges()
Retrieves Number of Wedges.
|
PlannedVerificationImageSequence |
getPlannedVerificationImageSequence()
Retrieves pre-initialized object of Planned Verification 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 |
getPrimaryDosimeterUnit()
Retrieves Measurement unit of machine dosimeter.
|
PrimaryFluenceModeSequence |
getPrimaryFluenceModeSequence()
Retrieves pre-initialized object of Primary Fluence Mode 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 |
getRadiationType()
Retrieves Particle type of Beam.
|
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 |
getSourceAxisDistance()
Retrieves Source Axis Distance.
|
java.lang.String |
getTotalBlockTrayFactor()
Retrieves Total Block Tray Factor.
|
java.lang.String |
getTotalCompensatorTrayFactor()
Retrieves Total Compensator Tray Factor.
|
java.lang.String |
getTreatmentDeliveryType()
Retrieves Treatment Delivery Type.
|
java.lang.String |
getTreatmentMachineName()
Retrieves Treatment Machine Name.
|
WedgeSequence |
getWedgeSequence()
Retrieves pre-initialized object of 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
|
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 |
setFinalCumulativeMetersetWeight(java.lang.String strFinalCumulativeMetersetWeight)
Sets Value of Cumulative Meterset Weight (300A,0134) for final Control Point in Control Point Sequence (300A,0111).
|
void |
setHighDoseTechniqueType(EnumHighDoseTechniqueType enumHighDoseTechniqueType)
Sets Type of high-dose treatment technique.
|
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 |
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 |
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 identified Tolerance Table specified by Tolerance Table Number (300A,0042) within Tolerance Table Sequence in RT Tolerance Tables Module.
|
void |
setSourceAxisDistance(java.lang.String strSourceAxisDistance)
Sets Source Axis Distance .
|
void |
setTotalBlockTrayFactor(java.lang.String strTotalBlockTrayFactor)
Sets total block tray transmission for all block trays (between 0 and 1) at the beam energy specified by the Nominal Beam Energy (300A,0114) of the first Control Point of the Control Point Sequence (300A,0111).
|
void |
setTotalCompensatorTrayFactor(java.lang.String strTotalCompensatorTrayFactor)
Sets Compensator Tray transmission factor (between 0 and 1), at the beam energy specified by the Nominal Beam Energy (300A,0114) of the first Control Point of the Control Point Sequence (300A,0111).
|
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.
|
boolean |
validateForModule()
Validates all the attributes in BeamSequenceItem that are present in the DataSet
|
addDataElement, changeToUndefined, clone, contains, dumpDICOMInfo, getDataForTag, getDictionaryReader, getItemLength, getTransferSyntax, getValue, getValueLength, iterator, read, setDictionaryReader, setTransferSyntax, setValue, sortedIterator, validate, writepublic void setBeamNumber(java.lang.String strBeamNumber)
strBeamNumber-String - value of Beam Number.public java.lang.String getBeamNumber()
public void setBeamName(java.lang.String strBeamName)
strBeamName - -String value of Beam Name.public java.lang.String getBeamName()
public void setBeamDescription(java.lang.String strBeamDescription)
strBeamDescription - -String value of Beam Description.public java.lang.String getBeamDescription()
public void setBeamType(EnumBeamType enumBeamType)
enumBeamType - Enum value of Beam Type.public java.lang.String getBeamType()
public void setRadiationType(EnumRadiationType enumRadiationType)
enumRadiationType - -Enum value of Radiation Type.public java.lang.String getRadiationType()
public PrimaryFluenceModeSequence getPrimaryFluenceModeSequence()
public void setHighDoseTechniqueType(EnumHighDoseTechniqueType enumHighDoseTechniqueType)
enumHighDoseTechniqueType - -Enum value of high-dose treatment technique Type.public java.lang.String getHighDoseTechniqueType()
public void setTreatmentMachineName(java.lang.String strTreatmentMachineName)
strTreatmentMachineName - -String value of Treatment Machine Name.public java.lang.String getTreatmentMachineName()
public void setManufacturer(java.lang.String strManufacturer)
strManufacturer- - String value of Manufacturer .public java.lang.String getManufacturer()
public void setInstitutionName(java.lang.String strInstitutionName)
strInstitutionName- - String value of Institution Name .public java.lang.String getInstitutionName()
public void setInstitutionAddress(java.lang.String strInstitutionAddress)
strInstitutionAddress - -String value of Institution Address .public java.lang.String getInstitutionAddress()
public void setInstitutionalDepartmentName(java.lang.String strInstitutionalDepartmentName)
strInstitutionalDepartmentName- - String value of Institution Name .public java.lang.String getInstitutionalDepartmentName()
public void setManufacturersModelName(java.lang.String strManufacturersModelName)
strManufacturersModelName - -String value of Manufacturers Model Name .public java.lang.String getManufacturersModelName()
public void setDeviceSerialNumber(java.lang.String strDeviceSerialNumber)
strDeviceSerialNumber - -String value of Device Serial Number.public java.lang.String getDeviceSerialNumber()
public void setPrimaryDosimeterUnit(EnumPrimaryDosimeterUnit enumPrimaryDosimeterUnit)
enumPrimaryDosimeterUnit - -Enum value of Primary Dosimeter Unit.public java.lang.String getPrimaryDosimeterUnit()
public void setReferencedToleranceTableNumber(java.lang.String strReferencedToleranceTableNumber)
strReferencedToleranceTableNumber - - String value of Referenced Tolerance Table Number.public java.lang.String getReferencedToleranceTableNumber()
public void setSourceAxisDistance(java.lang.String strSourceAxisDistance)
strSourceAxisDistance- - String value of Source Axis Distance.public java.lang.String getSourceAxisDistance()
public BeamLimitingDeviceSequence getBeamLimitingDeviceSequence()
public void setReferencedPatientSetupNumber(java.lang.String strReferencedPatientSetupNumber)
strReferencedPatientSetupNumber - String value of Referenced Patient Setup Number.public java.lang.String getReferencedPatientSeupNumber()
public ReferencedReferenceImageSequence getReferencedReferenceImageSequence()
public PlannedVerificationImageSequence getPlannedVerificationImageSequence()
public void setTreatmentDeliveryType(EnumTreatmentDeliveryType enumTreatmentDeliveryType)
enumTreatmentDeliveryType - Enum value of Treatment Delivery Type.public java.lang.String getTreatmentDeliveryType()
public ReferencedDoseSequence getReferencedDoseSequence()
public void setNumberofWedges(java.lang.String strNumberofWedges)
strNumberofWedges - String value of Number of Wedges.public java.lang.String getNumberofWedges()
public WedgeSequence getWedgeSequence()
public void setNumberofCompensators(java.lang.String strNumberofCompensators)
strNumberofCompensators - String value of Number of Compensators.public java.lang.String getNumberofCompensators()
public void setTotalCompensatorTrayFactor(java.lang.String strTotalCompensatorTrayFactor)
strTotalCompensatorTrayFactor - String value of Total Compensator Tray Factor.public java.lang.String getTotalCompensatorTrayFactor()
public CompensatorSequence getCompensatorSequence()
public void setNumberOfBoli(java.lang.String strNumberOfBoli)
strNumberOfBoli - String value of Number of Boli.public java.lang.String getNumberOfBoli()
public ReferencedBolusSequence getReferencedBolusSequence()
public void setNumberOfBlocks(java.lang.String strNumberOfBlocks)
strNumberOfBlocks - String value of Number of Blocks.public java.lang.String getNumberOfBlocks()
public void setTotalBlockTrayFactor(java.lang.String strTotalBlockTrayFactor)
strTotalBlockTrayFactor - String value of Total Block Tray Factor.public java.lang.String getTotalBlockTrayFactor()
public BlockSequence getBlockSequence()
public ApplicatorSequence getApplicatorSequence()
public GeneralAccessorySequence getGeneralAccessorySequence()
public void setFinalCumulativeMetersetWeight(java.lang.String strFinalCumulativeMetersetWeight)
strFinalCumulativeMetersetWeight - String value of Final Cumulative Meterset Weight.public java.lang.String getFinalCumulativeMetersetWeight()
public void setNumberOfControlPoints(java.lang.String strNumberOfControlPoints)
strNumberOfControlPoints - String value of Number Of Control Points.public java.lang.String getNumberOfControlPoints()
public ControlPointSequence getControlPointSequence()
public boolean validateForModule()
throws InvalidItemException
validateForModule in interface IItemvalidateForModule in class ItemInvalidItemException - throws InvalidItemException If Mandatory or Conditional element fails.