cdac.medinfo.sdk.dcm30_04.dicommodel.modules

Class IntravascularOCTSeriesModule

java.lang.Object

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

cdac.medinfo.sdk.dcm30_04.dicommodel.modules.IntravascularOCTSeriesModule

All Implemented Interfaces:

IModule, ICollectionIterable, java.lang.Iterable

public class IntravascularOCTSeriesModule
extends Module

\* This module describes attributes in Intravascular OCT Series Module.

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
IntravascularOCTSeriesModule(IDataSet objIDataSet) Creates Intravascular OCT Series Module with default initialization.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getModality() Retrieves Modality.
java.lang.String	getPresentationIntentType() Retrieves the intent of the images that are contained within this Series.
ReferencedPerformedProcedureStepSequence	getReferencedPerformedProcedureStepSequence() This method provides the pre-initialized object of Referenced Performed Procedure Step Sequence.
java.lang.String	getSeriesNumber() Retrieves a number that identifies the Series.
ISingleCollection<ITag>	getVectorOfKeys() This method returns the collection of keys representing the DataElements that belong to this module.
void	setModality(EnumModality enumModality) Sets the modality.
void	setPresentationIntentType(EnumPresentationIntentType enumPresentationIntentType) Sets the intent of the images that are contained within this Series.
void	setSeriesNumber(java.lang.String strSeriesNumber) Sets a number that identifies the Series.
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

IntravascularOCTSeriesModule

public IntravascularOCTSeriesModule(IDataSet objIDataSet)

Creates Intravascular OCT Series Module with default initialization.

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:

true, if validate module

Throws:

InvalidModuleException - - If validation of Module fails

setModality

public void setModality(EnumModality enumModality)

Sets the modality. Type of equipment that originally acquired the data used to create the images in this Series.

Parameters:

enumModality - the enum modality

getModality

public java.lang.String getModality()

Retrieves Modality.

Returns:

String - String value of Modality.

setSeriesNumber

public void setSeriesNumber(java.lang.String strSeriesNumber)

Sets a number that identifies the Series.

Parameters:

strSeriesNumber - String value of number that identifies the Series.

getSeriesNumber

public java.lang.String getSeriesNumber()

Retrieves a number that identifies the Series.

Returns:

String - value of number that identifies the Series.

getReferencedPerformedProcedureStepSequence

public ReferencedPerformedProcedureStepSequence getReferencedPerformedProcedureStepSequence()

This method provides the pre-initialized object of Referenced Performed Procedure Step Sequence.

Returns:

- object of Referenced Performed Procedure Step 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

setPresentationIntentType

public void setPresentationIntentType(EnumPresentationIntentType enumPresentationIntentType)

Sets the intent of the images that are contained within this Series. Enumerated Values: FOR PRESENTATION, FOR PROCESSING.

Parameters:

enumPresentationIntentType - the enum presentation intent type

getPresentationIntentType

public java.lang.String getPresentationIntentType()

Retrieves the intent of the images that are contained within this Series.

Returns:

- String value of Presentation Intent Type.

getVectorOfKeys

public ISingleCollection<ITag> getVectorOfKeys()

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

Overrides:

getVectorOfKeys in class Module

Returns:

Collection of Tags - returns the collection containing the tags