cdac.medinfo.sdk.dcm30_04.baselibs

Class DVHReferencedROISequenceItem

java.lang.Object

cdac.medinfo.sdk.dcm30_04.baselibs.Item

cdac.medinfo.sdk.dcm30_04.baselibs.DVHReferencedROISequenceItem

All Implemented Interfaces:

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

public class DVHReferencedROISequenceItem
extends Item

This item class contains the methods to set,get and validate the attribute present in DVH Referenced ROI Sequence.

See Also:

Serialized Form

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getDVHROIContributionType() Retrieves whether volume within ROI is included or excluded in DVH.
java.lang.String	getReferencedROINumber() Retrieves Referenced ROI Number .
void	setDVHROIContributionType(EnumDVHROIContributionType enumDVHROIContributionType) Sets whether volume within ROI is included or excluded in DVH.
void	setReferencedROINumber(java.lang.String strReferencedROINumber) Sets Referenced ROI Number .
boolean	validateForModule() Validates all the attributes in DVHReferencedROISequenceItem 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

setReferencedROINumber

public void setReferencedROINumber(java.lang.String strReferencedROINumber)

Sets Referenced ROI Number . Uniquely identifies ROI used to calculate DVH specified by ROI Number (3006,0022) in Structure Set ROI Sequence (3006,0020) in Structure Set Module within RT Structure Set referenced by referenced RT Plan in Referenced RT Plan Sequence (300C,0002) in RT Dose Module.

Parameters:

strReferencedROINumber - String value of Referenced ROI Number

getReferencedROINumber

public java.lang.String getReferencedROINumber()

Retrieves Referenced ROI Number . Uniquely identifies ROI used to calculate DVH specified by ROI Number (3006,0022) in Structure Set ROI Sequence (3006,0020) in Structure Set Module within RT Structure Set referenced by referenced RT Plan in Referenced RT Plan Sequence (300C,0002) in RT Dose Module.

Returns:

String - value of Referenced ROI Number.

setDVHROIContributionType

public void setDVHROIContributionType(EnumDVHROIContributionType enumDVHROIContributionType)

Sets whether volume within ROI is included or excluded in DVH.

Parameters:

enumDVHROIContributionType - Enum value of DVH ROI Contribution Type

getDVHROIContributionType

public java.lang.String getDVHROIContributionType()

Retrieves whether volume within ROI is included or excluded in DVH.

Returns:

String - value of DVH ROI Contribution Type.

validateForModule

public boolean validateForModule()
                          throws InvalidItemException

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