cdac.medinfo.sdk.dcm30_04.baselibs

Class BrachyControlPointSequenceItem

java.lang.Object

cdac.medinfo.sdk.dcm30_04.baselibs.Item

cdac.medinfo.sdk.dcm30_04.baselibs.BrachyControlPointSequenceItem

All Implemented Interfaces:

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

public class BrachyControlPointSequenceItem
extends Item

This item class contains methods to validate,set and get the attributes in BrachyControlPointSequence.

See Also:

Serialized Form

Method Summary

Methods

Modifier and Type	Method and Description
BrachyReferencedDoseReferenceSequence	getBrachyReferencedDoseReferenceSequence() Retrieves pre-initialized object of Brachy Referenced Dose Reference 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[]	getControlPoint3DPosition() Retrieves Control Point 3D Position.
java.lang.String	getControlPointIndex() Retrieves Control Point Index.
float	getControlPointOrientation() Retrieves Control Point Orientation.
java.lang.String	getControlPointRelativePosition() Retrieves Cumulative Time Weight.
java.lang.String	getCumulativeTimeWeight() Retrieves Cumulative Time Weight.
void	setControlPoint3DPosition(java.lang.String[] arrstrControlPoint3DPosition) Sets Control Point 3D Position.Uniquely identifies Control Point 3D Position(300A,02D4) in Brachy Control Point Sequence(300A,02D0) in RT BRACHY APPLICATION SETUPS MODULE of RT Plan IOD.
void	setControlPointIndex(java.lang.String strControlPointIndex) Sets Control Point Index.Uniquely identifies Control Point Index(300A,0112) in Brachy Control Point Sequence(300A,02D0) in RT BRACHY APPLICATION SETUPS MODULE of RT Plan IOD.
void	setControlPointOrientation(float fControlPointOrientation) Sets Control Point Orientation.Uniquely identifies Control Point Orientation(300A,0412) in Brachy Control Point Sequence(300A,02D0) in RT BRACHY APPLICATION SETUPS MODULE of RT Plan IOD.
void	setControlPointRelativePosition(java.lang.String strControlPointRelativePosition) Sets Control Point Relative Position.Uniquely identifies Control Point Relative Position(300A,02D2) in Brachy Control Point Sequence(300A,02D0) in RT BRACHY APPLICATION SETUPS MODULE of RT Plan IOD.
void	setCumulativeTimeWeight(java.lang.String strCumulativeTimeWeight) Sets Cumulative Time Weight.Uniquely identifies Cumulative Time Weight(300A,02D6) in Brachy Control Point Sequence(300A,02D0) in RT BRACHY APPLICATION SETUPS MODULE of RT Plan IOD.
boolean	validateForModule() Validates all the attributes in BrachyControlPointSequenceItem 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 BrachyControlPointSequenceItem 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 Conditional element fails.

setControlPointIndex

public void setControlPointIndex(java.lang.String strControlPointIndex)

Sets Control Point Index.Uniquely identifies Control Point Index(300A,0112) in Brachy Control Point Sequence(300A,02D0) in RT BRACHY APPLICATION SETUPS MODULE of RT Plan IOD.

Parameters:

strControlPointIndex - -String value of Control Point Index.

getControlPointIndex

public java.lang.String getControlPointIndex()

Retrieves Control Point Index.

Returns:

String - value of Control Point Index.

setCumulativeTimeWeight

public void setCumulativeTimeWeight(java.lang.String strCumulativeTimeWeight)

Sets Cumulative Time Weight.Uniquely identifies Cumulative Time Weight(300A,02D6) in Brachy Control Point Sequence(300A,02D0) in RT BRACHY APPLICATION SETUPS MODULE of RT Plan IOD.

Parameters:

strCumulativeTimeWeight - -String value of Cumulative Time Weight.

getCumulativeTimeWeight

public java.lang.String getCumulativeTimeWeight()

Retrieves Cumulative Time Weight.

Returns:

String - value of Cumulative Time Weight.

setControlPointRelativePosition

public void setControlPointRelativePosition(java.lang.String strControlPointRelativePosition)

Sets Control Point Relative Position.Uniquely identifies Control Point Relative Position(300A,02D2) in Brachy Control Point Sequence(300A,02D0) in RT BRACHY APPLICATION SETUPS MODULE of RT Plan IOD.

Parameters:

strControlPointRelativePosition - -String value of Control Point Relative Position.

getControlPointRelativePosition

public java.lang.String getControlPointRelativePosition()

Retrieves Cumulative Time Weight.

Returns:

String - value of Cumulative Time Weight.

setControlPoint3DPosition

public void setControlPoint3DPosition(java.lang.String[] arrstrControlPoint3DPosition)

Sets Control Point 3D Position.Uniquely identifies Control Point 3D Position(300A,02D4) in Brachy Control Point Sequence(300A,02D0) in RT BRACHY APPLICATION SETUPS MODULE of RT Plan IOD.

Parameters:

arrstrControlPoint3DPosition- - String value of Control Point 3D Position.

getControlPoint3DPosition

public java.lang.String[] getControlPoint3DPosition()

Retrieves Control Point 3D Position.

Returns:

String - value of Control Point 3D Position.

setControlPointOrientation

public void setControlPointOrientation(float fControlPointOrientation)

Sets Control Point Orientation.Uniquely identifies Control Point Orientation(300A,0412) in Brachy Control Point Sequence(300A,02D0) in RT BRACHY APPLICATION SETUPS MODULE of RT Plan IOD.

Parameters:

fControlPointOrientation - -float value of Control Point Orientation.

getControlPointOrientation

public float getControlPointOrientation()

Retrieves Control Point Orientation.

Returns:

float - value of Control Point Orientation.

getBrachyReferencedDoseReferenceSequence

public BrachyReferencedDoseReferenceSequence getBrachyReferencedDoseReferenceSequence()

Retrieves pre-initialized object of Brachy Referenced Dose Reference 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:

BrachyReferencedDoseReferenceSequence - instance of Brachy Referenced Dose Reference Sequence.