cdac.medinfo.sdk.dcm30_04.baselibs

Class IonBlockSequenceItem

java.lang.Object

cdac.medinfo.sdk.dcm30_04.baselibs.Item

cdac.medinfo.sdk.dcm30_04.baselibs.IonBlockSequenceItem

All Implemented Interfaces:

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

public class IonBlockSequenceItem
extends Item

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

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 type of Block Divergence.
java.lang.String	getBlockMountingPosition() Retrieves type of Block Mounting Position.
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 BlockNumberOfPoints.
BlockSlabSequence	getBlockSlabSequence() Retrieves pre-initialized object of BlockSlabSequence.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	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.
float	getIsocentertoBlockTrayDistance() Retrieves the IsocentertoBlockTrayDistance.
java.lang.String	getMaterialID() Retrieves user-defined name for block.
java.lang.String	getReferencedReferenceImageNumber() Retrieves NumberofBlockSlabItems.
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(EnumBlockDivergence enumBlockDivergence) Sets type of Block Divergence.
void	setBlockMountingPosition(EnumBlockMountingPosition enumBlockMountingPosition) Sets type of Block Mounting Position.
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 BlockNumberOfPoints .
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(EnumBlockType enumBlockType) Sets type of block.
void	setIsocentertoBlockTrayDistance(float fIsocentertoBlockTrayDistance) Sets the Iso center to Block Tray Distance.
void	setMaterialID(java.lang.String strMaterialID) Sets user-supplied identifier for material used to manufacture Block.
void	setNumberofBlockSlabItems(java.lang.String strNumberofBlockSlabItems) Sets Number of Block Slab Items.
boolean	validateForModule() Validates all the attributes in IonBlockSequenceItem 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 IonBlockSequenceItem 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.

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.

setIsocentertoBlockTrayDistance

public void setIsocentertoBlockTrayDistance(float fIsocentertoBlockTrayDistance)

Sets the Iso center to Block Tray Distance.

Parameters:

fIsocentertoBlockTrayDistance - Float value of the Isocenter to Block Tray Distance

getIsocentertoBlockTrayDistance

public float getIsocentertoBlockTrayDistance()

Retrieves the IsocentertoBlockTrayDistance.

Returns:

float - Float value of the IsocentertoBlockTrayDistance

setBlockType

public void setBlockType(EnumBlockType enumBlockType)

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:

enumBlockType - 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(EnumBlockDivergence enumBlockDivergence)

Sets type of Block Divergence. Enumerated Values: 1) PRESENT block edges are shaped for beam divergence. 2) ABSENT block edges are not shaped for beam divergence.

Parameters:

enumBlockDivergence - String value of Source to Block Type.

getBlockDivergence

public java.lang.String getBlockDivergence()

Retrieves type of Block Divergence.

Returns:

String value of Source to Block Divergence.

setBlockMountingPosition

public void setBlockMountingPosition(EnumBlockMountingPosition enumBlockMountingPosition)

Sets type of Block Mounting Position. Enumerated Values: 1) PATIENT_SIDE the block is mounted on the side of the Block Tray that is towards the patient. 2) SOURCE_SIDE the block is mounted on the side of the Block Tray that is towards the radiation source

Parameters:

enumBlockMountingPosition - String value of Source to Block Type.

getBlockMountingPosition

public java.lang.String getBlockMountingPosition()

Retrieves type of Block Mounting Position.

Returns:

String value of Source to 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 BlockNumberOfPoints . Number of (x,y) pairs defining the block edge.

Parameters:

strBlockNumberOfPoints - String value of Block Number of Points.

getBlockNumberOfPoints

public java.lang.String getBlockNumberOfPoints()

Retrieves BlockNumberOfPoints.

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.

setNumberofBlockSlabItems

public void setNumberofBlockSlabItems(java.lang.String strNumberofBlockSlabItems)

Sets Number of Block Slab Items.

Parameters:

strNumberofBlockSlabItems - String value of NumberofBlockSlabItems.

getReferencedReferenceImageNumber

public java.lang.String getReferencedReferenceImageNumber()

Retrieves NumberofBlockSlabItems.

Returns:

String - value of Number of Block Slab Items.

getBlockSlabSequence

public BlockSlabSequence getBlockSlabSequence()

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

BlockSlabSequence - instance of BlockSlabSequence.