cdac.medinfo.sdk.dcm30_04.baselibs

Class TreatmentSessionApplicationSetupSequenceItem

java.lang.Object

cdac.medinfo.sdk.dcm30_04.baselibs.Item

cdac.medinfo.sdk.dcm30_04.baselibs.TreatmentSessionApplicationSetupSequenceItem

All Implemented Interfaces:

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

public class TreatmentSessionApplicationSetupSequenceItem
extends Item

This item class contains the methods to set, get and validate the attribute present in Treatment Session Application Setup Sequence Item.

See Also:

Serialized Form

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getApplicationSetupCheck() Retrieves Results of check-wire travel through all channels of current Application Setup.
java.lang.String	getApplicationSetupManufacturer() Retrieves Manufacturer of Application Setup.
java.lang.String	getApplicationSetupName() Retrieves User-defined name for Application Setup.
java.lang.String	getApplicationSetupType() Retrieves Type of Application Setup.
java.lang.String	getCurrentFractionNumber() Retrieves Fraction number for this application setup.
RecordedBrachyAccessoryDeviceSequence	getRecordedBrachyAccessoryDeviceSequence() Retrieves pre-initialized object of Recorded Brachy Accessory Device 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
RecordedChannelSequence	getRecordedChannelSequence() Retrieves pre-initialized object of Recorded Channel 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	getReferencedBrachyApplicationSetupNumber() Retrieves Referenced Brachy Application Setup Number.
ReferencedCalculatedDoseReferenceSequence	getReferencedCalculatedDoseReferenceSequence() Retrieves pre-initialized object of Referenced Calculated 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
ReferencedMeasuredDoseReferenceSequence	getReferencedMeasuredDoseReferenceSequence() Retrieves pre-initialized object of Referenced Measured 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
ReferencedVerificationImageSequence	getReferencedVerificationImageSequence() Retrieves pre-initialized object of Referenced Verification Image 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	getTemplateName() Retrieves User-defined Name for Template Device.
java.lang.String	getTemplateNumber() Retrieves Identification number of the Template.
java.lang.String	getTemplateType() Retrieves User-defined type for Template Device.
java.lang.String	getTotalReferenceAirKerma() Retrieves Total Reference Air Kerma for current Application Setup,
java.lang.String	getTreatmentDeliveryType() Retrieves Delivery Type of treatment.
java.lang.String	getTreatmentTerminationCode() Retrieves Treatment machine termination code.
java.lang.String	getTreatmentTerminationStatus() Retrieves Conditions under which treatment was terminated.
java.lang.String	getTreatmentVerificationStatus() Retrieves Conditions under which treatment was verified by a verification system.
void	setApplicationSetupCheck(EnumApplicationSetupCheck enumApplicationSetupCheck) Sets Results of check-wire travel through all channels of current Application Setup.
void	setApplicationSetupManufacturer(java.lang.String strApplicationSetupManufacturer) Sets Manufacturer of Application Setup.
void	setApplicationSetupName(java.lang.String strApplicationSetupName) Sets User-defined name for Application Setup.
void	setApplicationSetupType(EnumApplicationSetupType enumApplicationSetupType) Sets Type of Application Setup.
void	setCurrentFractionNumber(java.lang.String strCurrentFractionNumber) Sets Fraction number for this application setup.
void	setReferencedBrachyApplicationSetupNumber(java.lang.String strReferencedBrachyApplicationSetupNumber) Sets References application setup specified by Application Setup Number (300A,0234) in Application Setup Sequence (300A,0230) in RT Brachy Applications Module within referenced RT Plan.
void	setTemplateName(java.lang.String strTemplateName) Sets User-defined name for Template Device.
void	setTemplateNumber(java.lang.String strTemplateNumber) Sets Identification number of the Template.
void	setTemplateType(java.lang.String strTemplateType) Sets User-defined type for Template Device.
void	setTotalReferenceAirKerma(java.lang.String strTotalReferenceAirKerma) Sets Total Reference Air Kerma for current Application Setup, i.e.
void	setTreatmentDeliveryType(EnumTreatmentDeliveryType enumTreatmentDeliveryType) Sets Delivery Type of treatment.
void	setTreatmentTerminationCode(java.lang.String strTreatmentTerminationCode) Sets Treatment machine termination code.
void	setTreatmentTerminationStatus(EnumTreatmentTerminationStatus enumTreatmentTerminationStatus) Sets Conditions under which treatment was terminated.
void	setTreatmentVerificationStatus(EnumTreatmentVerificationStatus enumTreatmentVerificationStatus) Sets Conditions under which treatment was verified by a verification system.
boolean	validateForModule() Validates all the attributes in TreatmentSessionApplicationSetupSequenceItem 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

