cdac.medinfo.sdk.dcm30_04.baselibs

Class BeamLimitingDeviceSequenceItem

java.lang.Object

cdac.medinfo.sdk.dcm30_04.baselibs.Item

cdac.medinfo.sdk.dcm30_04.baselibs.BeamLimitingDeviceSequenceItem

All Implemented Interfaces:

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

public class BeamLimitingDeviceSequenceItem
extends Item

This item class contains methods to validate, set and get attributes in Beam Limiting Device Sequence.

See Also:

Serialized Form

Method Summary

Methods

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.
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.
java.lang.String[]	getLeafOrJawPositions() Retrieves positions of beam limiting device (collimator) leaf or jaw (element) pairs (in mm) in IEC BEAM LIMITING DEVICE coordinate axis appropriate to RT Beam Limiting Device Type (300A,00B8).
java.lang.String[]	getLeafPositionBoundaries() 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	getNumberOfLeafOrJawPairs() Retrieves number of leaf (element) or jaw pairs (equal to 1 for standard beam limiting device jaws).
java.lang.String	getRTBeamLimitingDeviceType() Retrieves type of beam limiting device (collimator).
java.lang.String	getSourceToBeamLimitingDeviceDistance() Retrieves type of beam limiting device (collimator).
void	setLeafOrJawPositions(java.lang.String[] arrStrLeafOrJawPositions) Sets positions of beam limiting device (collimator) leaf or jaw (element) pairs (in mm) in IEC BEAM LIMITING DEVICE coordinate axis appropriate to RT Beam Limiting Device Type (300A,00B8).
void	setLeafPositionBoundaries(java.lang.String[] arrStrLeafPositionBoundaries) Sets positions of diaphragm jaw pairs (in mm) in IEC BEAM LIMITING DEVICE coordinate axis in the IEC order X1, X2, Y1, Y2.
void	setNumberOfLeafOrJawPairs(java.lang.String strNumberOfLeafOrJawPairs) Sets number of leaf (element) or jaw pairs (equal to 1 for standard beam limiting device jaws).
void	setRTBeamLimitingDeviceType(java.lang.String strRTBeamLimitingDeviceType) Sets type of beam limiting device (collimator).
void	setSourceToBeamLimitingDeviceDistance(java.lang.String strSourceToBeamLimitingDeviceDistance) Sets radiation source to beam limiting device (collimator) distance (mm).
boolean	validateForModule() Validates all the attributes in BeamLimitingDeviceSequenceItem 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 BeamLimitingDeviceSequenceItem 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.

setRTBeamLimitingDeviceType

public void setRTBeamLimitingDeviceType(java.lang.String strRTBeamLimitingDeviceType)

Sets type of beam limiting device (collimator). Required if Beam Limiting Device Sequence (300A,00B6) is sent. Enumerated Values: 1) X = symmetric jaw pair in IEC X direction. 2) Y = symmetric jaw pair in IEC Y direction. 3) ASYMX = asymmetric jaw pair in IEC X direction. 4) ASYMY = asymmetric pair in IEC Y direction. 5) MLCX = multileaf (multi-element) jaw pair in IEC X direction. 6) MLCY = multileaf (multi-element) jaw pair in IEC Y direction.

Parameters:

strRTBeamLimitingDeviceType - - Specifies String value of RT Beam Limiting Device Type.

getRTBeamLimitingDeviceType

public java.lang.String getRTBeamLimitingDeviceType()

Retrieves type of beam limiting device (collimator).

Returns:

String - value of RT Beam Limiting Device Type.

setSourceToBeamLimitingDeviceDistance

public void setSourceToBeamLimitingDeviceDistance(java.lang.String strSourceToBeamLimitingDeviceDistance)

Sets radiation source to beam limiting device (collimator) distance (mm).

Parameters:

strSourceToBeamLimitingDeviceDistance - -Specifies String value of Source to Beam Limiting Device Distance.

getSourceToBeamLimitingDeviceDistance

public java.lang.String getSourceToBeamLimitingDeviceDistance()

Retrieves type of beam limiting device (collimator).

Returns:

String - value of Source to Beam Limiting Device Distance.

setNumberOfLeafOrJawPairs

public void setNumberOfLeafOrJawPairs(java.lang.String strNumberOfLeafOrJawPairs)

Sets number of leaf (element) or jaw pairs (equal to 1 for standard beam limiting device jaws). Required if Beam Limiting Device Sequence (300A,00B6) is sent.

Parameters:

strNumberOfLeafOrJawPairs - -Specifies String value of Number of Leaf/Jaw Pairs.

getNumberOfLeafOrJawPairs

public java.lang.String getNumberOfLeafOrJawPairs()

Retrieves number of leaf (element) or jaw pairs (equal to 1 for standard beam limiting device jaws).

Returns:

String - Specifies String value of Specifies String value of Number of Leaf/Jaw Pairs.

setLeafPositionBoundaries

public void setLeafPositionBoundaries(java.lang.String[] arrStrLeafPositionBoundaries)

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

Parameters:

arrStrLeafPositionBoundaries - -String array of Leaf Position Boundaries.

getLeafPositionBoundaries

public java.lang.String[] getLeafPositionBoundaries()

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 Leaf Position Boundaries.

setLeafOrJawPositions

public void setLeafOrJawPositions(java.lang.String[] arrStrLeafOrJawPositions)

Sets positions of beam limiting device (collimator) leaf or jaw (element) pairs (in mm) in IEC BEAM LIMITING DEVICE coordinate axis appropriate to RT Beam Limiting Device Type (300A,00B8).

Parameters:

arrStrLeafOrJawPositions- - String value of Leaf/Jaw Positions.

getLeafOrJawPositions

public java.lang.String[] getLeafOrJawPositions()

Retrieves positions of beam limiting device (collimator) leaf or jaw (element) pairs (in mm) in IEC BEAM LIMITING DEVICE coordinate axis appropriate to RT Beam Limiting Device Type (300A,00B8).

Returns:

arrStrOperatorNames - String value of Leaf/Jaw Positions.

getApplicatorSequence

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

Returns:

ApplicatorSequence - instance of Applicator Sequence.

getBlockSequence

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

Returns:

BlockSequence - instance of Block Sequence.