cdac.medinfo.sdk.dcm30_04.baselibs

Class ExposureSequenceItem

java.lang.Object

cdac.medinfo.sdk.dcm30_04.baselibs.Item

cdac.medinfo.sdk.dcm30_04.baselibs.ExposureSequenceItem

All Implemented Interfaces:

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

public class ExposureSequenceItem
extends Item

This item class contains methods used to validate, set and get the attributes in ExposureSequence

See Also:

Serialized Form

Method Summary

Methods

Modifier and Type	Method and Description
ApplicatorSequence	getApplicatorSequence() Retrieves pre-initialized object of ApplicatorSequence.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	getBeamLimitingDeviceAngle() Retrieves Beam Limiting Device Angle.
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.
BlockSequence	getBlockSequence() Retrieves pre-initialized object of BlockSequence.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[]	getDiaphragmPosition() Retrieves positions of diaphragm jaw pairs (in mm) in IEC BEAM LIMITING DEVICE coordinate axis in the IEC order X1, X2, Y1, Y2.
java.lang.String	getExposureTime() Return the String value of the attribute Exposure Time.
java.lang.String	getExposureTimeinms() Retrieves Exposure Time in ms.
java.lang.String	getGantryAngle() Retrieves Gantry Angle.
float	getGantryPitchAngle() Retrieves Gantry Pitch Angle.
GeneralAccessorySequence	getGeneralAccessorySequence() Retrieves pre-initialized object of GeneralAccessorySequence.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	getKVP() Peak kilo voltage output of the x-ray generator used.
java.lang.String	getMetersetExposure() Return treatment machine Meterset duration over which image has been acquired, specified in Monitor units (MU) or minutes as defined by Primary Dosimeter Unit (300A,00B3).
java.lang.String	getNumberofBlocks() Retrieves Number of Blocks.
java.lang.String	getPatientSupportAngle() Retrieves Patient Support Angle.
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	getReferencedFrameNumber() Retrieves Referenced Frame Number.
java.lang.String	getTableTopLateralPosition() Retrieves Table Top Lateral Position.
java.lang.String	getTableTopLongitudinalPosition() Retrieves Table Top Longitudinal Position.
java.lang.String	getTableTopPitchAngle() Retrieves Table Top Pitch Angle.
java.lang.String	getTableTopRollAngle() Retrieves Table Top Roll Angle.
java.lang.String	getTableTopVerticalPosition() Retrieves Table Top Vertical Position.
java.lang.String	getXRayTubeCurrent() Retrieves X-Ray Tube Current in mA.
java.lang.String	getXRayTubeCurrentinmA() Retrieves X-Ray Tube Current in mA.
void	setBeamLimitingDeviceAngle(java.lang.String strBeamLimitingDeviceAngle) Sets Beam Limiting Device Angle.
void	setDiaphragmPosition(java.lang.String[] arrStrDiaphragmPosition) Sets positions of diaphragm jaw pairs (in mm) in IEC BEAM LIMITING DEVICE coordinate axis in the IEC order X1, X2, Y1, Y2.
void	setExposureTime(java.lang.String strExposureTime) Sets time of x-ray exposure in msec.
void	setExposureTimeinms(java.lang.String strExposureTimeinms) Sets Exposure Time in ms.
void	setGantryAngle(java.lang.String strGantryAngle) Sets Gantry Angle.
void	setGantryPitchAngle(float fGantryPitchAngle) Sets Gantry Pitch Angle.
void	setKVP(java.lang.String strKVP) Sets Peak kilo voltage output of the x-ray generator used.
void	setMetersetExposure(java.lang.String strMetersetExposure) Sets treatment machine Meterset duration over which image has been acquired, specified in Monitor units (MU) or minutes as defined by Primary Dosimeter Unit (300A,00B3).
void	setNumberofBlocks(java.lang.String strNumberofBlocks) Sets Number of Blocks.
void	setPatientSupportAngle(java.lang.String strPatientSupportAngle) Sets Patient Support Angle.
void	setReferencedFrameNumber(java.lang.String strReferencedFrameNumber) Sets Referenced Frame Number.
void	setTableTopLateralPosition(java.lang.String strTableTopLateralPosition) Sets Table Top Lateral Position.
void	setTableTopLongitudinalPosition(java.lang.String strTableTopVerticalPosition) Sets Table Top Longitudinal Position.
void	setTableTopPitchAngle(java.lang.String strTableTopPitchAngle) Sets Table Top Pitch Angle.
void	setTableTopRollAngle(java.lang.String strTableTopRollAngle) Sets Table Top Roll Angle.
void	setTableTopVerticalPosition(java.lang.String strTableTopVerticalPosition) Sets Table Top Vertical Position.
void	setXRayTubeCurrent(java.lang.String strXRayTubeCurrent) Sets X-Ray Tube Current in MilliA.
void	setXRayTubeCurrentinmA(java.lang.String strXRayTubeCurrentinmA) Sets X-Ray Tube Current in MilliA.
boolean	validateForModule() Validates all the attributes in ExposureSequenceItem 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 ExposureSequenceItem 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.

