cdac.medinfo.sdk.dcm30_04.baselibs

Class IonControlPointDeliverySequenceItem

java.lang.Object

cdac.medinfo.sdk.dcm30_04.baselibs.Item

cdac.medinfo.sdk.dcm30_04.baselibs.IonControlPointDeliverySequenceItem

All Implemented Interfaces:

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

public class IonControlPointDeliverySequenceItem
extends Item

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

See Also:

Serialized Form

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getDeliveredMeterset() Retrieves Delivered Meterset.
IonWedgePositionSequence	getIonWedgePositionSequence() Retrieves pre-initialized object of IonWedgePositionSequence.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	getKVP() Retrieves KVP.
float	getMetersetRateDelivered() Retrieves the MetersetRateDelivered.
float	getMetersetRateSet() Retrieves the MetersetRateSet.
java.lang.String	getNominalBeamEnergy() Retrieves NominalBeamEnergy.
java.lang.String	getReferencedControlPointIndex() Retrieves ReferencedControlPointIndex
java.lang.String	getSliceThickness() Retrieves SpecifiedMeterset.
java.lang.String[]	getTimeOfLastCalibration() Retrieves Time of TreatmentControlPointTime.
java.lang.String	getTreatmentControlPointDate() Retrieves Treatment Control Point Date.
void	setDeliveredMeterset(java.lang.String strDeliveredMeterset) Sets DeliveredMeterset.
void	setKVP(java.lang.String strKVP) Sets KVP.
void	setMetersetRateDelivered(float fMetersetRateDelivered) Sets the MetersetRateDelivered.
void	setMetersetRateSet(float fMetersetRateSet) Sets the MetersetRateSet.
void	setNominalBeamEnergy(java.lang.String strNominalBeamEnergy) Sets NominalBeamEnergy.
void	setReferencedControlPointIndex(java.lang.String strReferencedControlPointIndex) Sets ReferencedControlPointIndex
void	setSpecifiedMeterset(java.lang.String strSpecifiedMeterset) Sets SpecifiedMeterset.
void	setTreatmentControlPointTime(java.lang.String[] strTreatmentControlPointTime) Sets Treatment Control Point Time.
void	TreatmentControlPointDate(java.lang.String strTreatmentControlPointDate) Sets the Treatment Control Point Date.
boolean	validateForModule() Validates all the attributes in IonBeamLimitingDeviceSequenceItem 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 IonBeamLimitingDeviceSequenceItem 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.

setReferencedControlPointIndex

public void setReferencedControlPointIndex(java.lang.String strReferencedControlPointIndex)

Sets ReferencedControlPointIndex

Parameters:

strReferencedControlPointIndex - String value of Referenced Control Point Index.

getReferencedControlPointIndex

public java.lang.String getReferencedControlPointIndex()

Retrieves ReferencedControlPointIndex

Returns:

String - value of Referenced Control Point Index.

TreatmentControlPointDate

public void TreatmentControlPointDate(java.lang.String strTreatmentControlPointDate)

Sets the Treatment Control Point Date.

Parameters:

strTreatmentControlPointDate - String value of Treatment Control Point Date.

getTreatmentControlPointDate

public java.lang.String getTreatmentControlPointDate()

Retrieves Treatment Control Point Date.

Returns:

String - value of TreatmentControlPointDate.

setTreatmentControlPointTime

public void setTreatmentControlPointTime(java.lang.String[] strTreatmentControlPointTime)

Sets Treatment Control Point Time. Time when the delivery of radiation at this control point began.

Parameters:

strTreatmentControlPointTime - String .

getTimeOfLastCalibration

public java.lang.String[] getTimeOfLastCalibration()

Retrieves Time of TreatmentControlPointTime.

Returns:

String - value of Treatment Control Point Time.

setSpecifiedMeterset

public void setSpecifiedMeterset(java.lang.String strSpecifiedMeterset)

Sets SpecifiedMeterset. Desired machine setting for current control point in units specified byPrimary Dosimeter Unit (300A,00B3).

Parameters:

strSpecifiedMeterset - String value of Slice Thickness.

getSliceThickness

public java.lang.String getSliceThickness()

Retrieves SpecifiedMeterset.

Returns:

String - value of Specified Meterset.

setDeliveredMeterset

public void setDeliveredMeterset(java.lang.String strDeliveredMeterset)

Sets DeliveredMeterset. Machine setting actually delivered at current control point in unitsspecified by Primary Dosimeter Unit (300A,00B3).

Parameters:

strDeliveredMeterset - String value of Delivered Meterset.

getDeliveredMeterset

public java.lang.String getDeliveredMeterset()

Retrieves Delivered Meterset.

Returns:

String - value of Delivered Meterset.

setMetersetRateSet

public void setMetersetRateSet(float fMetersetRateSet)

Sets the MetersetRateSet. The specified speed of delivery of the specified dose in units specifiedby Primary Dosimeter Unit (300A,00B3) per minute.

Parameters:

fMetersetRateSet - Float value of the MetersetRateSet.

getMetersetRateSet

public float getMetersetRateSet()

Retrieves the MetersetRateSet.

Returns:

float - Float value of the MetersetRateSet

setMetersetRateDelivered

public void setMetersetRateDelivered(float fMetersetRateDelivered)

Sets the MetersetRateDelivered.

Parameters:

fMetersetRateDelivered - Float value of the MetersetRateDelivered.

getMetersetRateDelivered

public float getMetersetRateDelivered()

Retrieves the MetersetRateDelivered.

Returns:

float - Float value of the MetersetRateDelivered

setNominalBeamEnergy

public void setNominalBeamEnergy(java.lang.String strNominalBeamEnergy)

Sets NominalBeamEnergy.

Parameters:

strNominalBeamEnergy - String value of NominalBeamEnergy.

getNominalBeamEnergy

public java.lang.String getNominalBeamEnergy()

Retrieves NominalBeamEnergy.

Returns:

String - value of Nominal Beam Energy.

setKVP

public void setKVP(java.lang.String strKVP)

Sets KVP. Peak kilo voltage output of the setup X-Ray generator used.

Parameters:

strKVP - String value of KVP.

getKVP

public java.lang.String getKVP()

Retrieves KVP.

Returns:

String - value of KVP.

getIonWedgePositionSequence

public IonWedgePositionSequence getIonWedgePositionSequence()

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

IonWedgePositionSequence - instance of IonWedgePositionSequence.