cdac.medinfo.sdk.dcm30_04.baselibs

Class IonRangeCompensatorSequenceItem

java.lang.Object

cdac.medinfo.sdk.dcm30_04.baselibs.Item

cdac.medinfo.sdk.dcm30_04.baselibs.IonRangeCompensatorSequenceItem

All Implemented Interfaces:

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

public class IonRangeCompensatorSequenceItem
extends Item

This item class contains the methods to set, get and validate the attribute present in Ion Range Compensator Sequence.

See Also:

Serialized Form

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getAccessoryCode() Return Accessory Code.
float	getCompensatorColumnOffset() Retrieves CompensatorColumnOffset.
java.lang.String	getCompensatorColumns() Retrieves CompensatorColumns.
java.lang.String	getCompensatorDescription() Retrieves Compensator Description.
java.lang.String	getCompensatorDivergence() Return type of Compensator Divergence.
java.lang.String	getCompensatorID() Retrieves CompensatorID.
float	getCompensatorMillingToolDiameter() Retrieves the CompensatorMillingToolDiameter.
java.lang.String	getCompensatorMountingPosition() Return type of CompensatorMountingPosition.
java.lang.String	getCompensatorNumber() Retrieves Compensator Number.
java.lang.String[]	getCompensatorPixelSpacing() Retrieves Compensator Pixel Spacing.
java.lang.String[]	getCompensatorPosition() Retrieves Compensator Position.
java.lang.String	getCompensatorRows() Retrieves CompensatorRows.
java.lang.String[]	getCompensatorThicknessData() Retrieves Compensator Thickness Data.
float[]	getIsocentertoCompensatorDistances() Retrieves Isocenter to Compensator Distances.
float	getIsocentertoCompensatorTrayDistance() Retrieves the IsocentertoCompensatorTrayDistance.
java.lang.String	getMaterialID() Retrieves Material ID.
float	getPresentationPixelMagnificationRatio() Retrieves the CompensatorRelativeStoppingPowerRatio.
void	setCompensatorColumnOffset(float fCompensatorColumnOffset) Sets the CompensatorColumnOffset.
void	setCompensatorColumns(java.lang.String strCompensatorColumns) Sets Compensator Columns in the range compensator.
void	setCompensatorDescription(java.lang.String strCompensatorDescription) Sets Compensator Description.
void	setCompensatorDivergence(EnumCompensatorDivergence enumCompensatorDivergence) Sets type of Compensator Divergence Defined Terms: 1) PRESENT.
void	setCompensatorID(java.lang.String strMaterialID) Sets the CompensatorID.
void	setCompensatorMillingToolDiameter(float fCompensatorMillingToolDiameter) Sets the Compensator Milling Tool Diameter.
void	setCompensatorMountingPosition(EnumCompensatorMountingPosition enumCompensatorMountingPosition) Sets Compensator Mounting Position.
void	setCompensatorNumber(java.lang.String strCompensatorNumber) Sets CompensatorNumber
void	setCompensatorPixelSpacing(java.lang.String[] strArrCompensatorPixelSpacing) Sets CompensatorPixelSpacing.
void	setCompensatorPosition(java.lang.String[] strArrCompensatorPosition) Sets CompensatorPosition.
void	setCompensatorRelativeStoppingPowerRatio(float fCompensatorRelativeStoppingPowerRatio) Sets the Compensator Relative Stopping Power Ratio.
void	setCompensatorRows(java.lang.String strCompensatorRows) Sets Compensator Rows in the range compensator.
void	setCompensatorThicknessData(java.lang.String[] strArrCompensatorPixelSpacing) Sets CompensatorThicknessData.
void	setIsocentertoCompensatorDistances(float[] arrFIsocentertoCompensatorDistances) Sets a Isocenter to Compensator Distances.
void	setIsocentertoCompensatorTrayDistance(float fIsocentertoCompensatorTrayDistance) Sets Isocenter to Compensator Tray Distance(in mm) for current range compensator.
void	setMaterialID(java.lang.String strMaterialID) Sets the MaterialID.
void	setRescaleType(java.lang.String strAccessoryCode) Sets AccessoryCode.
boolean	validateForModule() Validates all the attributes in IonRangeCompensatorSequenceItem 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 IonRangeCompensatorSequenceItem 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.