setApplicationSetupType

public void setApplicationSetupType(EnumApplicationSetupType enumApplicationSetupType)

Sets Type of Application Setup. Defined Terms: FLETCHER_SUIT, DELCLOS, BLOEDORN, JOSLIN_FLYNN, CHANDIGARH, MANCHESTER, HENSCHKE, NASOPHARYNGEAL, OESOPHAGEAL, ENDOBRONCHIAL,SYED_NEBLETT, ENDORECTAL,PERINEAL.

Parameters:

enumApplicationSetupType - Enum value of Application Setup Type.

getApplicationSetupType

public java.lang.String getApplicationSetupType()

Retrieves Type of Application Setup.

Returns:

String - value of Type of Application Setup.

setReferencedBrachyApplicationSetupNumber

public void setReferencedBrachyApplicationSetupNumber(java.lang.String strReferencedBrachyApplicationSetupNumber)

Sets References application setup specified by Application Setup Number (300A,0234) in Application Setup Sequence (300A,0230) in RT Brachy Applications Module within referenced RT Plan.

Parameters:

strReferencedBrachyApplicationSetupNumber - String value of Referenced Brachy Application Setup Number.

getReferencedBrachyApplicationSetupNumber

public java.lang.String getReferencedBrachyApplicationSetupNumber()

Retrieves Referenced Brachy Application Setup Number.

Returns:

String - value of Referenced Brachy Application Setup Number.

setApplicationSetupName

public void setApplicationSetupName(java.lang.String strApplicationSetupName)

Sets User-defined name for Application Setup.

Parameters:

strApplicationSetupName - String value of Application Setup Name.

getApplicationSetupName

public java.lang.String getApplicationSetupName()

Retrieves User-defined name for Application Setup.

Returns:

String - value of Application Setup Name.

setApplicationSetupManufacturer

public void setApplicationSetupManufacturer(java.lang.String strApplicationSetupManufacturer)

Sets Manufacturer of Application Setup.

Parameters:

strApplicationSetupManufacturer - String value of Manufacturer of Application Setup.

getApplicationSetupManufacturer

public java.lang.String getApplicationSetupManufacturer()

Retrieves Manufacturer of Application Setup.

Returns:

String - value of Manufacturer of Application Setup.

setTemplateNumber

public void setTemplateNumber(java.lang.String strTemplateNumber)

Sets Identification number of the Template.

Parameters:

strTemplateNumber - String value of Template Number.

getTemplateNumber

public java.lang.String getTemplateNumber()

Retrieves Identification number of the Template.

Returns:

String - value of Identification number of the Template.

setTemplateType

public void setTemplateType(java.lang.String strTemplateType)

Sets User-defined type for Template Device.

Parameters:

strTemplateType - String value of Template Type.

getTemplateType

public java.lang.String getTemplateType()

Retrieves User-defined type for Template Device.

Returns:

String - value of User-defined type for Template Device.

setTemplateName

public void setTemplateName(java.lang.String strTemplateName)

Sets User-defined name for Template Device.

Parameters:

strTemplateName - String value of Template Name.

getTemplateName

public java.lang.String getTemplateName()

Retrieves User-defined Name for Template Device.

Returns:

String - value of User-defined Name for Template Device.

setApplicationSetupCheck

public void setApplicationSetupCheck(EnumApplicationSetupCheck enumApplicationSetupCheck)

Sets Results of check-wire travel through all channels of current Application Setup.

Parameters:

enumApplicationSetupCheck - Enum value of Application Setup Check.

getApplicationSetupCheck

public java.lang.String getApplicationSetupCheck()

Retrieves Results of check-wire travel through all channels of current Application Setup.

Returns:

String - value of Application Setup Check.

getReferencedVerificationImageSequence

public ReferencedVerificationImageSequence getReferencedVerificationImageSequence()

Retrieves pre-initialized object of Referenced Verification Image 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:

ReferencedVerificationImageSequence - instance of Referenced Verification Image Sequence.

setTotalReferenceAirKerma

public void setTotalReferenceAirKerma(java.lang.String strTotalReferenceAirKerma)

