cdac.medinfo.sdk.dcm30_04.baselibs

Class PatientSetupSequenceItem

java.lang.Object

cdac.medinfo.sdk.dcm30_04.baselibs.Item

cdac.medinfo.sdk.dcm30_04.baselibs.PatientSetupSequenceItem

All Implemented Interfaces:

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

public class PatientSetupSequenceItem
extends Item

A sequence of patient setup data for current plan.

See Also:

Serialized Form

Method Summary

Methods

Modifier and Type	Method and Description
FixationDeviceSequence	getFixationDeviceSequence() Retrieves pre-initialized object of Fixation 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.
MotionSynchronizationSequence	getMotionSynchronizationSequence() Retrieves Motion Synchronization Sequence.
java.lang.String	getPatientAdditionalPosition() Retrieves user-defined additional description of patient position.
java.lang.String	getPatientPosition() Retrieves description of imaging subject�s position relative to the equipment.
java.lang.String	getPatientSetupLabel() Return Patient Setup Label.
java.lang.String	getPatientSetupNumber() Return identification number of the Patient Setup.
ReferencedSetupImageSequence	getReferencedSetupImageSequence() Retrieves pre-initialized object of Referenced Setup 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.
SetupDeviceSequence	getSetupDeviceSequence() Retrieves pre-initialized object of Setup 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.
java.lang.String	getSetupTechnique() Retrieves user-defined additional description of patient position.
java.lang.String	getSetupTechniqueDescription() Retrieves user-defined description of Setup Technique.
ShieldingDeviceSequence	getShieldingDeviceSequence() Retrieves pre-initialized object of Shielding 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.
java.lang.String	getTableTopLateralSetupDisplacement() Retrieves lateral displacement in IEC TABLE TOP coordinate system (in mm) relative to initial Setup Position, i.e.
java.lang.String	getTableTopLongitudinalSetupDisplacement() Retrieves longitudinal displacement in IEC TABLE TOP coordinate system (in mm) relative to initial Setup Position, i.e.
java.lang.String	getTableTopVerticalSetupDisplacement() Retrieves vertical displacement in IEC TABLE TOP coordinate system (in mm) relative to initial Setup Position, i.e.
void	setPatientAdditionalPosition(java.lang.String strPatientAdditionalPosition) Sets user-defined additional description of patient position.
void	setPatientPosition(EnumPatientPosition enumPatientPosition) Sets description of imaging subject�s position relative to the equipment.
void	setPatientSetupLabel(java.lang.String strPatientSetupLabel) Sets Patient Setup Label.
void	setPatientSetupNumber(java.lang.String strPatientSetupNumber) Sets identification number of the Patient Setup.
void	setSetupTechnique(EnumSetupTechnique enumSetupTechnique) Sets user-defined additional description of patient position.
void	setSetupTechniqueDescription(java.lang.String strSetupTechniqueDescription) Sets user-defined description of Setup Technique.
void	setTableTopLateralSetupDisplacement(java.lang.String strTableTopLateralSetupDisplacement) Sets lateral displacement in IEC TABLE TOP coordinate system (in mm) relative to initial Setup Position, i.e.
void	setTableTopLongitudinalSetupDisplacement(java.lang.String strTableTopLongitudinalSetupDisplacement) Sets longitudinal displacement in IEC TABLE TOP coordinate system (in mm) relative to initial Setup Position, i.e.
void	setTableTopVerticalSetupDisplacement(java.lang.String strTableTopVerticalSetupDisplacement) Sets vertical displacement in IEC TABLE TOP coordinate system (in mm) relative to initial Setup Position, i.e.
boolean	validateForModule() Validates all the attributes in CodeSequenceMacro 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 CodeSequenceMacro 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.

setPatientSetupNumber

public void setPatientSetupNumber(java.lang.String strPatientSetupNumber)

Sets identification number of the Patient Setup.

Parameters:

strPatientSetupNumber - String value of Patient Setup Number.

getPatientSetupNumber

public java.lang.String getPatientSetupNumber()

Return identification number of the Patient Setup.

Returns:

String - value of Patient Setup Number.

setPatientSetupLabel

public void setPatientSetupLabel(java.lang.String strPatientSetupLabel)

Sets Patient Setup Label.

Parameters:

strPatientSetupLabel - String value of Patient Setup Label.

getPatientSetupLabel

public java.lang.String getPatientSetupLabel()

Return Patient Setup Label.

Returns:

String - value of Patient Setup Label.

setPatientPosition

public void setPatientPosition(EnumPatientPosition enumPatientPosition)

Sets description of imaging subject�s position relative to the equipment.

Parameters:

enumPatientPosition - Enum value of Patient Position

getPatientPosition

public java.lang.String getPatientPosition()

Retrieves description of imaging subject�s position relative to the equipment.