setCompensatorDescription

public void setCompensatorDescription(java.lang.String strCompensatorDescription)

Sets Compensator Description.

Parameters:

strCompensatorDescription - String value of Compensator Description.

getCompensatorDescription

public java.lang.String getCompensatorDescription()

Retrieves Compensator Description.

Returns:

String - value of Compensator Description.

setCompensatorNumber

public void setCompensatorNumber(java.lang.String strCompensatorNumber)

Sets CompensatorNumber

Parameters:

strCompensatorNumber - String value of Compensator Number.

getCompensatorNumber

public java.lang.String getCompensatorNumber()

Retrieves Compensator Number.

Returns:

String - value of Compensator Number.

setMaterialID

public void setMaterialID(java.lang.String strMaterialID)

Sets the MaterialID.

Parameters:

strMaterialID -

getMaterialID

public java.lang.String getMaterialID()

Retrieves Material ID.

Returns:

String - value of Material ID.

setCompensatorID

public void setCompensatorID(java.lang.String strMaterialID)

Sets the CompensatorID.

Parameters:

strCompensatorID. -

getCompensatorID

public java.lang.String getCompensatorID()

Retrieves CompensatorID.

Returns:

String - value of Compensator ID.

setRescaleType

public void setRescaleType(java.lang.String strAccessoryCode)

Sets AccessoryCode.

Parameters:

strAccessoryCode - String value of Accessory Code.

getAccessoryCode

public java.lang.String getAccessoryCode()

Return Accessory Code.

Returns:

String - value of AccessoryCode.

setIsocentertoCompensatorTrayDistance

public void setIsocentertoCompensatorTrayDistance(float fIsocentertoCompensatorTrayDistance)

Sets Isocenter to Compensator Tray Distance(in mm) for current range compensator. Required if Compensator Mounting Position (300A,02E1) is not DOUBLE_SIDED.

Parameters:

fIsocentertoCompensatorTrayDistance - Float value.

getIsocentertoCompensatorTrayDistance

public float getIsocentertoCompensatorTrayDistance()

Retrieves the IsocentertoCompensatorTrayDistance.

Returns:

float - Float value of the Isocenter to Compensator Tray Distance.

setCompensatorDivergence

public void setCompensatorDivergence(EnumCompensatorDivergence enumCompensatorDivergence)

Sets type of Compensator Divergence Defined Terms: 1) PRESENT. 2) ABSENT

Parameters:

enumCompensatorDivergence - enum value of Compensator Divergence.

getCompensatorDivergence

public java.lang.String getCompensatorDivergence()

Return type of Compensator Divergence.

Returns:

String - value of CompensatorDivergence.

setCompensatorMountingPosition

public void setCompensatorMountingPosition(EnumCompensatorMountingPosition enumCompensatorMountingPosition)

Sets Compensator Mounting Position. Indicates on which side of the Compensator Tray the compensator is mounted. Defined Terms: 1) PATIENT_SIDE. 2) SOURCE_SIDE. 3) DOUBLE_SIDEDT

Parameters:

enumCompensatorMountingPosition - enum value of Compensator Mounting Position.

getCompensatorMountingPosition

public java.lang.String getCompensatorMountingPosition()

Return type of CompensatorMountingPosition.

Returns:

String - value of Compensator Mounting Position.

setCompensatorRows

public void setCompensatorRows(java.lang.String strCompensatorRows)

Sets Compensator Rows in the range compensator. A row is defined to be in the X direction of the IEC Beam Limiting Device Coordinate system.

Parameters:

