cdac.medinfo.sdk.dcm30_04.baselibs

Class CompensatorSequenceItem

java.lang.Object

cdac.medinfo.sdk.dcm30_04.baselibs.Item

cdac.medinfo.sdk.dcm30_04.baselibs.CompensatorSequenceItem

All Implemented Interfaces:

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

public class CompensatorSequenceItem
extends Item

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

See Also:

Serialized Form

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getAccessoryCode() Retrieves Accessory Code.
java.lang.String	getCompensatorColumns() Retrieves Number of Columns in the compensator.
java.lang.String	getCompensatorDescription() Retrieves Compensator Description.
java.lang.String	getCompensatorDivergence() Retrieves presence or absence of geometrical divergence of the compensator.
java.lang.String	getCompensatorID() Retrieves Compensator ID.
java.lang.String	getCompensatorMountingPosition() Retrieves the side of the Compensator Tray on which compensator is mounted.
java.lang.String	getCompensatorNumber() Retrieves Identification number of the Compensator.It should be unique within the beam in which it is created.
java.lang.String[]	getCompensatorPixelSpacing() Retrieves Physical distance (in mm) between the center of each pixel projected onto machine isocentric plane.
java.lang.String[]	getCompensatorPosition() Retrieves Compensator Position.
java.lang.String	getCompensatorRows() Retrieves Number of rows in the compensator.
java.lang.String[]	getCompensatorThicknessData() Retrieves Compensator Thickness Data.
java.lang.String[]	getCompensatorTransmissionData() Retrieves Compensator Transmission Data.
java.lang.String	getCompensatorTrayID() Retrieves CompensatorTrayID.
java.lang.String	getCompensatorType() Retrieves Type of compensator.
java.lang.String	getMaterialID() Retrieves user-supplied identifier for material used to manufacture Compensator.
java.lang.String[]	getSourcetoCompensatorDistance() Retrieves Source to Compensator Distance.
java.lang.String	getSourcetoCompensatorTrayDistance() Retrieves radiation source to compensator tray attachment edge distance (in mm) for current compensator.
void	setAccessoryCode(java.lang.String strAccessoryCode) Sets an identifier for the accessory intended to be read by a device such as a bar-code reader.
void	setCompensatorColumns(java.lang.String strCompensatorColumns) Sets Number of Columns in the compensator.
void	setCompensatorDescription(java.lang.String strCompensatorDescription) Sets CompensatorDescription.
void	setCompensatorDivergence(EnumCompensatorDivergence enumCompensatorDivergence) Sets presence or absence of geometrical divergence of the compensator.
void	setCompensatorID(java.lang.String strCompensatorID) Sets Compensator ID.
void	setCompensatorMountingPosition(EnumCompensatorMountingPosition enumCompensatorMountingPosition) Sets on which side of the Compensator Tray the compensator is mounted.
void	setCompensatorNumber(java.lang.String strCompensatorNumber) Identification number of the Compensator.It should be unique within the beam in which it is created.
void	setCompensatorPixelSpacing(java.lang.String[] arrCompensatorPixelSpacing) Sets Physical distance (in mm) between the center of each pixel projected onto machine isocentric plane.
void	setCompensatorPosition(java.lang.String[] arrCompensatorPosition) Sets The x and y coordinates of the upper left hand corner (first pixel transmitted) of the compensator, projected onto the machine isocentric plane in the IEC BEAM LIMITING DEVICE coordinate system (mm).
void	setCompensatorRows(java.lang.String strCompensatorRows) Sets Number of rows in the compensator.
void	setCompensatorThicknessData(java.lang.String[] arrCompensatorThicknessData) Sets Compensator Thickness Data.
void	setCompensatorTransmissionData(java.lang.String[] arrCompensatorTransmissionData) Sets Compensator Transmission Data.
void	setCompensatorTrayID(java.lang.String strCompensatorTrayID) Sets the CompensatorTrayID.
void	setCompensatorType(EnumCompensatorType enumCompensatorType) Sets Type of compensator Defined Terms: STANDARD = physical (static) compensator.
void	setMaterialID(java.lang.String strMaterialID) Sets user-supplied identifier for material used to manufacture Compensator.
void	setSourcetoCompensatorDistance(java.lang.String[] arrSourcetoCompensatorDistance) Sets Source to Compensator Distance.
void	setSourcetoCompensatorTrayDistance(java.lang.String strSourcetoCompensatorTrayDistance) Sets radiation source to compensator tray attachment edge distance (in mm) for current compensator.
boolean	validateForModule() Validates all the attributes in CompensatorSequenceItem 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

