cdac.medinfo.sdk.dcm30_04.baselibs

Class GeneralMachineVerificationSequenceItem

java.lang.Object

cdac.medinfo.sdk.dcm30_04.baselibs.Item

cdac.medinfo.sdk.dcm30_04.baselibs.GeneralMachineVerificationSequenceItem

All Implemented Interfaces:

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

public class GeneralMachineVerificationSequenceItem
extends Item

This item class contains the methods to set, get and validate the attribute present in General Machine Verification Sequence .

See Also:

Serialized Form

Method Summary

Methods

Modifier and Type	Method and Description
ApplicatorSequence	getApplicatorSequence() Retrieves pre-initialized object of Applicator 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.
BeamLimitingDeviceLeafPairsSequence	getBeamLimitingDeviceLeafPairsSequence() Retrieves pre-initialized object of Beam Limiting Device Leaf PairsSequence.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	getBeamName() Return Beam Name.
java.lang.String	getNumberOfBlocks() Retrieves Number Of Blocks
java.lang.String	getNumberOfBoli() Retrieves Number Of Boli
java.lang.String	getNumberOfCompensators() Retrieves Number Of Compensators
java.lang.String	getNumberOfControlPoints() Retrieves Number Of Control Points
java.lang.String	getNumberOfWedges() Retrieves Number Of Wedges
PatientSetupSequence	getPatientSetupSequence() Retrieves pre-initialized object of Patient Setup 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	getRadiationType() Return type of Radiation used.
RecordedBlockSequence	getRecordedBlockSequence() Retrieves pre-initialized object of Recorded Block Sequencee.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.
RecordedCompensatorSequence	getRecordedCompensatorSequence() Retrieves pre-initialized object of Recorded Compensator 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	getReferencedBeamNumber() Retrieves Referenced Beam Number
ReferencedBolusSequence	getReferencedBolusSequence() Retrieves pre-initialized object of Referenced Bolus 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	getSpecifiedPrimaryMeterset() Return Specified Primary Meterset.
java.lang.String	getSpecifiedSecondaryMeterset() Return Specified Secondary Meterset.
java.lang.String	getSpecifiedTreatmentTime() Return Specified Treatment Time.
java.lang.String	getTreatmentMachineName() Return Treatment Machine Name.
void	setBeamName(java.lang.String strBeamName) Sets Beam Name.
void	setNumberOfBlocks(java.lang.String strNumberOfBlocks) Sets the Number Of Blocks.
void	setNumberOfBoli(java.lang.String strNumberOfBoli) Sets the Number Of Boli.
void	setNumberOfCompensators(java.lang.String strNumberOfCompensators) Sets the Number Of Compensators.
void	setNumberOfControlPoints(java.lang.String strNumberOfControlPoints) Sets the Number Of Control Points.
void	setNumberOfWedges(java.lang.String strNumberOfWedges) Sets the Number Of Wedges.
void	setRadiationType(EnumRadiationType enumRadiationType) Sets Particle type of Beam.
void	setReferencedBeamNumber(java.lang.String strReferencedBeamNumber) Sets the Referenced Beam Number.
void	setSpecifiedPrimaryMeterset(java.lang.String strSpecifiedPrimaryMeterset) Sets Specified Primary Meterset.
void	setSpecifiedSecondaryMeterset(java.lang.String strSpecifiedSecondaryMeterset) Sets Specified Secondary Meterset.
void	setSpecifiedTreatmentTime(java.lang.String strSpecifiedTreatmentTime) Sets Specified Treatment Time.
void	setTreatmentMachineName(java.lang.String strTreatmentMachineName) Sets Treatment Machine Name.
boolean	validateForModule() Validates all the attributes in GeneralMachineVerificationSequenceItem 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 GeneralMachineVerificationSequenceItem 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.

setSpecifiedPrimaryMeterset

public void setSpecifiedPrimaryMeterset(java.lang.String strSpecifiedPrimaryMeterset)

Sets Specified Primary Meterset.

Parameters:

strSpecifiedPrimaryMeterset - -String value of Specified Primary Meterset.

getSpecifiedPrimaryMeterset

public java.lang.String getSpecifiedPrimaryMeterset()

Return Specified Primary Meterset.

Returns:

String - value of Specified Primary Meterset.

setSpecifiedSecondaryMeterset

public void setSpecifiedSecondaryMeterset(java.lang.String strSpecifiedSecondaryMeterset)

Sets Specified Secondary Meterset.

Parameters:

strSpecifiedSecondaryMeterset - -String value of Specified Secondary Meterset.

getSpecifiedSecondaryMeterset

public java.lang.String getSpecifiedSecondaryMeterset()

Return Specified Secondary Meterset.

Returns:

String - value of Specified Secondary Meterset.

setSpecifiedTreatmentTime

public void setSpecifiedTreatmentTime(java.lang.String strSpecifiedTreatmentTime)

