cdac.medinfo.sdk.dcm30_04.baselibs

Class BlockSequenceItem

java.lang.Object

cdac.medinfo.sdk.dcm30_04.baselibs.Item

cdac.medinfo.sdk.dcm30_04.baselibs.BlockSequenceItem

All Implemented Interfaces:

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

public class BlockSequenceItem
extends Item

This item class contains methods to validate, set and get attributes of BlockSequenceItem.

See Also:

Serialized Form

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getAccessoryCode() Retrieves Accessory Code.
java.lang.String[]	getBlockData() Retrieves a data stream of (x,y) pairs which comprise the block edge.
java.lang.String	getBlockDivergence() Retrieves presence or otherwise of geometrical divergence.
java.lang.String	getBlockMountingPosition() Retrieves which side of the Block Tray the block is mounted.
java.lang.String	getBlockName() Retrieves user-defined name for block.
java.lang.String	getBlockNumber() Retrieves identification number of the Block.
java.lang.String	getBlockNumberOfPoints() Retrieves number of (x,y) pairs defining the block edge.
java.lang.String	getBlockThickness() Retrieves thickness of block (in mm) parallel to radiation beam axis.
java.lang.String	getBlockTrayID() Retrieves user-supplied identifier for block tray.
java.lang.String	getBlockType() Retrieves type of block.
java.lang.String	getMaterialID() Retrieves user-defined name for block.
java.lang.String	getSourceToBlockTrayDistance() Retrieves radiation Source to attachment edge of block tray assembly (mm).
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	setBlockData(java.lang.String[] arrStrBlockData) Sets a data stream of (x,y) pairs which comprise the block edge.
void	setBlockDivergence(java.lang.String strBlockDivergence) Sets presence or otherwise of geometrical divergence.
void	setBlockMountingPosition(java.lang.String strBlockMountingPosition) Sets which side of the Block Tray the block is mounted.
void	setBlockName(java.lang.String strBlockName) Sets user-defined name for block.
void	setBlockNumber(java.lang.String strBlockNumber) Sets identification number of the Block.
void	setBlockNumberOfPoints(java.lang.String strBlockNumberOfPoints) Sets number of (x,y) pairs defining the block edge.
void	setBlockThickness(java.lang.String strBlockThickness) Sets thickness of block (in mm) parallel to radiation beam axis.
void	setBlockTrayID(java.lang.String strBlockTrayID) Sets user-supplied identifier for block tray.
void	setBlockType(java.lang.String strBlockType) Sets type of block.
void	setMaterialID(java.lang.String strMaterialID) Sets user-supplied identifier for material used to manufacture Block.
void	setSourceToBlockTrayDistance(java.lang.String strSourceToBlockTrayDistance) Sets radiation Source to attachment edge of block tray assembly (mm).
boolean	validateForModule() Validates all the attributes in BlockSequenceItem 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 BlockSequenceItem 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.

setBlockTrayID

public void setBlockTrayID(java.lang.String strBlockTrayID)

Sets user-supplied identifier for block tray.

Parameters:

strBlockTrayID - -String value of Block Tray ID.

getBlockTrayID

public java.lang.String getBlockTrayID()

Retrieves user-supplied identifier for block tray.

Returns:

String - value of Block Tray ID.

setSourceToBlockTrayDistance

public void setSourceToBlockTrayDistance(java.lang.String strSourceToBlockTrayDistance)

Sets radiation Source to attachment edge of block tray assembly (mm). Required if Block Sequence (300A,00F4) is sent.

Parameters:

strSourceToBlockTrayDistance - -String value of Source to Block Tray Distance.

getSourceToBlockTrayDistance

public java.lang.String getSourceToBlockTrayDistance()

Retrieves radiation Source to attachment edge of block tray assembly (mm). Required if Block Sequence (300A,00F4) is sent.

Returns:

String - value of Source to Block Tray Distance.

setBlockType

public void setBlockType(java.lang.String strBlockType)

Sets type of block. Required if Block Sequence (300A,00F4) is sent. Enumerated Values: 1) SHIELDING = blocking material is inside contour. 2) APERTURE = blocking material is outside contour.