setCompensatorNumber

public void setCompensatorNumber(java.lang.String strCompensatorNumber)

Identification number of the Compensator.It should be unique within the beam in which it is created.

Parameters:

strCompensatorNumber - String value of Compensator Number.

getCompensatorNumber

public java.lang.String getCompensatorNumber()

Retrieves Identification number of the Compensator.It should be unique within the beam in which it is created.

Returns:

String - value of Compensator Number.

setCompensatorType

public void setCompensatorType(EnumCompensatorType enumCompensatorType)

Sets Type of compensator Defined Terms: STANDARD = physical (static) compensator. DYNAMIC = moving Beam Limiting Device (collimator) simulating physical compensator.

Parameters:

enumCompensatorType- - Enum value of Compensator Type.

getCompensatorType

public java.lang.String getCompensatorType()

Retrieves Type of compensator.

Returns:

String - value of Compensator Type.

setMaterialID

public void setMaterialID(java.lang.String strMaterialID)

Sets user-supplied identifier for material used to manufacture Compensator.

Parameters:

strMaterialID - String value of Material ID.

getMaterialID

public java.lang.String getMaterialID()

Retrieves user-supplied identifier for material used to manufacture Compensator.

Returns:

String - value of Material ID.

setCompensatorID

public void setCompensatorID(java.lang.String strCompensatorID)

Sets Compensator ID.

Parameters:

strCompensatorID - -String value of Compensator ID.

getCompensatorID

public java.lang.String getCompensatorID()

Retrieves Compensator ID.

Returns:

String - value of Compensator ID.

setAccessoryCode

public void setAccessoryCode(java.lang.String strAccessoryCode)

Sets an identifier for the accessory intended to be read by a device such as a bar-code reader.

Parameters:

strAccessoryCode - String value of Accessory Code.

getAccessoryCode

public java.lang.String getAccessoryCode()

Retrieves Accessory Code.

Returns:

String value of Accessory Code.

setSourcetoCompensatorTrayDistance

public void setSourcetoCompensatorTrayDistance(java.lang.String strSourcetoCompensatorTrayDistance)

Sets radiation source to compensator tray attachment edge distance (in mm) for current compensator.

Parameters:

strSourcetoCompensatorTrayDistance - String value of Source to Compensator Tray Distance.

getSourcetoCompensatorTrayDistance

public java.lang.String getSourcetoCompensatorTrayDistance()

Retrieves radiation source to compensator tray attachment edge distance (in mm) for current compensator.

Returns:

String value of Source to Compensator Tray Distance.

setCompensatorMountingPosition

public void setCompensatorMountingPosition(EnumCompensatorMountingPosition enumCompensatorMountingPosition)

Sets on which side of the Compensator Tray the compensator is mounted. Enumerated Values: PATIENT_SIDE = the compensator is mounted on the side of the Compensator Tray which is towards the patient, SOURCE_SIDE = the compensator is mounted on the side of the Compensator Tray which is towards the radiation source. DOUBLE_SIDED = the compensator has a shaped (i.e. non-flat) surface on both sides of the Compensator Tray.

Parameters:

enumCompensatorMountingPosition- - Enum value of Compensator Mounting Position.

getCompensatorMountingPosition

public java.lang.String getCompensatorMountingPosition()

Retrieves the side of the Compensator Tray on which compensator is mounted.

Returns:

String - value of Compensator Mounting Position.

setCompensatorDivergence

public void setCompensatorDivergence(EnumCompensatorDivergence enumCompensatorDivergence)

Sets presence or absence of geometrical divergence of the compensator. Enumerated Values: PRESENT = the compensator is shaped according to the beam geometrical divergence. ABSENT = the compensator is not shaped according to the beam geometrical divergence.

Parameters:

enumCompensatorDivergence - Enum value of Compensator Divergence.

getCompensatorDivergence

public java.lang.String getCompensatorDivergence()

Retrieves presence or absence of geometrical divergence of the compensator.

Returns:

String value of Compensator Divergence.