Sets Total Reference Air Kerma for current Application Setup, i.e. the sum of the products of the Air Kerma Rates of each Source in each Channel with its respective Channel Time .

Parameters:

strTotalReferenceAirKerma - String value of Total Reference Air Kerma.

getTotalReferenceAirKerma

public java.lang.String getTotalReferenceAirKerma()

Retrieves Total Reference Air Kerma for current Application Setup,

Returns:

String - value of Total Reference Air Kerma for current Application Setup,

getReferencedMeasuredDoseReferenceSequence

public ReferencedMeasuredDoseReferenceSequence getReferencedMeasuredDoseReferenceSequence()

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

ReferencedMeasuredDoseReferenceSequence - instance of Referenced Measured Dose Reference Sequence.

getReferencedCalculatedDoseReferenceSequence

public ReferencedCalculatedDoseReferenceSequence getReferencedCalculatedDoseReferenceSequence()

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

ReferencedCalculatedDoseReferenceSequence - instance of Referenced Calculated Dose Reference Sequence.

setCurrentFractionNumber

public void setCurrentFractionNumber(java.lang.String strCurrentFractionNumber)

Sets Fraction number for this application setup.

Parameters:

strCurrentFractionNumber - String value of Current Fraction Number

getCurrentFractionNumber

public java.lang.String getCurrentFractionNumber()

Retrieves Fraction number for this application setup.

Returns:

String - value of Fraction number for this application setup.

setTreatmentDeliveryType

public void setTreatmentDeliveryType(EnumTreatmentDeliveryType enumTreatmentDeliveryType)

Sets Delivery Type of treatment. Defined Terms: TREATMENT = normal patient treatment, CONTINUATION = continuation of interrupted treatment

Parameters:

enumTreatmentDeliveryType - Enum value of Treatment Delivery Type.

getTreatmentDeliveryType

public java.lang.String getTreatmentDeliveryType()

Retrieves Delivery Type of treatment.

Returns:

String - value of Delivery Type of treatment.

setTreatmentTerminationStatus

public void setTreatmentTerminationStatus(EnumTreatmentTerminationStatus enumTreatmentTerminationStatus)

Sets Conditions under which treatment was terminated. Defined Terms: NORMAL = treatment terminated normally, OPERATOR = operator terminated treatment, MACHINE = machine terminated treatment for other than NORMAL condition, UNKNOWN = status at termination unknown

Parameters:

enumTreatmentTerminationStatus - Enum value of Treatment Termination Status.

getTreatmentTerminationStatus

public java.lang.String getTreatmentTerminationStatus()

Retrieves Conditions under which treatment was terminated.

Returns:

String - value of Treatment Termination Status.

setTreatmentTerminationCode

public void setTreatmentTerminationCode(java.lang.String strTreatmentTerminationCode)

Sets Treatment machine termination code. This code is dependent upon the particular application and equipment.

Parameters:

strTreatmentTerminationCode - String value of Treatment Termination code.

getTreatmentTerminationCode

public java.lang.String getTreatmentTerminationCode()

Retrieves Treatment machine termination code.

Returns:

String - value of Treatment machine termination code.

setTreatmentVerificationStatus

public void setTreatmentVerificationStatus(EnumTreatmentVerificationStatus enumTreatmentVerificationStatus)

Sets Conditions under which treatment was verified by a verification system. Enumerated Values: VERIFIED = treatment verified, VERIFIED_OVR = treatment verified with at least one out-of-range value overridden NOT_VERIFIED = treatment verified manually

Parameters:

enumTreatmentVerificationStatus - Enum value of Treatment Verification Status.

getTreatmentVerificationStatus

public java.lang.String getTreatmentVerificationStatus()

Retrieves Conditions under which treatment was verified by a verification system.

Returns:

String - value of Treatment Verification Status.

getRecordedBrachyAccessoryDeviceSequence

public RecordedBrachyAccessoryDeviceSequence getRecordedBrachyAccessoryDeviceSequence()

Retrieves pre-initialized object of Recorded Brachy Accessory Device 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:

RecordedBrachyAccessoryDeviceSequence - instance of Recorded Brachy Accessory Device Sequence.

getRecordedChannelSequence

public RecordedChannelSequence getRecordedChannelSequence()

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

RecordedChannelSequence - instance of Recorded Channel Sequence.

validateForModule

public boolean validateForModule()
                          throws InvalidItemException

Validates all the attributes in TreatmentSessionApplicationSetupSequenceItem 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.