Parameters:

strBlockType - -String value of Source to Block Type.

getBlockType

public java.lang.String getBlockType()

Retrieves type of block.

Returns:

String value of Source to Block Type.

setBlockDivergence

public void setBlockDivergence(java.lang.String strBlockDivergence)

Sets presence or otherwise of geometrical divergence. Required if Block Sequence (300A,00F4) is sent. Enumerated Values: 1) PRESENT = block edges are shaped for beam divergence. 2) ABSENT = block edges are not shaped for beam divergence.

Parameters:

strBlockDivergence - -String value of Block Divergence.

getBlockDivergence

public java.lang.String getBlockDivergence()

Retrieves presence or otherwise of geometrical divergence.

Returns:

String value of Block Divergence.

setBlockMountingPosition

public void setBlockMountingPosition(java.lang.String strBlockMountingPosition)

Sets which side of the Block Tray the block is mounted. Enumerated Values: 1) PATIENT_SIDE = the block is mounted on the side of the Block Tray which is towards the patient. 2) SOURCE_SIDE = the block is mounted on the side of the Block Tray which is towards the radiation source.

Parameters:

strBlockMountingPosition - -String value of Block Mounting Position.

getBlockMountingPosition

public java.lang.String getBlockMountingPosition()

Retrieves which side of the Block Tray the block is mounted.

Returns:

String value of Block Mounting Position.

setBlockNumber

public void setBlockNumber(java.lang.String strBlockNumber)

Sets identification number of the Block. The value of Block Number (300A,00FC) shall be unique within the Beam in which it is created. Required if Block Sequence (300A,00F4) is sent.

Parameters:

strBlockNumber - -String value of Block Number.

getBlockNumber

public java.lang.String getBlockNumber()

Retrieves identification number of the Block.

Returns:

String - value of Block Number.

setBlockName

public void setBlockName(java.lang.String strBlockName)

Sets user-defined name for block.

Parameters:

strBlockName - -String value of Block Name.

getBlockName

public java.lang.String getBlockName()

Retrieves user-defined name for block.

Returns:

String - value of Block Name.

setMaterialID

public void setMaterialID(java.lang.String strMaterialID)

Sets user-supplied identifier for material used to manufacture Block. Required if Block Sequence (300A,00F4) is sent.

Parameters:

strMaterialID - -String value of Material ID.

getMaterialID

public java.lang.String getMaterialID()

Retrieves user-defined name for block.

Returns:

String - value of Material ID.

setBlockThickness

public void setBlockThickness(java.lang.String strBlockThickness)

Sets thickness of block (in mm) parallel to radiation beam axis.

Parameters:

strBlockThickness - -String value of Block Thickness.

getBlockThickness

public java.lang.String getBlockThickness()

Retrieves thickness of block (in mm) parallel to radiation beam axis.

Returns:

String - value of Block Thickness.

setBlockNumberOfPoints

public void setBlockNumberOfPoints(java.lang.String strBlockNumberOfPoints)

Sets number of (x,y) pairs defining the block edge. Required if Block Sequence (300A,00F4) is sent.

Parameters:

strBlockNumberOfPoints- - String value of Block Number of Points.

getBlockNumberOfPoints

public java.lang.String getBlockNumberOfPoints()

Retrieves number of (x,y) pairs defining the block edge.

Returns:

String - value of Block Number of Points.

setBlockData

public void setBlockData(java.lang.String[] arrStrBlockData)

Sets a data stream of (x,y) pairs which comprise the block edge. The number of pairs shall be equal to Block Number of Points (300A,0104), and the vertices shall be interpreted as a closed polygon. Coordinates are projected onto the machine isocentric plane in the IEC BEAM LIMITING DEVICE coordinate system (mm). Required if Block Sequence (300A,00F4) is sent.

Parameters:

arrStrBlockData - -String value of Block Data.

getBlockData

public java.lang.String[] getBlockData()

Retrieves a data stream of (x,y) pairs which comprise the block edge.

Returns:

arrStrOperatorNames - String value of Block Data.

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.