cdac.medinfo.sdk.dcm30_04.baselibs

Class BeamTaskSequenceItem

java.lang.Object

cdac.medinfo.sdk.dcm30_04.baselibs.Item

cdac.medinfo.sdk.dcm30_04.baselibs.BeamTaskSequenceItem

All Implemented Interfaces:

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

public class BeamTaskSequenceItem
extends Item

This item class contains the methods to set, get and validate the attribute present in Beam Task Sequence .

See Also:

Serialized Form

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getAutosequenceFlag() Retrieves type of the Auto sequence Flag encoded in this Item
int[]	getBeamOrderIndex() Retrieves Referenced Beam Order Index.
java.lang.String	getBeamTaskType() Retrieves type of the BeamTaskType encoded in this Item
double	getContinuationEndMeterset() Retrieves the Minimal value of Continuation End Meter set.
double	getContinuationStartMeterset() Retrieves the Minimal value of Continuation Start Meterset.
java.lang.String	getCurrentFractionNumber() Retrieves Current Fraction Number.
DeliveryVerificationImageSequence	getDeliveryVerificationImageSequence() Retrieves pre-initialized object of Delivery 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.
double	getPatientSupportAdjustedAngle() Retrieves the Minimal value of Patient Support Adjusted Angle.
java.lang.String	getPrimaryDosimeterUnit() Retrieves type of the Measurement unit of machine dosimeter
java.lang.String	getReferencedBeamNumber() Retrieves Referenced Beam Number.
java.lang.String	getReferencedFractionGroupNumber() Retrieves Referenced Fraction Group Number.
double	getTableTopEccentricAdjustedAngle() Retrieves the Minimal value of Table Top Eccentric Adjusted Angle.
double	getTableTopLateralAdjustedPosition() Retrieves the Minimal value of Table Top Longitudinal Adjusted Position.
java.lang.String	getTableTopLateralSetupDisplacement() Retrieves Table Top Lateral Setup Displacement.
double	getTableTopLongitudinalAdjustedPosition() Retrieves the Minimal value of Table Top Longitudinal Adjusted Position.
java.lang.String	getTableTopLongitudinalSetupDisplacement() Retrieves Table Top Longitudinal Setup Displacement.
double	getTableTopPitchAdjustedAngle() Retrieves the Minimal value of Table Top Pitch Adjusted Angle.
double	getTableTopRollAdjustedAngle() Retrieves the Minimal value of Table Top Roll Adjusted Angle.
double	getTableTopVerticalAdjustedPosition() Retrieves the Minimal value of Table Top Vertical Adjusted Position.
java.lang.String	getTableTopVerticalSetupDisplacement() Retrieves Table Top Vertical Setup Displacement.
java.lang.String	getTreatmentDeliveryType() Retrieves type of the TreatmentDeliveryType encoded in this Item
void	setAutosequenceFlag(EnumAutosequenceFlag enumAutosequenceFlag) Sets the Auto sequence Flag Defined in Terms of EnumAutosequenceFlag
void	setBeamOrderIndex(int[] lArrBeamOrderIndex) Sets An ordered set of one or more integers that uniquely identifies the Target Content Item of the relationship.
void	setBeamTaskType(EnumBeamTaskType enumBeamTaskType) Sets the BeamTaskType Type Defined in Terms enumBeamTaskType Enumerated Values: VERIFY :Beam verification only TREAT :Beam treatment only VERIFY_AND_TREAT : Beam verification and treatment Indication whether beam is to be verified, treated (delivered), or both.
void	setContinuationEndMeterset(double dblContinuationEndMeterset) Sets the Minimal value of Continuation End Meterset.
void	setContinuationStartMeterset(double dblContinuationStartMeterset) Sets the Minimal value of Continuation Start Meterset.
void	setCurrentFractionNumber(java.lang.String strCurrentFractionNumber) Sets Referenced Reference Image Number.
void	setPatientSupportAdjustedAngle(double dblPatientSupportAdjustedAngle) Sets the Minimal value of Patient Support Adjusted Angle.
void	setPrimaryDosimeterUnit(EnumTreatmentDeliveryType enumTreatmentDeliveryType) Sets the Treatment Delivery Type Defined in Terms of EnumPrimaryDosimeterUnit Measurement unit of machine dosimeter.Enumerated Values: MU Monitor Unit MINUTE minute NP Number of Particles
void	setReferencedBeamNumber(java.lang.String strReferencedBeamNumber) Sets ReferencedBeamNumber.
void	setReferencedFractionGroupNumber(java.lang.String strReferencedFractionGroupNumber) Sets Referenced Fraction Group Number.
void	setTableTopEccentricAdjustedAngle(double dblTableTopEccentricAdjustedAngle) Sets the Minimal value of Table Top Eccentric Adjusted Angle.
void	setTableTopLateralAdjustedPosition(double dblTableTopLateralAdjustedPosition) Sets the Minimal value of Table Top Lateral Adjusted Position.
void	setTableTopLateralSetupDisplacement(java.lang.String strTableTopLateralSetupDisplacement) Sets Table Top Lateral Setup Displacement.
void	setTableTopLongitudinalAdjustedPosition(double dblTableTopLongitudinalAdjustedPosition) Sets the Minimal value of Table Top Longitudinal Adjusted Position.
void	setTableTopLongitudinalSetupDisplacement(java.lang.String strTableTopLongitudinalSetupDisplacement) Sets Table Top Longitudinal Setup Displacement.
void	setTableTopPitchAdjustedAngle(double dblTableTopPitchAdjustedAngle) Sets the Minimal value of Table Top Pitch Adjusted Angle.
void	setTableTopRollAdjustedAngle(double dblTableTopRollAdjustedAngle) Sets the Minimal value of Table Top Roll Adjusted Angle.
void	setTableTopVerticalAdjustedPosition(double dblTableTopVerticalAdjustedPosition) Sets the Minimal value of Table Top Vertical Adjusted Position.
void	setTableTopVerticalSetupDisplacement(java.lang.String strTableTopVerticalSetupDisplacement) Sets Table Top Vertical Setup Displacement.
void	setTreatmentDeliveryType(EnumTreatmentDeliveryType enumTreatmentDeliveryType) Sets the Treatment Delivery Type Defined in Terms of EnumTreatmentDeliveryType Enumerated Values: TREATMENT : normal patient treatment CONTINUATION : continuation of interrupted treatment
boolean	validateForModule() Validates all the attributes in BeamTaskSequenceItem 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 BeamTaskSequenceItem that are present in the DataSet