Sets Specified Treatment Time.

Parameters:

strSpecifiedTreatmentTime - -String value of Specified Treatment Time.

getSpecifiedTreatmentTime

public java.lang.String getSpecifiedTreatmentTime()

Return Specified Treatment Time.

Returns:

String - value of Specified Treatment Time.

getBeamLimitingDeviceLeafPairsSequence

public BeamLimitingDeviceLeafPairsSequence getBeamLimitingDeviceLeafPairsSequence()

Retrieves pre-initialized object of Beam Limiting Device Leaf PairsSequence.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:

BeamLimitingDeviceLeafPairsSequence - instance of BeamLimitingDeviceLeafPairsSequence.

getRecordedBlockSequence

public RecordedBlockSequence getRecordedBlockSequence()

Retrieves pre-initialized object of Recorded Block Sequencee.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:

RecordedBlockSequence - instance of RecordedBlockSequence.

setTreatmentMachineName

public void setTreatmentMachineName(java.lang.String strTreatmentMachineName)

Sets Treatment Machine Name.

Parameters:

strTreatmentMachineName - -String value of Treatment Machine Name.

getTreatmentMachineName

public java.lang.String getTreatmentMachineName()

Return Treatment Machine Name.

Returns:

String - value of Treatment Machine Name.

setBeamName

public void setBeamName(java.lang.String strBeamName)

Sets Beam Name.

Parameters:

strBeamName - -String value of Beam Name.

getBeamName

public java.lang.String getBeamName()

Return Beam Name.

Returns:

String - value of Beam Name.

setRadiationType

public void setRadiationType(EnumRadiationType enumRadiationType)

Sets Particle type of Beam. Enumerated Values: PHOTON ELECTRON NEUTRON PROTON ION

Parameters:

enumRadiationType - enum value of Radiation Type.

getRadiationType

public java.lang.String getRadiationType()

Return type of Radiation used.

Returns:

String - value of Radiation Type.

setNumberOfWedges

public void setNumberOfWedges(java.lang.String strNumberOfWedges)

Sets the Number Of Wedges.

Parameters:

strNumberOfWedges - -String value Number Of Wedges

getNumberOfWedges

public java.lang.String getNumberOfWedges()

Retrieves Number Of Wedges

Returns:

String - value of Number Of Wedges

setNumberOfCompensators

public void setNumberOfCompensators(java.lang.String strNumberOfCompensators)

Sets the Number Of Compensators.

Parameters:

strNumberOfCompensators - -String value Number Of Compensators

getNumberOfCompensators

public java.lang.String getNumberOfCompensators()

Retrieves Number Of Compensators

Returns:

String - value of Number Of Compensators

setNumberOfBoli

public void setNumberOfBoli(java.lang.String strNumberOfBoli)

Sets the Number Of Boli.

Parameters:

strNumberOfBoli - -String value Number Of Boli

getNumberOfBoli

public java.lang.String getNumberOfBoli()

Retrieves Number Of Boli

Returns:

String - value of Number Of Boli

setNumberOfBlocks

public void setNumberOfBlocks(java.lang.String strNumberOfBlocks)

Sets the Number Of Blocks.

Parameters:

strNumberOfBlocks - -String value Number Of Blocks

getNumberOfBlocks

public java.lang.String getNumberOfBlocks()

Retrieves Number Of Blocks

Returns:

String - value of Number Of Blocks

getApplicatorSequence

public ApplicatorSequence getApplicatorSequence()

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

ApplicatorSequence - instance of ApplicatorSequence.

setNumberOfControlPoints

public void setNumberOfControlPoints(java.lang.String strNumberOfControlPoints)

Sets the Number Of Control Points.

Parameters:

strNumberOfControlPoints - -String value Number Of Control Points

getNumberOfControlPoints

public java.lang.String getNumberOfControlPoints()

Retrieves Number Of Control Points

Returns:

String - value of Number Of Control Points

setReferencedBeamNumber

public void setReferencedBeamNumber(java.lang.String strReferencedBeamNumber)

Sets the Referenced Beam Number.

Parameters:

strReferencedBeamNumber - -String value Referenced Beam Number

getReferencedBeamNumber

public java.lang.String getReferencedBeamNumber()

Retrieves Referenced Beam Number

Returns:

String - value of Referenced Beam Number

getPatientSetupSequence

public PatientSetupSequence getPatientSetupSequence()

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

PatientSetupSequence - instance of PatientSetupSequence.

getReferencedBolusSequence

public ReferencedBolusSequence getReferencedBolusSequence()

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

ReferencedBolusSequence - instance of ReferencedBolusSequence.

getRecordedCompensatorSequence

public RecordedCompensatorSequence getRecordedCompensatorSequence()

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

RecordedCompensatorSequence - instance of RecordedCompensatorSequence.