cdac.medinfo.sdk.dcm30_04.baselibs

Class BrachyControlPointDeliveredSequenceItem

java.lang.Object

cdac.medinfo.sdk.dcm30_04.baselibs.Item

cdac.medinfo.sdk.dcm30_04.baselibs.BrachyControlPointDeliveredSequenceItem

All Implemented Interfaces:

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

public class BrachyControlPointDeliveredSequenceItem
extends Item

This item class contains the methods to set, get and validate the attribute present in Brachy Control Point Delivered Sequence Item.

See Also:

Serialized Form

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getControlPointRelativePosition() Retrieves Control Point Relative Position.
OverrideSequence	getOverrideSequence() Retrieves pre-initialized object of Override Sequence.
java.lang.String	getReferencedControlPointIndex() Retrieves Index of current Control Point, starting at 0 for first Control Point.
java.lang.String	getTreatmentControlPointDate() Retrieves Date when current Control Point occurred.
java.lang.String	getTreatmentControlPointTime() Retrieves Time when current Control Point occurred.
void	setControlPointRelativePosition(java.lang.String strControlPointRelativePosition) Sets Distance between current Control Point Position and the distal-most possible Source position in current Channel (mm).
void	setReferencedControlPointIndex(java.lang.String strReferencedControlPointIndex) Sets Index of current Control Point, starting at 0 for first Control Point.
void	setTreatmentControlPointDate(java.lang.String strTreatmentControlPointDate) Sets Date when current Control Point occurred.
void	setTreatmentControlPointTime(java.lang.String strTreatmentControlPointTime) Sets Time when current Control Point occurred.
boolean	validateForModule() Validates all the attributes in Brachy Control Point Delivered Sequence Item 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

setReferencedControlPointIndex

public void setReferencedControlPointIndex(java.lang.String strReferencedControlPointIndex)

Sets Index of current Control Point, starting at 0 for first Control Point.

Parameters:

strReferencedControlPointIndex- - String value of Referenced Control Point Index.

getReferencedControlPointIndex

public java.lang.String getReferencedControlPointIndex()

Retrieves Index of current Control Point, starting at 0 for first Control Point.

Returns:

String - value of Referenced Control Point Index.

setTreatmentControlPointDate

public void setTreatmentControlPointDate(java.lang.String strTreatmentControlPointDate)

Sets Date when current Control Point occurred.

Parameters:

strTreatmentControlPointDate - -String value of Treatment Control Point Date.

getTreatmentControlPointDate

public java.lang.String getTreatmentControlPointDate()

Retrieves Date when current Control Point occurred.

Returns:

String - value of Treatment Control Point Date.

setTreatmentControlPointTime

public void setTreatmentControlPointTime(java.lang.String strTreatmentControlPointTime)

Sets Time when current Control Point occurred.

Parameters:

strTreatmentControlPointTime - -String value of Treatment Control Point Time.

getTreatmentControlPointTime

public java.lang.String getTreatmentControlPointTime()

Retrieves Time when current Control Point occurred.

Returns:

String - value of Treatment Control Point Time.

setControlPointRelativePosition

public void setControlPointRelativePosition(java.lang.String strControlPointRelativePosition)

Sets Distance between current Control Point Position and the distal-most possible Source position in current Channel (mm).

Parameters:

strControlPointRelativePosition - -String value of Control Point Relative Position.

getControlPointRelativePosition

public java.lang.String getControlPointRelativePosition()

Retrieves Control Point Relative Position.

Returns:

String - value of Control Point Relative Position.

getOverrideSequence

public OverrideSequence getOverrideSequence()

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

OverrideSequence - instance of Override Sequence.

validateForModule

public boolean validateForModule()
                          throws InvalidItemException

Validates all the attributes in Brachy Control Point Delivered Sequence Item 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.