cdac.medinfo.sdk.dcm30_04.baselibs

Class RangeModulatorSettingsSequenceItem

java.lang.Object

cdac.medinfo.sdk.dcm30_04.baselibs.Item

cdac.medinfo.sdk.dcm30_04.baselibs.RangeModulatorSettingsSequenceItem

All Implemented Interfaces:

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

public class RangeModulatorSettingsSequenceItem
extends Item

This item class contains methods to validate, set and get the attributes of Range Modulator Settings Sequence.

See Also:

Serialized Form

Method Summary

Methods

Modifier and Type	Method and Description
float	getIsocentertoRangeModulatorDistance() Retrieves the IsocentertoRangeModulatorDistance.
float	getRangeModulatorGatingStartValue() Retrieves the RangeModulatorGatingStartValue.
float	getRangeModulatorGatingStartWaterEquivalentThickness() Retrieves the RangeModulatorGatingStartWaterEquivalentThickness.
float	getRangeModulatorGatingStopValue() Retrieves the RangeModulatorGatingStopValue.
float	getRangeModulatorGatingStopWaterEquivalentThickness() Retrieves the IsocentertoRangeModulatorDistance.
java.lang.String	getReferencedRangeModulatorNumber() Retrieves ReferencedRangeModulatorNumber.
void	setIsocentertoRangeModulatorDistance(float fIsocentertoRangeModulatorDistance) Sets the IsocentertoRangeModulatorDistance.
void	setRangeModulatorGatingStartValue(float fRangeModulatorGatingStartValue) Sets the Range Modulator Gating Start Value.
void	setRangeModulatorGatingStartWaterEquivalentThickness(float fRangeModulatorGatingStartWaterEquivalentThickness) Sets the Range Modulator Gating Start Water Equivalent Thickness.
void	setRangeModulatorGatingStopValue(float fRangeModulatorGatingStoptValue) Sets the Range Modulator Gating Stop Value.
void	setRangeModulatorGatingStopWaterEquivalentThickness(float fRangeModulatorGatingStopWaterEquivalentThickness) Sets the Range Modulator Gating Stop Water Equivalent Thickness.
void	setReferencedRangeModulatorNumber(java.lang.String strReferencedRangeModulatorNumber) Sets ReferencedRangeModulatorNumber.
boolean	validateForModule() Validates all the attributes in RangeModulatorSettingsSequenceItem according the rules defined by the Range Modulator Settings Sequence Item.

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 RangeModulatorSettingsSequenceItem according the rules defined by the Range Modulator Settings Sequence Item.

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.

setReferencedRangeModulatorNumber

public void setReferencedRangeModulatorNumber(java.lang.String strReferencedRangeModulatorNumber)

Sets ReferencedRangeModulatorNumber.

Parameters:

strReferencedRangeModulatorNumber - String value of ReferencedRangeModulatorNumber.

getReferencedRangeModulatorNumber

public java.lang.String getReferencedRangeModulatorNumber()

Retrieves ReferencedRangeModulatorNumber.

Returns:

String - value of Referenced Range Modulator Number.

setRangeModulatorGatingStartValue

public void setRangeModulatorGatingStartValue(float fRangeModulatorGatingStartValue)

Sets the Range Modulator Gating Start Value.

Parameters:

fRangeModulatorGatingStartValue - Float value of the RangeModulatorGatingStartValue

getRangeModulatorGatingStartValue

public float getRangeModulatorGatingStartValue()

Retrieves the RangeModulatorGatingStartValue.

Returns:

float - Float value of the Range Modulator Gating Start Value.

setRangeModulatorGatingStopValue

public void setRangeModulatorGatingStopValue(float fRangeModulatorGatingStoptValue)

Sets the Range Modulator Gating Stop Value.

Parameters:

fRangeModulatorGatingStopValue - Float value of the RangeModulatorGatingStopValue

getRangeModulatorGatingStopValue

public float getRangeModulatorGatingStopValue()

Retrieves the RangeModulatorGatingStopValue.

Returns:

float - Float value of the Range Modulator Gating Stop Value.

setRangeModulatorGatingStartWaterEquivalentThickness

public void setRangeModulatorGatingStartWaterEquivalentThickness(float fRangeModulatorGatingStartWaterEquivalentThickness)

Sets the Range Modulator Gating Start Water Equivalent Thickness.

Parameters:

fRangeModulatorGatingStartWaterEquivalentThickness - Float value of the RangeModulatorGatingStartWaterEquivalentThickness

getRangeModulatorGatingStartWaterEquivalentThickness

public float getRangeModulatorGatingStartWaterEquivalentThickness()

Retrieves the RangeModulatorGatingStartWaterEquivalentThickness.

Returns:

float - Float value of the Range Modulator Gating Start Water Equivalent Thickness.

setRangeModulatorGatingStopWaterEquivalentThickness

public void setRangeModulatorGatingStopWaterEquivalentThickness(float fRangeModulatorGatingStopWaterEquivalentThickness)

Sets the Range Modulator Gating Stop Water Equivalent Thickness.

Parameters:

fRangeModulatorGatingStopWaterEquivalentThickness - Float value of the RangeModulatorGatingStopWaterEquivalentThickness

getRangeModulatorGatingStopWaterEquivalentThickness

public float getRangeModulatorGatingStopWaterEquivalentThickness()

Retrieves the IsocentertoRangeModulatorDistance.

Returns:

float - Float value of the Isocenter to Range Modulator Distance.

setIsocentertoRangeModulatorDistance

public void setIsocentertoRangeModulatorDistance(float fIsocentertoRangeModulatorDistance)

Sets the IsocentertoRangeModulatorDistance.

Parameters:

fIsocentertoRangeModulatorDistance - Float value of the IsocentertoRangeModulatorDistance

getIsocentertoRangeModulatorDistance

public float getIsocentertoRangeModulatorDistance()

Retrieves the IsocentertoRangeModulatorDistance.

Returns:

float - Float value of the Isocenter to Range Modulator Distance.