cdac.medinfo.sdk.dcm30_04.baselibs

Class SetupDeviceSequenceItem

java.lang.Object

cdac.medinfo.sdk.dcm30_04.baselibs.Item

cdac.medinfo.sdk.dcm30_04.baselibs.SetupDeviceSequenceItem

All Implemented Interfaces:

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

public class SetupDeviceSequenceItem
extends Item

A sequence of devices used for patient alignment in Patient Setup.

See Also:

Serialized Form

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getAccessoryCode() Return Accessory Code.
java.lang.String	getSetupDeviceDescription() Return user-defined description of Setup Device.
java.lang.String	getSetupDeviceLabel() Return user-defined label for Setup Device used for patient alignment.
java.lang.String	getSetupDeviceParameter() Return Setup Parameter for Setup Device in appropriate IEC 61217 coordinate system.
java.lang.String	getSetupDeviceType() Return type of setup device used for Patient alignment.
java.lang.String	getSetupReferenceDescription() Return user-defined description of Setup Reference used for patient alignment.
void	setAccessoryCode(java.lang.String strAccessoryCode) Sets Accessory Code.
void	setSetupDeviceDescription(java.lang.String strSetupDeviceDescription) Sets user-defined description of Setup Device.
void	setSetupDeviceLabel(java.lang.String strSetupDeviceLabel) Sets user-defined label for Setup Device used for patient alignment.
void	setSetupDeviceParameter(java.lang.String strSetupDeviceParameter) Sets Setup Parameter for Setup Device in appropriate IEC 61217 coordinate system.
void	setSetupDeviceType(EnumSetupDeviceType enumSetupDeviceType) Sets type of setup device used for Patient alignment.
void	setSetupReferenceDescription(java.lang.String strSetupReferenceDescription) Sets user-defined description of Setup Reference used for patient alignment.
boolean	validateForModule() Validates all the attributes in SetupDeviceSequence 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 SetupDeviceSequence 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.

setSetupDeviceType

public void setSetupDeviceType(EnumSetupDeviceType enumSetupDeviceType)

Sets type of setup device used for Patient alignment. Required if Setup Device Sequence (300A,01B4) is sent. Defined Terms: 1) LASER_POINTER. 2) DISTANCE_METER. 3) TABLE_HEIGHT 4) MECHANICAL_PTR. 5) ARC.

Parameters:

enumSetupDeviceType - enum value of Setup Device Type.

getSetupDeviceType

public java.lang.String getSetupDeviceType()

Return type of setup device used for Patient alignment.

Returns:

String - value of Setup Device Type.

setSetupDeviceLabel

public void setSetupDeviceLabel(java.lang.String strSetupDeviceLabel)

Sets user-defined label for Setup Device used for patient alignment.

Parameters:

strSetupDeviceLabel - String value of Setup Device Label.

getSetupDeviceLabel

public java.lang.String getSetupDeviceLabel()

Return user-defined label for Setup Device used for patient alignment.

Returns:

String - value of Setup Device Label.

setSetupDeviceDescription

public void setSetupDeviceDescription(java.lang.String strSetupDeviceDescription)

Sets user-defined description of Setup Device.

Parameters:

strSetupDeviceDescription - String value of Setup Device Description.

getSetupDeviceDescription

public java.lang.String getSetupDeviceDescription()

Return user-defined description of Setup Device.

Returns:

String - value of Setup Device Description.

setSetupDeviceParameter

public void setSetupDeviceParameter(java.lang.String strSetupDeviceParameter)

Sets Setup Parameter for Setup Device in appropriate IEC 61217 coordinate system. Units shall be mm for distances and angles for degrees.

Parameters:

strSetupDeviceParameter - String value of Setup Device Parameter.

getSetupDeviceParameter

public java.lang.String getSetupDeviceParameter()

Return Setup Parameter for Setup Device in appropriate IEC 61217 coordinate system. Units shall be mm for distances and angles for degrees.

Returns:

String - value of Setup Device Parameter.

setSetupReferenceDescription

public void setSetupReferenceDescription(java.lang.String strSetupReferenceDescription)

Sets user-defined description of Setup Reference used for patient alignment.

Parameters:

strSetupReferenceDescription - String value of Setup Reference Description.

getSetupReferenceDescription

public java.lang.String getSetupReferenceDescription()

Return user-defined description of Setup Reference used for patient alignment.

Returns:

String - value of Setup Reference Description.

setAccessoryCode

public void setAccessoryCode(java.lang.String strAccessoryCode)

Sets Accessory Code.

Parameters:

strAccessoryCode - String value of Accessory Code.

getAccessoryCode

public java.lang.String getAccessoryCode()

Return Accessory Code.

Returns:

String - value of Accessory Code.