cdac.medinfo.sdk.dcm30_04.baselibs

Class StructureSetROISequenceItem

java.lang.Object

cdac.medinfo.sdk.dcm30_04.baselibs.Item

cdac.medinfo.sdk.dcm30_04.baselibs.StructureSetROISequenceItem

All Implemented Interfaces:

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

public class StructureSetROISequenceItem
extends Item

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

See Also:

Serialized Form

Method Summary

Methods

Modifier and Type	Method and Description
DerivationCodeSequence	getDerivationCodeSequence() Retrieves pre-initialized object of Derivation 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	getReferencedFrameofReferenceUID() Retrieves Referenced Frame of Reference UID.
java.lang.String	getROIDescription() Retrieves ROI Description.
java.lang.String	getROIGenerationAlgorithm() Retrieves ROI Generation Algorithm.
java.lang.String	getROIGenerationDescription() Retrieves ROI Generation Description.
java.lang.String	getROIName() Retrieves ROI Name.
java.lang.String	getROINumber() Retrieves ROI Number.
java.lang.String	getROIVolume() Retrieves ROI Volume.
void	setReferencedFrameofReferenceUID(java.lang.String strReferencedFrameofReferenceUID) Sets Referenced Frame of Reference UID .Uniquely identifies Referenced Frame of Reference UID(3006,0024) in Structure Set ROI Sequence (3006,0020) in Structure Set Module of RT Structure Set IOD.
void	setROIDescription(java.lang.String strROIDescription) Sets ROI Description .Uniquely identifies ROI Description(3006,0028) in Structure Set ROI Sequence (3006,0020) in Structure Set Module of RT Structure Set IOD.
void	setROIGenerationAlgorithm(EnumROIGenerationAlgorithm enumROIGenerationAlgorithm) Sets Type of ROI Generation Algorithm.
void	setROIGenerationDescription(java.lang.String strROIGenerationDescription) Sets ROI Generation Description.Uniquely identifies ROI Generation Description(3006,0038) in Structure Set ROI Sequence (3006,0020) in Structure Set Module of RT Structure Set IOD.
void	setROIName(java.lang.String strROIName) Sets ROI Name .Uniquely identifies ROI Name(3006,0026) in Structure Set ROI Sequence (3006,0020) in Structure Set Module of RT Structure Set IOD.
void	setROINumber(java.lang.String strROINumber) Sets ROI Number .Uniquely identifies ROI Number(3006,0022) in Structure Set ROI Sequence (3006,0020) in Structure Set Module of RT Structure Set IOD.
void	setROIVolume(java.lang.String strROIVolume) Sets ROI Volume .Uniquely identifies ROI Volume(3006,002C) in Structure Set ROI Sequence (3006,0020) in Structure Set Module of RT Structure Set IOD.
boolean	validateForModule() Validates all the attributes in StructureSetROISequenceItem 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 StructureSetROISequenceItem 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 Conditional element fails.

setROINumber

public void setROINumber(java.lang.String strROINumber)

Sets ROI Number .Uniquely identifies ROI Number(3006,0022) in Structure Set ROI Sequence (3006,0020) in Structure Set Module of RT Structure Set IOD.

Parameters:

strROINumber - String value of ROI Number.

getROINumber

public java.lang.String getROINumber()

Retrieves ROI Number.

Returns:

String - value of ROI Number.

setReferencedFrameofReferenceUID

public void setReferencedFrameofReferenceUID(java.lang.String strReferencedFrameofReferenceUID)

Sets Referenced Frame of Reference UID .Uniquely identifies Referenced Frame of Reference UID(3006,0024) in Structure Set ROI Sequence (3006,0020) in Structure Set Module of RT Structure Set IOD.

Parameters:

strReferencedFrameofReferenceUID - String value of Referenced Frame of Reference UID.

getReferencedFrameofReferenceUID

public java.lang.String getReferencedFrameofReferenceUID()

Retrieves Referenced Frame of Reference UID.

Returns:

String - value of Referenced Frame of Reference UID.

setROIName

public void setROIName(java.lang.String strROIName)

Sets ROI Name .Uniquely identifies ROI Name(3006,0026) in Structure Set ROI Sequence (3006,0020) in Structure Set Module of RT Structure Set IOD.

Parameters:

strROIName - String value of ROI Name.

getROIName

public java.lang.String getROIName()

Retrieves ROI Name.

Returns:

String value of ROI Name.

setROIDescription

public void setROIDescription(java.lang.String strROIDescription)

Sets ROI Description .Uniquely identifies ROI Description(3006,0028) in Structure Set ROI Sequence (3006,0020) in Structure Set Module of RT Structure Set IOD.

Parameters:

strROIDescription - String value of ROI Description.

getROIDescription

public java.lang.String getROIDescription()

Retrieves ROI Description.

Returns:

String - value of ROI Description.

setROIVolume

public void setROIVolume(java.lang.String strROIVolume)

Sets ROI Volume .Uniquely identifies ROI Volume(3006,002C) in Structure Set ROI Sequence (3006,0020) in Structure Set Module of RT Structure Set IOD.

Parameters:

strROIVolume - String value of ROI Volume.

getROIVolume

public java.lang.String getROIVolume()

Retrieves ROI Volume.

Returns:

String - value of ROI Volume.

setROIGenerationAlgorithm

public void setROIGenerationAlgorithm(EnumROIGenerationAlgorithm enumROIGenerationAlgorithm)

Sets Type of ROI Generation Algorithm.

Parameters:

enumROIGenerationAlgorithm - Enum value of ROI Generation Algorithm.

getROIGenerationAlgorithm

public java.lang.String getROIGenerationAlgorithm()

Retrieves ROI Generation Algorithm.

Returns:

String - value of ROI Generation Algorithm.

setROIGenerationDescription

public void setROIGenerationDescription(java.lang.String strROIGenerationDescription)

Sets ROI Generation Description.Uniquely identifies ROI Generation Description(3006,0038) in Structure Set ROI Sequence (3006,0020) in Structure Set Module of RT Structure Set IOD.

Parameters:

strROIGenerationDescription - String value of ROI Generation Description.

getROIGenerationDescription

public java.lang.String getROIGenerationDescription()

Retrieves ROI Generation Description.

Returns:

String - value of ROI Generation Description.

getDerivationCodeSequence

public DerivationCodeSequence getDerivationCodeSequence()

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

DerivationCodeSequence - instance of Derivation Code Sequence.