cdac.medinfo.sdk.dcm30_04.dicommodel.modules

Class RTGeneralMachineVerificationModule

java.lang.Object

cdac.medinfo.sdk.dcm30_04.dicommodel.modules.Module

cdac.medinfo.sdk.dcm30_04.dicommodel.modules.RTGeneralMachineVerificationModule

All Implemented Interfaces:

IModule, ICollectionIterable, java.lang.Iterable

public class RTGeneralMachineVerificationModule
extends Module

This module specifies the attributes of RT General Machine Verification Module.

Field Summary

Fields

Modifier and Type	Field and Description
static ISingleCollection<ITag>	objSingleCollection The obj single collection.

Constructor Summary

Constructors

Constructor and Description
RTGeneralMachineVerificationModule(IDataSet objIDataSet) Creates RTGeneralMachineVerificationModule with default initialization.

Method Summary

Methods

Modifier and Type	Method and Description
FailedParametersSequence	getFailedParametersSequence() Retrieves pre-initialized object of Failed Parameters Sequence.
GeneralMachineVerificationSequence	getGeneralMachineVerificationSequence() Retrieves pre-initialized object of General Machine Verification Sequence.
OverriddenParametersSequence	getOverriddenParametersSequence() Retrieves pre-initialized object of Overridden Parameters Sequence.
java.lang.String	getPatientID() Return Primary hospital identification number or code for the patient.
java.lang.String	getReferencedFractionGroupNumber() Retrieves Identifier of Fraction Group within referenced RT Plan.
ReferencedRTPlanSequence	getReferencedRTPlanSequence() Retrieves pre-initialized object of Referenced RT Plan Sequence.
java.lang.String	getTreatmentVerificationStatus() Returns Treatment Verification Status
ISingleCollection<ITag>	getVectorOfKeys() This method returns the vector of keys representing the DataElements that belong to this module.
void	setPatientID(java.lang.String strPatientID) Sets Primary hospital identification number or code for the patient.
void	setReferencedFractionGroupNumber(java.lang.String strReferencedFractionGroupNumber) Sets Identifier of Fraction Group within referenced RT Plan.
void	setTreatmentVerificationStatus(EnumTreatmentVerificationStatus enumTreatmentVerificationStatus) Sets conditions under which treatment was verified by a verification system.
boolean	validateModule() This method validates each Attribute in the Module according to the Type of the Attribute.Attributes are of 5 types.

Methods inherited from class cdac.medinfo.sdk.dcm30_04.dicommodel.modules.Module

add, dumpDICOMInfo, getDictionaryReader, getTransferSyntax, isPresent, isPresent, iterator, remove

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

objSingleCollection

public static ISingleCollection<ITag> objSingleCollection

The obj single collection.

Constructor Detail

RTGeneralMachineVerificationModule

public RTGeneralMachineVerificationModule(IDataSet objIDataSet)

Creates RTGeneralMachineVerificationModule with default initialization.

Parameters:

objIDataSet - the obj i data set

Method Detail

validateModule

public boolean validateModule()
                       throws InvalidModuleException

This method validates each Attribute in the Module according to the Type of the Attribute.Attributes are of 5 types. Type 1,Type 2 are Mandatory: Mandatory Attributes have to present in the Module. Type 1C,2C are Conditional: Conditional Attributes' presence depend on a condition. If the condition is satisfied the Attribute has to be present. Type 3 are Optional Optional Attributes can be added as and when required.

Specified by:

validateModule in interface IModule

Specified by:

validateModule in class Module

Returns:

boolean - returns validation status as success or failure

Throws:

InvalidModuleException - - If validation of Module fails

getReferencedRTPlanSequence

public ReferencedRTPlanSequence getReferencedRTPlanSequence()

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

ReferencedRTPlanSequence - instance of ReferencedRTPlanSequence.

setReferencedFractionGroupNumber

public void setReferencedFractionGroupNumber(java.lang.String strReferencedFractionGroupNumber)

Sets Identifier of Fraction Group within referenced RT Plan.

Parameters:

strReferencedFractionGroupNumber - String value of Identifier of Fraction Group within referenced RT Plan.

getReferencedFractionGroupNumber

public java.lang.String getReferencedFractionGroupNumber()

Retrieves Identifier of Fraction Group within referenced RT Plan.

Returns:

String - value of Identifier of Fraction Group within referenced RT Plan.

setPatientID

public void setPatientID(java.lang.String strPatientID)

Sets Primary hospital identification number or code for the patient.

Parameters:

strPatientID - String value of Primary hospital identification number or code for the patient.

getPatientID

public java.lang.String getPatientID()

Return Primary hospital identification number or code for the patient.

Returns:

String - value of Primary hospital identification number or code for the patient.

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-rangevalue overridden NOT_VERIFIED:treatment failed verification (one or more valuesout of range and not overridden)

Parameters:

enumTreatmentVerificationStatus - enum value of Treatment Verification Status

getTreatmentVerificationStatus

public java.lang.String getTreatmentVerificationStatus()

Returns Treatment Verification Status

Returns:

String - value of TreatmentVerificationStatus.

getFailedParametersSequence

public FailedParametersSequence getFailedParametersSequence()

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

FailedAttributesSequence - instance of Failed Parameters Sequence.

getOverriddenParametersSequence

public OverriddenParametersSequence getOverriddenParametersSequence()

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

OverriddenParametersSequence - instance of Overridden Parameters Sequence.

getGeneralMachineVerificationSequence

public GeneralMachineVerificationSequence getGeneralMachineVerificationSequence()

Retrieves pre-initialized object of General Machine Verification 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:

GeneralMachineVerificationSequence - instance of General Machine Verification Sequence.

getVectorOfKeys

public ISingleCollection<ITag> getVectorOfKeys()

This method returns the vector of keys representing the DataElements that belong to this module.

Overrides:

getVectorOfKeys in class Module

Returns:

vector of Tags - returns the vector containing the collection of tags