Specified by:

validateForModule in interface IItem

Overrides:

validateForModule in class Item

Returns:

boolean - Success -true, Failure - false

Throws:

MandatoryMissingException - throws MandatoryMissingException If Conditional element fails.

InvalidItemException - Signals Item Validation is failed.

setBeamTaskType

public void setBeamTaskType(EnumBeamTaskType enumBeamTaskType)

Sets the BeamTaskType Type Defined in Terms enumBeamTaskType Enumerated Values: VERIFY :Beam verification only TREAT :Beam treatment only VERIFY_AND_TREAT : Beam verification and treatment Indication whether beam is to be verified, treated (delivered), or both.

Parameters:

enumBeamTaskType - Specifies type of the value encoded in this Item

getBeamTaskType

public java.lang.String getBeamTaskType()

Retrieves type of the BeamTaskType encoded in this Item

Returns:

String - Type of the BeamTaskType encoded in this Item

setTreatmentDeliveryType

public void setTreatmentDeliveryType(EnumTreatmentDeliveryType enumTreatmentDeliveryType)

Sets the Treatment Delivery Type Defined in Terms of EnumTreatmentDeliveryType Enumerated Values: TREATMENT : normal patient treatment CONTINUATION : continuation of interrupted treatment

Parameters:

enumTreatmentDeliveryType - Specifies type of the value encoded in this Item

getTreatmentDeliveryType

public java.lang.String getTreatmentDeliveryType()

Retrieves type of the TreatmentDeliveryType encoded in this Item

Returns:

String - Type of the Treatment Delivery Type encoded in this Item

setPrimaryDosimeterUnit

public void setPrimaryDosimeterUnit(EnumTreatmentDeliveryType enumTreatmentDeliveryType)

Sets the Treatment Delivery Type Defined in Terms of EnumPrimaryDosimeterUnit Measurement unit of machine dosimeter.Enumerated Values: MU Monitor Unit MINUTE minute NP Number of Particles

Parameters:

enumPrimaryDosimeterUnit - Specifies type of the value encoded in this Item

getPrimaryDosimeterUnit

public java.lang.String getPrimaryDosimeterUnit()

Retrieves type of the Measurement unit of machine dosimeter

Returns:

String - Type of the PrimaryDosimeterUnit encoded in this Item

setContinuationStartMeterset

public void setContinuationStartMeterset(double dblContinuationStartMeterset)

Sets the Minimal value of Continuation Start Meterset. Meterset within Beam referenced by Referenced Beam Number (300C,0006) at which treatment delivery starts, in units specified by Primary Dosimeter Unit (300A,00B3).

Parameters:

dblContinuationStartMeterset - Double value of coordinates

getContinuationStartMeterset

public double getContinuationStartMeterset()

Retrieves the Minimal value of Continuation Start Meterset.

Returns:

double - double value of ContinuationStartMeterset

setContinuationEndMeterset

public void setContinuationEndMeterset(double dblContinuationEndMeterset)

