cdac.medinfo.sdk.dcm30_04.baselibs

Class RecordedCompensatorSequenceItem

java.lang.Object

cdac.medinfo.sdk.dcm30_04.baselibs.Item

cdac.medinfo.sdk.dcm30_04.baselibs.RecordedCompensatorSequenceItem

All Implemented Interfaces:

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

public class RecordedCompensatorSequenceItem
extends Item

Introduces sequence of treatment compensators associated with current Beam. The sequence may contain one or more items.

See Also:

Serialized Form

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getAccessoryCode() Retrieves Accessory Code.
java.lang.String	getCompensatorID() Retrieves Compensator ID.
java.lang.String	getCompensatorTrayID() Retrieves User-supplied identifier for compensator tray.
java.lang.String	getCompensatorType() Retrieves Type of compensator
java.lang.String	getReferencedCompensatorNumber() Retrieves Referenced Compensator Number.
void	setAccessoryCode(java.lang.String strAccessoryCode) Sets Accessory Code .Uniquely identifies Accessory Code(300A,00F9) in RecordedCompensatorSequence (3008,00C0) in RT Prescription Module of referenced RT Plan.
void	setCompensatorID(java.lang.String strCompensatorID) Sets Compensator ID .Uniquely identifies Compensator ID(300A,00E5) in RecordedCompensatorSequence (3008,00C0) in RT Prescription Module of referenced RT Plan.
void	setCompensatorTrayID(java.lang.String strCompensatorTrayID) Sets the CompensatorTrayID.
void	setCompensatorType(EnumCompensatorType enumCompensatorType) Sets the Value Type Defined in Terms of TEXT,NUMERIC,CODE,DATE,TIME,PNAME
void	setReferencedCompensatorNumber(java.lang.String strReferencedCompensatorNumber) Sets Referenced Compensator Number .Uniquely identifies Referenced Compensator Number(300C,00D0) in RecordedCompensatorSequence (3008,00C0) in RT Prescription Module of referenced RT Plan.
boolean	validateForModule() Validates all the attributes in RecordedCompensatorSequenceItem 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 RecordedCompensatorSequenceItem 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.

setReferencedCompensatorNumber

public void setReferencedCompensatorNumber(java.lang.String strReferencedCompensatorNumber)

Sets Referenced Compensator Number .Uniquely identifies Referenced Compensator Number(300C,00D0) in RecordedCompensatorSequence (3008,00C0) in RT Prescription Module of referenced RT Plan.

Parameters:

strReferencedCompensatorNumber - String value of Referenced Compensator Number.

getReferencedCompensatorNumber

public java.lang.String getReferencedCompensatorNumber()

Retrieves Referenced Compensator Number.

Returns:

String - value of Referenced Compensator Number.

setCompensatorID

public void setCompensatorID(java.lang.String strCompensatorID)

Sets Compensator ID .Uniquely identifies Compensator ID(300A,00E5) in RecordedCompensatorSequence (3008,00C0) in RT Prescription Module of referenced RT Plan.

Parameters:

strCompensatorID - String value of Compensator ID.

getCompensatorID

public java.lang.String getCompensatorID()

Retrieves Compensator ID.

Returns:

String - value of Compensator ID.

setAccessoryCode

public void setAccessoryCode(java.lang.String strAccessoryCode)

Sets Accessory Code .Uniquely identifies Accessory Code(300A,00F9) in RecordedCompensatorSequence (3008,00C0) in RT Prescription Module of referenced RT Plan.

Parameters:

strAccessoryCode - String value of Accessory Code.

getAccessoryCode

public java.lang.String getAccessoryCode()

Retrieves Accessory Code.

Returns:

String - value of Accessory Code.

setCompensatorType

public void setCompensatorType(EnumCompensatorType enumCompensatorType)

Sets the Value Type Defined in Terms of TEXT,NUMERIC,CODE,DATE,TIME,PNAME

Parameters:

enumCompensatorType - Specifies type of the value encoded in this Item

getCompensatorType

public java.lang.String getCompensatorType()

Retrieves Type of compensator

Returns:

String - Type of the value encoded in this Item

setCompensatorTrayID

public void setCompensatorTrayID(java.lang.String strCompensatorTrayID)

Sets the CompensatorTrayID.

Parameters:

strCompensatorTrayID -

getCompensatorTrayID

public java.lang.String getCompensatorTrayID()

Retrieves User-supplied identifier for compensator tray.

Returns:

String - value of Energy Window Name.