strCompensatorRows - String value of Compensator Rows.

getCompensatorRows

public java.lang.String getCompensatorRows()

Retrieves CompensatorRows.

Returns:

String - value ofCompensatorRows.

setCompensatorColumns

public void setCompensatorColumns(java.lang.String strCompensatorColumns)

Sets Compensator Columns in the range compensator. A column is defined to be in the Y direction of the IEC Beam Limiting Device Coordinate system.

Parameters:

strCompensatorColumns - String value of Compensator Columns.

getCompensatorColumns

public java.lang.String getCompensatorColumns()

Retrieves CompensatorColumns.

Returns:

String - value of CompensatorColumns.

setCompensatorPixelSpacing

public void setCompensatorPixelSpacing(java.lang.String[] strArrCompensatorPixelSpacing)

Sets CompensatorPixelSpacing.

Parameters:

strArrCompensatorPixelSpacing - String value of Compensator Pixel Spacing.

getCompensatorPixelSpacing

public java.lang.String[] getCompensatorPixelSpacing()

Retrieves Compensator Pixel Spacing.

Returns:

String - value of CompensatorPixelSpacing.

setCompensatorPosition

public void setCompensatorPosition(java.lang.String[] strArrCompensatorPosition)

Sets CompensatorPosition.

Parameters:

strArrCompensatorPosition - String value of CompensatorPosition.

getCompensatorPosition

public java.lang.String[] getCompensatorPosition()

Retrieves Compensator Position.

Returns:

String - value of CompensatorPosition.

setCompensatorColumnOffset

public void setCompensatorColumnOffset(float fCompensatorColumnOffset)

Sets the CompensatorColumnOffset.

Parameters:

fCompensatorColumnOffset - to Float value .

getCompensatorColumnOffset

public float getCompensatorColumnOffset()

Retrieves CompensatorColumnOffset.

Returns:

float - Float value of the Compensator Column Offset.

setCompensatorThicknessData

public void setCompensatorThicknessData(java.lang.String[] strArrCompensatorPixelSpacing)

Sets CompensatorThicknessData.

Parameters:

strArrCompensatorThicknessData - String value of Compensator ThicknessData.

getCompensatorThicknessData

public java.lang.String[] getCompensatorThicknessData()

Retrieves Compensator Thickness Data.

Returns:

String - value of CompensatorThicknessData.

setIsocentertoCompensatorDistances

public void setIsocentertoCompensatorDistances(float[] arrFIsocentertoCompensatorDistances)

Sets a Isocenter to Compensator Distances.

Parameters:

arrFIsocentertoCompensatorDistances - pair of floating point numbers

getIsocentertoCompensatorDistances

public float[] getIsocentertoCompensatorDistances()

Retrieves Isocenter to Compensator Distances.

Returns:

float[] - Float array of IsocentertoCompensatorDistancest.

setCompensatorRelativeStoppingPowerRatio

public void setCompensatorRelativeStoppingPowerRatio(float fCompensatorRelativeStoppingPowerRatio)

Sets the Compensator Relative Stopping Power Ratio.

Parameters:

fCompensatorRelativeStoppingPowerRatio - Float value of the Compensator Relative Stopping Power Ratio.

getPresentationPixelMagnificationRatio

public float getPresentationPixelMagnificationRatio()

Retrieves the CompensatorRelativeStoppingPowerRatio.

Returns:

float - Float value of the Compensator Relative Stopping Power Ratio

setCompensatorMillingToolDiameter

public void setCompensatorMillingToolDiameter(float fCompensatorMillingToolDiameter)

Sets the Compensator Milling Tool Diameter.

Parameters:

fCompensatorMillingToolDiameter - Float value of the Compensator Milling Tool Diameter

getCompensatorMillingToolDiameter

public float getCompensatorMillingToolDiameter()

Retrieves the CompensatorMillingToolDiameter.

Returns:

float - Float value of the CompensatorMillingToolDiameter.