cdac.medinfo.sdk.dcm30_04.baselibs

Class RecordedSourceApplicatorSequenceItem

java.lang.Object

cdac.medinfo.sdk.dcm30_04.baselibs.Item

cdac.medinfo.sdk.dcm30_04.baselibs.RecordedSourceApplicatorSequenceItem

All Implemented Interfaces:

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

public class RecordedSourceApplicatorSequenceItem
extends Item

This item class contains the methods to set, get and validate the attribute present in Recorded Source Applicator Sequence.

See Also:

Serialized Form

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getReferencedSourceApplicatorNumber() Retrieves Identification number of the Source Applicator.
java.lang.String	getSourceApplicatorID() Retrieves User or machine supplied identifier for Source Applicator.
java.lang.String	getSourceApplicatorLength() Retrieves Length of Source Applicator (mm),
java.lang.String	getSourceApplicatorManufacturer() Retrieves Manufacturer of Source Applicator.
java.lang.String	getSourceApplicatorName() Retrieves User-defined name for Source Applicator.
java.lang.String	getSourceApplicatorStepSize() Retrieves Distance of path along channel (mm) between adjacent (potential) dwell positions.
java.lang.String	getSourceApplicatorType() Retrieves Type of Source Applicator.
void	setReferencedSourceApplicatorNumber(java.lang.String strReferencedSourceApplicatorNumber) Sets Identification number of the Source Applicator.
void	setSourceApplicatorID(java.lang.String strSourceApplicatorID) Sets User or machine supplied identifier for Source Applicator.
void	setSourceApplicatorLength(java.lang.String strSourceApplicatorLength) Sets Length of Source Applicator (mm), defined as the distance between the connector of the applicator and the distal-most position of the source.
void	setSourceApplicatorManufacturer(java.lang.String strSourceApplicatorManufacturer) Sets Manufacturer of Source Applicator.
void	setSourceApplicatorName(java.lang.String strSourceApplicatorName) Sets User-defined name for Source Applicator.
void	setSourceApplicatorStepSize(java.lang.String strSourceApplicatorStepSize) Sets Distance of path along channel (mm) between adjacent (potential) dwell positions.
void	setSourceApplicatorType(EnumSourceApplicatorType enumSourceApplicatorType) Sets Type of Source Applicator.
boolean	validateForModule() Validates all the attributes in RecordedSourceApplicatorSequenceItem 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

setReferencedSourceApplicatorNumber

public void setReferencedSourceApplicatorNumber(java.lang.String strReferencedSourceApplicatorNumber)

Sets Identification number of the Source Applicator. The value of Source Applicator Number (300A,0290) shall be unique within the Channel in which it is created.

Parameters:

strReferencedSourceApplicatorNumber - String value of Referenced Source Applicator Number.

getReferencedSourceApplicatorNumber

public java.lang.String getReferencedSourceApplicatorNumber()

Retrieves Identification number of the Source Applicator.

Returns:

String - value of Identification number of the Source Applicator.

setSourceApplicatorID

public void setSourceApplicatorID(java.lang.String strSourceApplicatorID)

Sets User or machine supplied identifier for Source Applicator.

Parameters:

strSourceApplicatorID - String value of Source Applicator ID.

getSourceApplicatorID

public java.lang.String getSourceApplicatorID()

Retrieves User or machine supplied identifier for Source Applicator.

Returns:

String - value of User or machine supplied identifier for Source Applicator.

setSourceApplicatorType

public void setSourceApplicatorType(EnumSourceApplicatorType enumSourceApplicatorType)

Sets Type of Source Applicator.

Parameters:

enumSourceApplicatorType - Enum value of Type of Source Applicator.

getSourceApplicatorType

public java.lang.String getSourceApplicatorType()

Retrieves Type of Source Applicator.

Returns:

String - value of Type of Source Applicator.

setSourceApplicatorName

public void setSourceApplicatorName(java.lang.String strSourceApplicatorName)

Sets User-defined name for Source Applicator.

Parameters:

strSourceApplicatorName - String value of Source Applicator Name.

getSourceApplicatorName

public java.lang.String getSourceApplicatorName()

Retrieves User-defined name for Source Applicator.

Returns:

String - value of Source Applicator Name.

setSourceApplicatorLength

public void setSourceApplicatorLength(java.lang.String strSourceApplicatorLength)

Sets Length of Source Applicator (mm), defined as the distance between the connector of the applicator and the distal-most position of the source.

Parameters:

strSourceApplicatorLength - String value of Source Applicator Length.

getSourceApplicatorLength

public java.lang.String getSourceApplicatorLength()

Retrieves Length of Source Applicator (mm),

Returns:

String - value of Length of Source Applicator (mm).

setSourceApplicatorManufacturer

public void setSourceApplicatorManufacturer(java.lang.String strSourceApplicatorManufacturer)

Sets Manufacturer of Source Applicator.

Parameters:

strSourceApplicatorManufacturer - String value of Source Applicator Manufacturer.

getSourceApplicatorManufacturer

public java.lang.String getSourceApplicatorManufacturer()

Retrieves Manufacturer of Source Applicator.

Returns:

String - value of Manufacturer of Source Applicator.

setSourceApplicatorStepSize

public void setSourceApplicatorStepSize(java.lang.String strSourceApplicatorStepSize)

Sets Distance of path along channel (mm) between adjacent (potential) dwell positions.

Parameters:

strSourceApplicatorStepSize - String value of Source Applicator Step Size.

getSourceApplicatorStepSize

public java.lang.String getSourceApplicatorStepSize()

Retrieves Distance of path along channel (mm) between adjacent (potential) dwell positions.

Returns:

String - value of Manufacturer of Source Applicator Step Size.

validateForModule

public boolean validateForModule()
                          throws InvalidItemException

Validates all the attributes in RecordedSourceApplicatorSequenceItem 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.