setReferencedFrameNumber

public void setReferencedFrameNumber(java.lang.String strReferencedFrameNumber)

Sets Referenced Frame Number.

Parameters:

strReferencedFrameNumber - Specifies String value of Referenced Frame Number.

getReferencedFrameNumber

public java.lang.String getReferencedFrameNumber()

Retrieves Referenced Frame Number.

Returns:

String - value of Referenced Frame Number.

setKVP

public void setKVP(java.lang.String strKVP)

Sets Peak kilo voltage output of the x-ray generator used.

Parameters:

strKVP - String value of Rescale Scope.

getKVP

public java.lang.String getKVP()

Peak kilo voltage output of the x-ray generator used.

Returns:

strRescaleScope - String value of Rescale Scope.

getPrimaryFluenceModeSequence

public 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.

Returns:

PrimaryFluenceModeSequence - instance of PrimaryFluenceModeSequence.

setXRayTubeCurrent

public void setXRayTubeCurrent(java.lang.String strXRayTubeCurrent)

Sets X-Ray Tube Current in MilliA.

Parameters:

strXRayTubeCurrent - String value of X-Ray Tube Current in MilliA

getXRayTubeCurrent

public java.lang.String getXRayTubeCurrent()

Retrieves X-Ray Tube Current in mA.

Returns:

String - value of X-Ray Tube Current

setXRayTubeCurrentinmA

public void setXRayTubeCurrentinmA(java.lang.String strXRayTubeCurrentinmA)

Sets X-Ray Tube Current in MilliA.

Parameters:

strXRayTubeCurrentinmA - String value of X-Ray Tube Current in MilliA

getXRayTubeCurrentinmA

public java.lang.String getXRayTubeCurrentinmA()

Retrieves X-Ray Tube Current in mA.

Returns:

String - value of X-Ray Tube Current in mA

setExposureTime

public void setExposureTime(java.lang.String strExposureTime)

Sets time of x-ray exposure in msec.

Parameters:

strExposureTime - String value of Time of x-ray exposure in msec

getExposureTime

public java.lang.String getExposureTime()

Return the String value of the attribute Exposure Time.

Returns:

String - return the Tiem of Exposure

setExposureTimeinms

public void setExposureTimeinms(java.lang.String strExposureTimeinms)

Sets Exposure Time in ms.

Parameters:

strExposureTimeinms - String value of Exposure Time in ms

getExposureTimeinms

public java.lang.String getExposureTimeinms()

Retrieves Exposure Time in ms.

Returns:

String - value of Exposure Time in ms

setMetersetExposure

public void setMetersetExposure(java.lang.String strMetersetExposure)

Sets treatment machine Meterset duration over which image has been acquired, specified in Monitor units (MU) or minutes as defined by Primary Dosimeter Unit (300A,00B3). Required if Value 3 of Image Type (0008,0008) is PORTAL and Exposure Sequence (3002,0030) is sent.

Parameters:

strMetersetExposure - String value of Meterset Exposure.

getMetersetExposure

public java.lang.String getMetersetExposure()

Return treatment machine Meterset duration over which image has been acquired, specified in Monitor units (MU) or minutes as defined by Primary Dosimeter Unit (300A,00B3).

Returns:

String - value of Meterset Exposure.

setDiaphragmPosition

public void setDiaphragmPosition(java.lang.String[] arrStrDiaphragmPosition)

Sets positions of diaphragm jaw pairs (in mm) in IEC BEAM LIMITING DEVICE coordinate axis in the IEC order X1, X2, Y1, Y2.

Parameters:

arrStrDiaphragmPosition - String value of Diaphragm Position.

getDiaphragmPosition

public java.lang.String[] getDiaphragmPosition()

Retrieves positions of diaphragm jaw pairs (in mm) in IEC BEAM LIMITING DEVICE coordinate axis in the IEC order X1, X2, Y1, Y2.

Returns:

arrStrOperatorNames - String value of Diaphragm Position.