Sets the Minimal value of Continuation End Meterset. Meterset within Beam referenced by Referenced Beam Number (300C,0006) at which treatment delivery ends, in units specified by Primary Dosimeter Unit (300A,00B3). Required if Treatment Delivery Type (300A,00CE) is CONTINUATION.

Parameters:

dblContinuationEndMeterset - Double value of coordinates

getContinuationEndMeterset

public double getContinuationEndMeterset()

Retrieves the Minimal value of Continuation End Meter set.

Returns:

double - double value of ContinuationEndMeterset

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.

setReferencedFractionGroupNumber

public void setReferencedFractionGroupNumber(java.lang.String strReferencedFractionGroupNumber)

Sets Referenced Fraction Group Number. Indicates which fraction group of the referenced plan is to be treated in the treatment session. Only one Fraction Group shall be specified per Delivery Instruction SOP Instance.

Parameters:

strReferencedFractionGroupNumber - String value of Referenced Fraction Group Number.

getReferencedFractionGroupNumber

public java.lang.String getReferencedFractionGroupNumber()

Retrieves Referenced Fraction Group Number. Indicates which fraction group of the referenced plan is to be treated in the treatment session.

Returns:

String - value of ReferencedFractionGroupNumber.

setReferencedBeamNumber

public void setReferencedBeamNumber(java.lang.String strReferencedBeamNumber)

Sets ReferencedBeamNumber. Uniquely identifies the Beam that is specified by Beam Number (300A,00C0) within Beam Sequence (300A,00B0) in RT Beams Module of referenced RT Plan or within Ion Beam Sequence (300A,03A2) in RT Ion Beams Module of the referenced RT Ion Plan.

Parameters:

strReferencedBeamNumber - String value of Referenced Beam Number.

getReferencedBeamNumber

public java.lang.String getReferencedBeamNumber()

Retrieves Referenced Beam Number. Uniquely identifies the Beam that is specified by Beam Number

Returns:

String - value of Referenced Beam Number.

setBeamOrderIndex

public void setBeamOrderIndex(int[] lArrBeamOrderIndex)

Sets An ordered set of one or more integers that uniquely identifies the Target Content Item of the relationship. The root Content Item is referenced by a single value of 1.

Parameters:

lArrBeamOrderIndex - Long value of Referenced Content Item Identifier

getBeamOrderIndex

public int[] getBeamOrderIndex()

Retrieves Referenced Beam Order Index.

Returns:

long[] - long value of Beam Order Index.

setAutosequenceFlag

public void setAutosequenceFlag(EnumAutosequenceFlag enumAutosequenceFlag)

Sets the Auto sequence Flag Defined in Terms of EnumAutosequenceFlag

Parameters:

enumAutosequenceFlag - Specifies type of the value encoded in this Item

getAutosequenceFlag

public java.lang.String getAutosequenceFlag()

Retrieves type of the Auto sequence Flag encoded in this Item

Returns:

String - Type of the Auto sequence Flag encoded in this Item

setTableTopVerticalAdjustedPosition

public void setTableTopVerticalAdjustedPosition(double dblTableTopVerticalAdjustedPosition)

Sets the Minimal value of Table Top Vertical Adjusted Position. Adjusted Table Top Vertical position in the IEC TABLE TOP coordinate system in mm for patient setup.

Parameters:

dblTableTopVerticalAdjustedPosition - Double value of coordinates

getTableTopVerticalAdjustedPosition

public double getTableTopVerticalAdjustedPosition()

Retrieves the Minimal value of Table Top Vertical Adjusted Position.

Returns:

double - double value of TableTopVerticalAdjustedPosition

setTableTopLongitudinalAdjustedPosition

public void setTableTopLongitudinalAdjustedPosition(double dblTableTopLongitudinalAdjustedPosition)

Sets the Minimal value of Table Top Longitudinal Adjusted Position. Adjusted Table Top Longitudinal position in the IEC TABLE TOP coordinate system in mm for patient setup.

Parameters:

dblTableTopLongitudinalAdjustedPosition - Double value of coordinates

getTableTopLongitudinalAdjustedPosition

public double getTableTopLongitudinalAdjustedPosition()

Retrieves the Minimal value of Table Top Longitudinal Adjusted Position.

Returns:

double - double value of TableTopLongitudinalAdjustedPosition

setTableTopLateralAdjustedPosition

public void setTableTopLateralAdjustedPosition(double dblTableTopLateralAdjustedPosition)

Sets the Minimal value of Table Top Lateral Adjusted Position. Adjusted Table Top Lateral position in the IEC TABLE TOP coordinate system in mm for patient setup.

Parameters:

dblTableTopLateralAdjustedPosition - Double value of coordinates

getTableTopLateralAdjustedPosition

public double getTableTopLateralAdjustedPosition()

Retrieves the Minimal value of Table Top Longitudinal Adjusted Position.

Returns:

