cdac.medinfo.sdk.dcm30_04.dicommodel.modules

Class StructureSetModule

java.lang.Object

cdac.medinfo.sdk.dcm30_04.dicommodel.modules.Module

cdac.medinfo.sdk.dcm30_04.dicommodel.modules.StructureSetModule

All Implemented Interfaces:

IModule, ICollectionIterable, java.lang.Iterable

public class StructureSetModule
extends Module

A structure set defines a set of areas of significance. Each area can be associated with a Frame of Reference and zero or more images.

Field Summary

Fields

Modifier and Type	Field and Description
static ISingleCollection<ITag>	objSingleCollection The obj single collection.

Constructor Summary

Constructors

Constructor and Description
StructureSetModule(IDataSet objIDataSet) Instantiates a new structure set module.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getInstanceNumber() Retrieves Instance Number.
PredecessorStructureSetSequence	getPredecessorStructureSetSequence() Introduces sequence of Predecessor Structure Set
ReferencedFrameofReferenceSequence	getReferencedFrameofReferenceSequence() Retrieves sequence of items describing Frames of Reference in which the ROIs are defined.
java.lang.String	getStructureSetDate() Retrieves Structure Set Date.
java.lang.String	getStructureSetDescription() Retrieves Structure Set Description.
java.lang.String	getStructureSetLabel() Retrieves Structure Set Label.
java.lang.String	getStructureSetName() Retrieves Structure Set Name.
StructureSetROISequence	getStructureSetROISequence() Introduces sequence of ROIs for current Structure Set.
java.lang.String	getStructureSetTime() Retrieves Structure Set Time.
ISingleCollection<ITag>	getVectorOfKeys() This method returns the vector of keys representing the DataElements that belong to this module.
void	setInstanceNumber(java.lang.String strInstanceNumber) Sets Instance Number.
void	setStructureSetDate(java.lang.String strStructureSetDate) Sets Structure Set Date.
void	setStructureSetDescription(java.lang.String strStructureSetDescription) Sets Structure Set Description.
void	setStructureSetLabel(java.lang.String strStructureSetLabel) Sets Structure Set Label.
void	setStructureSetName(java.lang.String strStructureSetName) Sets Structure Set Name.
void	setStructureSetTime(java.lang.String strStructureSetTime) Sets Structure Set Time.
boolean	validateModule() This method validates each Attribute in the Module according to the Type of the Attribute.Attributes are of 5 types.

Methods inherited from class cdac.medinfo.sdk.dcm30_04.dicommodel.modules.Module

add, dumpDICOMInfo, getDictionaryReader, getTransferSyntax, isPresent, isPresent, iterator, remove

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

objSingleCollection

public static ISingleCollection<ITag> objSingleCollection

The obj single collection.

Constructor Detail

StructureSetModule

public StructureSetModule(IDataSet objIDataSet)

Instantiates a new structure set module.

Parameters:

objIDataSet - the obj i data set

Method Detail

validateModule

public boolean validateModule()
                       throws InvalidModuleException

This method validates each Attribute in the Module according to the Type of the Attribute.Attributes are of 5 types. Type 1,Type 2 are Mandatory: Mandatory Attributes have to present in the Module. Type 1C,2C are Conditional: Conditional Attributes' presence depend on a condition. If the condition is satisfied the Attribute has to be present. Type 3 are Optional Optional Attributes can be added as and when required.

Specified by:

validateModule in interface IModule

Specified by:

validateModule in class Module

Returns:

boolean - returns validation status as success or failure

Throws:

InvalidModuleException - - If validation of Module fails

setStructureSetLabel

public void setStructureSetLabel(java.lang.String strStructureSetLabel)

Sets Structure Set Label.

Parameters:

strStructureSetLabel - - String value of Structure Set Label.

getStructureSetLabel

public java.lang.String getStructureSetLabel()

Retrieves Structure Set Label.

Returns:

the structure set label

setStructureSetName

public void setStructureSetName(java.lang.String strStructureSetName)

Sets Structure Set Name.

Parameters:

strStructureSetName - - String value of Structure Set Name.

getStructureSetName

public java.lang.String getStructureSetName()

Retrieves Structure Set Name.

Returns:

the structure set name

setStructureSetDescription

public void setStructureSetDescription(java.lang.String strStructureSetDescription)

Sets Structure Set Description.

Parameters:

strStructureSetDescription - - String value of Structure Set Description.

getStructureSetDescription

public java.lang.String getStructureSetDescription()

Retrieves Structure Set Description.

Returns:

the structure set description

setInstanceNumber

public void setInstanceNumber(java.lang.String strInstanceNumber)

Sets Instance Number.

Parameters:

strInstanceNumber - - String value of Instance Number.

getInstanceNumber

public java.lang.String getInstanceNumber()

Retrieves Instance Number.

Returns:

the instance number

setStructureSetDate

public void setStructureSetDate(java.lang.String strStructureSetDate)

Sets Structure Set Date.

Parameters:

strStructureSetDate - - String value of Structure Set Date.

getStructureSetDate

public java.lang.String getStructureSetDate()

Retrieves Structure Set Date.

Returns:

the structure set date

setStructureSetTime

public void setStructureSetTime(java.lang.String strStructureSetTime)

Sets Structure Set Time.

Parameters:

strStructureSetTime - - String value of Structure Set Time.

getStructureSetTime

public java.lang.String getStructureSetTime()

Retrieves Structure Set Time.

Returns:

the structure set time

getReferencedFrameofReferenceSequence

public ReferencedFrameofReferenceSequence getReferencedFrameofReferenceSequence()

Retrieves sequence of items describing Frames of Reference in which the ROIs are defined.

Returns:

- instance of ReferencedFrameofReferenceSequence.

getStructureSetROISequence

public StructureSetROISequence getStructureSetROISequence()

Introduces sequence of ROIs for current Structure Set.

Returns:

- instance of StructureSetROISequence.

getPredecessorStructureSetSequence

public PredecessorStructureSetSequence getPredecessorStructureSetSequence()

Introduces sequence of Predecessor Structure Set

Returns:

- instance of StructureSetROISequence.

getVectorOfKeys

public ISingleCollection<ITag> getVectorOfKeys()

This method returns the vector of keys representing the DataElements that belong to this module.

Overrides:

getVectorOfKeys in class Module

Returns:

vector of Tags - returns the vector containing the collection of tags.