cdac.medinfo.sdk.dcm30_04.baselibs

Class RTROIObservationsSequenceItem

java.lang.Object

cdac.medinfo.sdk.dcm30_04.baselibs.Item

cdac.medinfo.sdk.dcm30_04.baselibs.RTROIObservationsSequenceItem

All Implemented Interfaces:

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

public class RTROIObservationsSequenceItem
extends Item

This item class contains methods to validate,set and get the attributes in RTROIObservationsSequence.

See Also:

Serialized Form

Method Summary

Methods

Modifier and Type	Method and Description
AdditionalRTROIIdentificationCodeSequence	getAdditionalRTROIIdentificationCodeSequence() Retrieves pre-initialized object of Additional RT ROI Identification Code 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	getMaterialID() Retrieves user-supplied identifier for ROI material.
java.lang.String	getObservationNumber() Retrieves identifies a related ROI Observation.
java.lang.String	getReferencedROINumber() Retrieves value that uniquely identifies the referenced ROI described in the Structure Set ROI Sequence (3006,0020).
RelatedRTROIObservationsSequence	getRelatedRTROIObservationsSequence() Retrieves pre-initialized object of Related RT ROI Observations 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	getROIInterpreter() Retrieves name of person performing the interpretation.
java.lang.String	getROIObservationDescription() Retrieves user-defined label for ROI Observation.
java.lang.String	getROIObservationLabel() Retrieves user-defined label for ROI Observation.
ROIPhysicalPropertiesSequence	getROIPhysicalPropertiesSequence() Retrieves pre-initialized object of ROI Physical Properties 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.
RTRelatedROISequence	getRTRelatedROISequence() Retrieves pre-initialized object of RT Related ROI 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.
RTROIIdentificationCodeSequence	getRTROIIdentificationCodeSequence() Retrieves pre-initialized object of RT ROI Identification Code 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	getRTROIInterpretedType() Retrieves type of ROI.
SegmentedPropertyCategoryCodeSequence	getSegmentedPropertyCategoryCodeSequence() Retrieves pre-initialized object of Segmented Property Category Code 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.
void	setMaterialID(java.lang.String strMaterialID) Sets user-supplied identifier for ROI material.
void	setObservationNumber(java.lang.String strObservationNumber) Sets identifies a related ROI Observation.
void	setReferencedROINumber(java.lang.String strReferencedROINumber) Sets value that uniquely identifies the referenced ROI described in the Structure Set ROI Sequence (3006,0020).
void	setROIInterpreter(java.lang.String strROIInterpreter) Sets name of person performing the interpretation.
void	setROIObservationDescription(java.lang.String strROIObservationDescription) Sets user-defined label for ROI Observation.
void	setROIObservationLabel(java.lang.String strROIObservationLabel) Sets user-defined label for ROI Observation.
void	setRTROIInterpretedType(java.lang.String strRTROIInterpretedType) Sets type of ROI.
boolean	validateForModule() Validates all the attributes in RTROIObservationsSequenceItem 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 RTROIObservationsSequenceItem 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.

setObservationNumber

public void setObservationNumber(java.lang.String strObservationNumber)

Sets identifies a related ROI Observation.

Parameters:

strObservationNumber - String value of Observation Number.

getObservationNumber

public java.lang.String getObservationNumber()

Retrieves identifies a related ROI Observation.

Returns:

String - value of Observation Number.

setReferencedROINumber

public void setReferencedROINumber(java.lang.String strReferencedROINumber)

Sets value that uniquely identifies the referenced ROI described in the Structure Set ROI Sequence (3006,0020).

Parameters:

strReferencedROINumber - String value of Referenced ROI Number.

getReferencedROINumber

public java.lang.String getReferencedROINumber()

Retrieves value that uniquely identifies the referenced ROI described in the Structure Set ROI Sequence (3006,0020).

Returns:

String - value of Referenced ROI Number.

setROIObservationLabel

public void setROIObservationLabel(java.lang.String strROIObservationLabel)

Sets user-defined label for ROI Observation.

Parameters:

strROIObservationLabel - String value of ROI Observation Label.

getROIObservationLabel

public java.lang.String getROIObservationLabel()

Retrieves user-defined label for ROI Observation.

Returns:

String - value of ROI Observation Label.

setROIObservationDescription

public void setROIObservationDescription(java.lang.String strROIObservationDescription)

Sets user-defined label for ROI Observation.

Parameters:

strROIObservationDescription - String value of ROI Observation Description.

getROIObservationDescription

public java.lang.String getROIObservationDescription()

Retrieves user-defined label for ROI Observation.

Returns:

String - value of ROI Observation Description.

getRTRelatedROISequence

public RTRelatedROISequence getRTRelatedROISequence()

Retrieves pre-initialized object of RT Related ROI 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:

RTRelatedROISequence - instance of RTRelatedROISequence.

getSegmentedPropertyCategoryCodeSequence

public SegmentedPropertyCategoryCodeSequence getSegmentedPropertyCategoryCodeSequence()

Retrieves pre-initialized object of Segmented Property Category Code 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:

SegmentedPropertyCategoryCodeSequence - instance of SegmentedPropertyCategoryCodeSequence.

getRTROIIdentificationCodeSequence

public RTROIIdentificationCodeSequence getRTROIIdentificationCodeSequence()

Retrieves pre-initialized object of RT ROI Identification Code 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:

RTROIIdentificationCodeSequence - instance of RTROIIdentificationCodeSequence.

getAdditionalRTROIIdentificationCodeSequence

public AdditionalRTROIIdentificationCodeSequence getAdditionalRTROIIdentificationCodeSequence()

Retrieves pre-initialized object of Additional RT ROI Identification Code 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:

AdditionalRTROIIdentificationCodeSequence - instance of AdditionalRTROIIdentificationCodeSequence.

getRelatedRTROIObservationsSequence

public RelatedRTROIObservationsSequence getRelatedRTROIObservationsSequence()

Retrieves pre-initialized object of Related RT ROI Observations 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:

RelatedRTROIObservationsSequence - instance of RelatedRTROIObservationsSequence.

setRTROIInterpretedType

public void setRTROIInterpretedType(java.lang.String strRTROIInterpretedType)

Sets type of ROI.

Parameters:

strRTROIInterpretedType - String value of RT ROI Interpreted Type.

getRTROIInterpretedType

public java.lang.String getRTROIInterpretedType()

Retrieves type of ROI.

Returns:

String - value of RT ROI Interpreted Type.

setROIInterpreter

public void setROIInterpreter(java.lang.String strROIInterpreter)

Sets name of person performing the interpretation.

Parameters:

strROIInterpreter - String value of ROI Interpreter.

getROIInterpreter

public java.lang.String getROIInterpreter()

Retrieves name of person performing the interpretation.

Returns:

String - value of ROI Interpreter.

setMaterialID

public void setMaterialID(java.lang.String strMaterialID)

Sets user-supplied identifier for ROI material.

Parameters:

strMaterialID - String value of Material ID.

getMaterialID

public java.lang.String getMaterialID()

Retrieves user-supplied identifier for ROI material.

Returns:

String - value of Material ID.

getROIPhysicalPropertiesSequence

public ROIPhysicalPropertiesSequence getROIPhysicalPropertiesSequence()

Retrieves pre-initialized object of ROI Physical Properties 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:

ROIPhysicalPropertiesSequence - instance of ROIPhysicalPropertiesSequence.