Returns:

String value of Patient Position

getReferencedSetupImageSequence

public ReferencedSetupImageSequence getReferencedSetupImageSequence()

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

ReferencedSetupImageSequence - instance of ReferencedSetupImageSequence.

setPatientAdditionalPosition

public void setPatientAdditionalPosition(java.lang.String strPatientAdditionalPosition)

Sets user-defined additional description of patient position. Required if Patient Position (0018,5100) is not present.

Parameters:

strPatientAdditionalPosition - String value of Patient Additional Position.

getPatientAdditionalPosition

public java.lang.String getPatientAdditionalPosition()

Retrieves user-defined additional description of patient position. Required if Patient Position (0018,5100) is not present.

Returns:

String - value of Patient Additional Position.

getFixationDeviceSequence

public FixationDeviceSequence getFixationDeviceSequence()

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

FixationDeviceSequence - instance of FixationDeviceSequence.

getShieldingDeviceSequence

public ShieldingDeviceSequence getShieldingDeviceSequence()

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

ShieldingDeviceSequence - instance of ShieldingDeviceSequence.

setSetupTechnique

public void setSetupTechnique(EnumSetupTechnique enumSetupTechnique)

Sets user-defined additional description of patient position. Required if Patient Position (0018,5100) is not present.

Parameters:

enumSetupTechnique - enum value of Setup Technique.

getSetupTechnique

public java.lang.String getSetupTechnique()

Retrieves user-defined additional description of patient position. Required if Patient Position (0018,5100) is not present.

Returns:

String - value of Patient Additional Position.

setSetupTechniqueDescription

public void setSetupTechniqueDescription(java.lang.String strSetupTechniqueDescription)

Sets user-defined description of Setup Technique.

Parameters:

strSetupTechniqueDescription - String value of Setup Technique Description.

getSetupTechniqueDescription

public java.lang.String getSetupTechniqueDescription()

Retrieves user-defined description of Setup Technique.

Returns:

String - value of Setup Technique Description.

getSetupDeviceSequence

public SetupDeviceSequence getSetupDeviceSequence()

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

SetupDeviceSequence - instance of SetupDeviceSequence.

setTableTopVerticalSetupDisplacement

public void setTableTopVerticalSetupDisplacement(java.lang.String strTableTopVerticalSetupDisplacement)

Sets vertical displacement in IEC TABLE TOP coordinate system (in mm) relative to initial Setup Position, i.e. vertical offset between patient positioning performed using setup and treatment position.

Parameters:

strTableTopVerticalSetupDisplacement - String value of Table Top Vertical Setup Displacement.

getTableTopVerticalSetupDisplacement

public java.lang.String getTableTopVerticalSetupDisplacement()

Retrieves vertical displacement in IEC TABLE TOP coordinate system (in mm) relative to initial Setup Position, i.e. vertical offset between patient positioning performed using setup and treatment position.

Returns:

String - value of Table Top Vertical Setup Displacement.

setTableTopLongitudinalSetupDisplacement

public void setTableTopLongitudinalSetupDisplacement(java.lang.String strTableTopLongitudinalSetupDisplacement)

Sets longitudinal displacement in IEC TABLE TOP coordinate system (in mm) relative to initial Setup Position, i.e. longitudinal offset between patient positioning performed using setup and treatment position.

Parameters:

strTableTopLongitudinalSetupDisplacement - String value of Table Top Longitudinal Setup Displacement.

getTableTopLongitudinalSetupDisplacement

public java.lang.String getTableTopLongitudinalSetupDisplacement()

Retrieves longitudinal displacement in IEC TABLE TOP coordinate system (in mm) relative to initial Setup Position, i.e. longitudinal offset between patient positioning performed using setup and treatment position.

Returns:

String - value of Table Top Longitudinal Setup Displacement.

setTableTopLateralSetupDisplacement

public void setTableTopLateralSetupDisplacement(java.lang.String strTableTopLateralSetupDisplacement)

Sets lateral displacement in IEC TABLE TOP coordinate system (in mm) relative to initial Setup Position, i.e. lateral offset between patient positioning performed using setup and treatment position.

Parameters:

strTableTopLateralSetupDisplacement - String value of Table Top Lateral Setup Displacement.

getTableTopLateralSetupDisplacement

public java.lang.String getTableTopLateralSetupDisplacement()

Retrieves lateral displacement in IEC TABLE TOP coordinate system (in mm) relative to initial Setup Position, i.e. lateral offset between patient positioning performed using setup and treatment position.

Returns:

String - value of Table Top Longitudinal Setup Displacement.

getMotionSynchronizationSequence

public MotionSynchronizationSequence getMotionSynchronizationSequence()

Retrieves Motion Synchronization 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:

FixationDeviceSequence - instance of FixationDeviceSequence.