getBeamLimitingDeviceSequence

public 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.

Returns:

BeamLimitingDeviceSequence - instance of BeamLimitingDeviceSequence.

setGantryAngle

public void setGantryAngle(java.lang.String strGantryAngle)

Sets Gantry Angle.

Parameters:

strGantryAngle - String value of Gantry Angle.

getGantryAngle

public java.lang.String getGantryAngle()

Retrieves Gantry Angle.

Returns:

String - value of Gantry Angle.

setGantryPitchAngle

public void setGantryPitchAngle(float fGantryPitchAngle)

Sets Gantry Pitch Angle.

Parameters:

fGantryPitchAngle - float value of Gantry Pitch Angle.

getGantryPitchAngle

public float getGantryPitchAngle()

Retrieves Gantry Pitch Angle.

Returns:

float - value of Gantry Pitch Angle.

setBeamLimitingDeviceAngle

public void setBeamLimitingDeviceAngle(java.lang.String strBeamLimitingDeviceAngle)

Sets Beam Limiting Device Angle.

Parameters:

strBeamLimitingDeviceAngle - String value of Beam Limiting Device Angle.

getBeamLimitingDeviceAngle

public java.lang.String getBeamLimitingDeviceAngle()

Retrieves Beam Limiting Device Angle.

Returns:

String - value of Beam Limiting Device Angle.

setPatientSupportAngle

public void setPatientSupportAngle(java.lang.String strPatientSupportAngle)

Sets Patient Support Angle.

Parameters:

strPatientSupportAngle - String value of Patient Support Angle.

getPatientSupportAngle

public java.lang.String getPatientSupportAngle()

Retrieves Patient Support Angle.

Returns:

String - value of Patient Support Angle.

setTableTopPitchAngle

public void setTableTopPitchAngle(java.lang.String strTableTopPitchAngle)

Sets Table Top Pitch Angle.

Parameters:

strTableTopPitchAngle - String value of Table Top Pitch Angle.

getTableTopPitchAngle

public java.lang.String getTableTopPitchAngle()

Retrieves Table Top Pitch Angle.

Returns:

String - value of Table Top Pitch Angle.

setTableTopRollAngle

public void setTableTopRollAngle(java.lang.String strTableTopRollAngle)

Sets Table Top Roll Angle.

Parameters:

strTableTopRollAngle - String value of Table Top Roll Angle.

getTableTopRollAngle

public java.lang.String getTableTopRollAngle()

Retrieves Table Top Roll Angle.

Returns:

String - value of Table Top Roll Angle.

setTableTopVerticalPosition

public void setTableTopVerticalPosition(java.lang.String strTableTopVerticalPosition)

Sets Table Top Vertical Position.

Parameters:

strTableTopVerticalPosition - String value of Table Top Vertical Position.

getTableTopVerticalPosition

public java.lang.String getTableTopVerticalPosition()

Retrieves Table Top Vertical Position.

Returns:

String - value of Table Top Vertical Position.

setTableTopLongitudinalPosition

public void setTableTopLongitudinalPosition(java.lang.String strTableTopVerticalPosition)

Sets Table Top Longitudinal Position.

Parameters:

strTableTopLongitudinalPosition - String value of Table Top Longitudinal Position.

getTableTopLongitudinalPosition

public java.lang.String getTableTopLongitudinalPosition()

Retrieves Table Top Longitudinal Position.

Returns:

String - value of Table Top Longitudinal Position.

setTableTopLateralPosition

public void setTableTopLateralPosition(java.lang.String strTableTopLateralPosition)

Sets Table Top Lateral Position.

Parameters:

strTableTopLateralPosition - String value of Table Top Lateral Position.

getTableTopLateralPosition

public java.lang.String getTableTopLateralPosition()

Retrieves Table Top Lateral Position.

Returns:

String - value of Table Top Lateral Position.

getApplicatorSequence

public ApplicatorSequence getApplicatorSequence()

Retrieves pre-initialized object of ApplicatorSequence.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 GeneralAccessorySequence.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:

GeneralAccessorySequence - instance of General Accessory Sequence.

setNumberofBlocks

public void setNumberofBlocks(java.lang.String strNumberofBlocks)

Sets Number of Blocks.

Parameters:

strNumberofBlocks - String value of Number of Blocks.

getNumberofBlocks

public java.lang.String getNumberofBlocks()

Retrieves Number of Blocks.

Returns:

String - value of Number of Blocks.

getBlockSequence

public BlockSequence getBlockSequence()

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

BlockSequence - instance of Block Sequence.