setCompensatorRows

public void setCompensatorRows(java.lang.String strCompensatorRows)

Sets Number of rows in the compensator.

Parameters:

strCompensatorRows - String value of Compensator Rows.

getCompensatorRows

public java.lang.String getCompensatorRows()

Retrieves Number of rows in the compensator.

Returns:

String - value of Compensator Rows.

setCompensatorColumns

public void setCompensatorColumns(java.lang.String strCompensatorColumns)

Sets Number of Columns in the compensator.

Parameters:

strCompensatorColumns - String value of Compensator Columns.

getCompensatorColumns

public java.lang.String getCompensatorColumns()

Retrieves Number of Columns in the compensator.

Returns:

String - value of Compensator Columns.

setCompensatorPixelSpacing

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

Sets Physical distance (in mm) between the center of each pixel projected onto machine isocentric plane. Specified by a numeric pair - adjacent row spacing (delimiter) adjacent column spacing.

Parameters:

arrCompensatorPixelSpacing - String array of Compensator Pixel Spacing.

getCompensatorPixelSpacing

public java.lang.String[] getCompensatorPixelSpacing()

Retrieves Physical distance (in mm) between the center of each pixel projected onto machine isocentric plane.

Returns:

String[] - String array of Compensator Pixel Spacing.

setCompensatorPosition

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

Sets The x and y coordinates of the upper left hand corner (first pixel transmitted) of the compensator, projected onto the machine isocentric plane in the IEC BEAM LIMITING DEVICE coordinate system (mm).

Parameters:

arrCompensatorPosition - String array of Compensator Position.

getCompensatorPosition

public java.lang.String[] getCompensatorPosition()

Retrieves Compensator Position.

Returns:

String[] - String array of Compensator Position.

setCompensatorTransmissionData

public void setCompensatorTransmissionData(java.lang.String[] arrCompensatorTransmissionData)

Sets Compensator Transmission Data.

Parameters:

arrCompensatorTransmissionData - String array of Compensator Transmission Data.

getCompensatorTransmissionData

public java.lang.String[] getCompensatorTransmissionData()

Retrieves Compensator Transmission Data.

Returns:

String[] - String array of Compensator Transmission Data.

setCompensatorThicknessData

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

Sets Compensator Thickness Data. A data stream of the pixel samples which comprise the compensator, expressed as thicknesses (in mm).

Parameters:

arrCompensatorThicknessData - String array of Compensator Thickness Data.

getCompensatorThicknessData

public java.lang.String[] getCompensatorThicknessData()

Retrieves Compensator Thickness Data. A data stream of the pixel samples which comprise the compensator, expressed as thicknesses (in mm).

Returns:

String[] - String array of Compensator Thickness Data.

setSourcetoCompensatorDistance

public void setSourcetoCompensatorDistance(java.lang.String[] arrSourcetoCompensatorDistance)

Sets Source to Compensator Distance. A data stream of the pixel samples which comprise the distance from the radiation source to the compensator surface closest to the radiation source (in mm). The order of pixel sent is left to right, top to bottom.

Parameters:

arrSourcetoCompensatorDistance - String array of Source to Compensator Distance.

getSourcetoCompensatorDistance

public java.lang.String[] getSourcetoCompensatorDistance()

Retrieves Source to Compensator Distance. A data stream of the pixel samples which comprise the distance from the radiation source to the compensator surface closest to the radiation source (in mm).

Returns:

String[] - String array of Source to Compensator Distancea.

validateForModule

public boolean validateForModule()
                          throws InvalidItemException

Validates all the attributes in CompensatorSequenceItem 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.

setCompensatorTrayID

public void setCompensatorTrayID(java.lang.String strCompensatorTrayID)

Sets the CompensatorTrayID.

Parameters:

strCompensatorTrayID -

getCompensatorTrayID

public java.lang.String getCompensatorTrayID()

Retrieves CompensatorTrayID.

Returns:

String - value of CompensatorTrayID.

setCompensatorDescription

public void setCompensatorDescription(java.lang.String strCompensatorDescription)

Sets CompensatorDescription.

Parameters:

strCompensatorDescription - String value of Compensator Description.

getCompensatorDescription

public java.lang.String getCompensatorDescription()

Retrieves Compensator Description.

Returns:

String - value of Compensator Description.