cdac.medinfo.sdk.dcm30_04.baselibs

Class ApplicatorSequenceItem

java.lang.Object

cdac.medinfo.sdk.dcm30_04.baselibs.Item

cdac.medinfo.sdk.dcm30_04.baselibs.ApplicatorSequenceItem

All Implemented Interfaces:

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

public class ApplicatorSequenceItem
extends Item

This item class contains methods to validate, set and get attributes in Applicator Sequence.

See Also:

Serialized Form

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getAccessoryCode() Retrieves Accessory Code.
java.lang.String	getApplicatorDescription() Retrieves User-defined description for Applicator.
ApplicatorGeometrySequence	getApplicatorGeometrySequence() Retrieves pre-initialized object of Applicator Geometry 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	getApplicatorID() Retrieves user or machine supplied identifier for Applicator.
java.lang.String	getApplicatorType() Retrieves Type of Applicator.
float	getSourceToApplicatorMountingPositionDistance() Retrieves Source to Applicator Mounting Position Distance.
void	setAccessoryCode(java.lang.String strAccessoryCode) Sets an identifier for the accessory intended to be read by a device such as a bar-code reader.
void	setApplicatorDescription(java.lang.String strApplicatorDescription) Sets User-defined description for Applicator
void	setApplicatorID(java.lang.String strApplicatorID) Sets user or machine supplied identifier for Applicator.
void	setApplicatorType(EnumApplicatorType enumApplicatorType) Sets Type of Applicator.
void	setSourceToApplicatorMountingPositionDistance(float fSourceToApplicatorMountingPositionDistance) Sets Source to Applicator Mounting Position Distance.
boolean	validateForModule() Validates all the attributes in Applicator Sequence Item 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 Applicator Sequence Item 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.

setApplicatorID

public void setApplicatorID(java.lang.String strApplicatorID)

Sets user or machine supplied identifier for Applicator. Required if Applicator Sequence (300A,0107) is sent.

Parameters:

strApplicatorID - -String value of Applicator ID.

getApplicatorID

public java.lang.String getApplicatorID()

Retrieves user or machine supplied identifier for Applicator.

Returns:

String - value of Applicator ID.

setApplicatorType

public void setApplicatorType(EnumApplicatorType enumApplicatorType)

Sets Type of Applicator. Defined Terms: 1) ELECTRON_SQUARE = square electron applicator. 2) ELECTRON_RECT = rectangular electron applicator. 3) ELECTRON_CIRC = circular electron applicator. 4) ELECTRON_SHORT = short electron applicator. 5) ELECTRON_OPEN = open (dummy) electron applicator. 6) PHOTON_SQUARE = square photon applicator 7) PHOTON_RECT = rectangular photon applicator 8) PHOTON_CIRC = circular photon applicator 9) INTRAOPERATIVE = intraoperative (custom) applicator. 10) STEREOTACTIC = stereotactic applicator.

Parameters:

enumApplicatorType - -Enum value of Applicator Type.

getApplicatorType

public java.lang.String getApplicatorType()

Retrieves Type of Applicator.

Returns:

String value of Applicator Type.

setApplicatorDescription

public void setApplicatorDescription(java.lang.String strApplicatorDescription)

Sets User-defined description for Applicator

Parameters:

strApplicatorDescription - -String value of Applicator Description.

getApplicatorDescription

public java.lang.String getApplicatorDescription()

Retrieves User-defined description for Applicator.

Returns:

String - value of Applicator Description.

setAccessoryCode

public void setAccessoryCode(java.lang.String strAccessoryCode)

Sets an identifier for the accessory intended to be read by a device such as a bar-code reader.

Parameters:

strAccessoryCode - -String value of Accessory Code.

getAccessoryCode

public java.lang.String getAccessoryCode()

Retrieves Accessory Code.

Returns:

String - value of Accessory Code.

getApplicatorGeometrySequence

public ApplicatorGeometrySequence getApplicatorGeometrySequence()

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

ApplicatorGeometrySequence - instance of Applicator Geometry Sequence.

setSourceToApplicatorMountingPositionDistance

public void setSourceToApplicatorMountingPositionDistance(float fSourceToApplicatorMountingPositionDistance)

Sets Source to Applicator Mounting Position Distance.

Parameters:

fSourceToApplicatorMountingPositionDistance- - float value of Source to Applicator Mounting Position Distance.

getSourceToApplicatorMountingPositionDistance

public float getSourceToApplicatorMountingPositionDistance()

Retrieves Source to Applicator Mounting Position Distance.

Returns:

float - value of Source to Applicator Mounting Position Distance.