cdac.medinfo.sdk.dcm30_04.baselibs

Class ReferencedBeamSequenceItem

java.lang.Object

cdac.medinfo.sdk.dcm30_04.baselibs.Item

cdac.medinfo.sdk.dcm30_04.baselibs.ReferencedBeamSequenceItem

All Implemented Interfaces:

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

public class ReferencedBeamSequenceItem
extends Item

This Item class provides methods to set,get and validate attributes in ReferencedBeamSequence

See Also:

Serialized Form

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getBeamDose() Retrieves dose (in Gy) at Beam Dose Specification Point (300A,0082) due to current Beam.
java.lang.String[]	getBeamDoseSpecificationPoint() Retrieves coordinates (x,y,z) of point at which Beam Dose is specified in the patient based coordinate system.
BeamDoseVerificationControlPointSequence	getBeamDoseVerificationControlPointSequence() Retrieves pre-initialized object of Beam Dose VerificationControl Point 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	getBeamMeterset() Retrieves machine setting to be delivered for current Beam, specified in Monitor Units (MU) or minutes as defined by Primary Dosimeter Unit (300A,00B3) (in RT Beams Module) for referenced Beam.
java.lang.String	getReferencedBeamNumber() Retrieves Referenced Beam Number.
void	setBeamDose(java.lang.String strBeamDose) Sets dose (in Gy) at Beam Dose Specification Point (300A,0082) due to current Beam.
void	setBeamDoseSpecificationPoint(java.lang.String[] arrStrBeamDoseSpecificationPoint) Sets coordinates (x,y,z) of point at which Beam Dose is specified in the patient based coordinate system.
void	setBeamMeterset(java.lang.String strBeamMeterset) Sets machine setting to be delivered for current Beam, specified in Monitor Units (MU) or minutes as defined by Primary Dosimeter Unit (300A,00B3) (in RT Beams Module) for referenced Beam.
void	setReferencedBeamNumber(java.lang.String strReferencedBeamNumber) Sets References Beam specified by Beam Number (300A,00C0) in Beam Sequence (300A,00B0) in RT Beams Module within referenced RT Plan.
boolean	validateForModule() Validates all the attributes in ReferencedBeamSequenceItem 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 ReferencedBeamSequenceItem 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.

setReferencedBeamNumber

public void setReferencedBeamNumber(java.lang.String strReferencedBeamNumber)

Sets References Beam specified by Beam Number (300A,00C0) in Beam Sequence (300A,00B0) in RT Beams Module within referenced RT Plan.

Parameters:

strReferencedBeamNumber - String value of Referenced Beam Number.

getReferencedBeamNumber

public java.lang.String getReferencedBeamNumber()

Retrieves Referenced Beam Number.

Returns:

String - value of Referenced Beam Number

setBeamDoseSpecificationPoint

public void setBeamDoseSpecificationPoint(java.lang.String[] arrStrBeamDoseSpecificationPoint)

Sets coordinates (x,y,z) of point at which Beam Dose is specified in the patient based coordinate system.

Parameters:

arrStrBeamDoseSpecificationPoint - String value of Beam Dose Specification Point.

getBeamDoseSpecificationPoint

public java.lang.String[] getBeamDoseSpecificationPoint()

Retrieves coordinates (x,y,z) of point at which Beam Dose is specified in the patient based coordinate system.

Returns:

String - value of Beam Dose Specification Point.

setBeamDose

public void setBeamDose(java.lang.String strBeamDose)

Sets dose (in Gy) at Beam Dose Specification Point (300A,0082) due to current Beam.

Parameters:

strBeamDose - String value of Beam Dose.

getBeamDose

public java.lang.String getBeamDose()

Retrieves dose (in Gy) at Beam Dose Specification Point (300A,0082) due to current Beam.

Returns:

String - value of Beam Dose.

setBeamMeterset

public void setBeamMeterset(java.lang.String strBeamMeterset)

Sets machine setting to be delivered for current Beam, specified in Monitor Units (MU) or minutes as defined by Primary Dosimeter Unit (300A,00B3) (in RT Beams Module) for referenced Beam.

Parameters:

strBeamMeterset - String value of Beam Meterset.

getBeamMeterset

public java.lang.String getBeamMeterset()

Retrieves machine setting to be delivered for current Beam, specified in Monitor Units (MU) or minutes as defined by Primary Dosimeter Unit (300A,00B3) (in RT Beams Module) for referenced Beam.

Returns:

String - value of Beam Meterset.

getBeamDoseVerificationControlPointSequence

public BeamDoseVerificationControlPointSequence getBeamDoseVerificationControlPointSequence()

Retrieves pre-initialized object of Beam Dose VerificationControl Point 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:

BeamDoseVerificationControlPointSequence - instance of Beam Dose VerificationControl Point Sequence.