double - double value of TableTopLongitudinalAdjustedPosition

setPatientSupportAdjustedAngle

public void setPatientSupportAdjustedAngle(double dblPatientSupportAdjustedAngle)

Sets the Minimal value of Patient Support Adjusted Angle. Adjusted Patient Support Adjusted Angle in the IEC PATIENT SUPPORT coordinate system with respect to the IEC FIXED REFERENCE.

Parameters:

dblPatientSupportAdjustedAngle - Double value of coordinates

getPatientSupportAdjustedAngle

public double getPatientSupportAdjustedAngle()

Retrieves the Minimal value of Patient Support Adjusted Angle.

Returns:

double - double value of PatientSupportAdjustedAngle

setTableTopEccentricAdjustedAngle

public void setTableTopEccentricAdjustedAngle(double dblTableTopEccentricAdjustedAngle)

Sets the Minimal value of Table Top Eccentric Adjusted Angle. Adjusted Table Top (non-isocentric) angle for patient setup, i.e., orientation of the IEC TABLE TOP ECCENTRIC coordinate system with respect to the IEC PATIENT SUPPORT system in degrees.

Parameters:

dblTableTopEccentricAdjustedAngle - Double value of coordinates

getTableTopEccentricAdjustedAngle

public double getTableTopEccentricAdjustedAngle()

Retrieves the Minimal value of Table Top Eccentric Adjusted Angle.

Returns:

double - double value of TableTopEccentricAdjustedAngle

setTableTopPitchAdjustedAngle

public void setTableTopPitchAdjustedAngle(double dblTableTopPitchAdjustedAngle)

Sets the Minimal value of Table Top Pitch Adjusted Angle. Adjusted Table Top Pitch Angle for patient setup, i.e., the rotation of the IEC TABLE TOP coordinate system about the X-axis of the IEC TABLE TOP coordinate system in degrees.

Parameters:

dblTableTopEccentricAdjustedAngle - Double value of coordinates

getTableTopPitchAdjustedAngle

public double getTableTopPitchAdjustedAngle()

Retrieves the Minimal value of Table Top Pitch Adjusted Angle.

Returns:

double - double value of TableTopPitchAdjustedAngle

setTableTopRollAdjustedAngle

public void setTableTopRollAdjustedAngle(double dblTableTopRollAdjustedAngle)

Sets the Minimal value of Table Top Roll Adjusted Angle. Adjusted Table Top Roll Angle for patient setup, i.e., the rotation of the IEC TABLE TOP coordinate system about the Y-axis of the IEC TABLE TOP coordinate system in degrees.

Parameters:

dblTableTopRollAdjustedAngle - Double value of coordinates

getTableTopRollAdjustedAngle

public double getTableTopRollAdjustedAngle()

Retrieves the Minimal value of Table Top Roll Adjusted Angle.

Returns:

double - double value of TableTopRollAdjustedAngle

setTableTopVerticalSetupDisplacement

public void setTableTopVerticalSetupDisplacement(java.lang.String strTableTopVerticalSetupDisplacement)

Sets Table Top Vertical Setup Displacement.

Parameters:

strTableTopVerticalSetupDisplacement - String value of Table Top Vertical Setup Displacement.

getTableTopVerticalSetupDisplacement

public java.lang.String getTableTopVerticalSetupDisplacement()

Retrieves Table Top Vertical Setup Displacement.

Returns:

String - value of Table Top Vertical Setup Displacement.

setTableTopLongitudinalSetupDisplacement

public void setTableTopLongitudinalSetupDisplacement(java.lang.String strTableTopLongitudinalSetupDisplacement)

Sets Table Top Longitudinal Setup Displacement.

Parameters:

strTableTopLongitudinalSetupDisplacement - String value of Table Top Longitudinal Setup Displacement.

getTableTopLongitudinalSetupDisplacement

public java.lang.String getTableTopLongitudinalSetupDisplacement()

Retrieves Table Top Longitudinal Setup Displacement.

Returns:

String - value of Table Top Longitudinal Setup Displacement.

setTableTopLateralSetupDisplacement

public void setTableTopLateralSetupDisplacement(java.lang.String strTableTopLateralSetupDisplacement)

Sets Table Top Lateral Setup Displacement.

Parameters:

strTableTopLateralSetupDisplacement - String value of Table Top Lateral Setup Displacement.

getTableTopLateralSetupDisplacement

public java.lang.String getTableTopLateralSetupDisplacement()

Retrieves Table Top Lateral Setup Displacement.

Returns:

String - value of Table Top Lateral Setup Displacement.

getDeliveryVerificationImageSequence

public DeliveryVerificationImageSequence getDeliveryVerificationImageSequence()

Retrieves pre-initialized object of Delivery 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.

Returns:

Delivery Verification Image Sequence - instance of DeliveryVerificationImageSequence.