cdac.medinfo.sdk.dcm30_04.dicommodel.modules

Class RTSeriesModule

java.lang.Object

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

cdac.medinfo.sdk.dcm30_04.dicommodel.modules.RTSeriesModule

All Implemented Interfaces:

IModule, ICollectionIterable, java.lang.Iterable

public class RTSeriesModule
extends Module

The RT Series Module has been created to satisfy the requirements of the standard DICOM Query/Retrieve model while including only those attributes relevant to the identification and selection of radiotherapy objects.

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
RTSeriesModule(IDataSet objIDataSet)

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getModality() Retrieves the Modality.
java.lang.String[]	getOperatorsName() Retrieves Name(s) of the operator(s) supporting the Series
PerformedProcedureStepSummaryMacro	getPerformedProcedureStepSummaryMacro() Returns instance of PerformedProcedureStepSummaryMacro
ReferencedPerformedProcedureStepSequence	getReferencedPerformedProcedureStepSequence() Retrieves the pre-initialized 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
RequestAttributesSequence	getRequestAttributesSequence() Retrieves the pre-initialized object of Request Attributes 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	getSeriesDate() Retrieves SeriesDate
java.lang.String	getSeriesDescription() Retrieves the User provided description of the Series.
SeriesDescriptionCodeSequence	getSeriesDescriptionCodeSequence() Retrieves the pre-initialized object of Series Description CodeSequence.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	getSeriesInstanceUID() Retrieves the Unique identifier of the series.
java.lang.String	getSeriesNumber() Retrieves number that identifies this series.
java.lang.String	getSeriesTime() Retrieves Time the Series started.
ISingleCollection<ITag>	getVectorOfKeys() Retrieves the vector containing the list of DataElements.
void	setModality(EnumModality enumModality) Sets the Modality in General Series Module.
void	setOperatorsName(java.lang.String[] strTimeOfLastCalibration) Sets Name(s) of the operator(s) supporting the Series
void	setSeriesDate(java.lang.String strSeriesDate) Sets SeriesDate
void	setSeriesDescription(java.lang.String strSeriesDescription) Sets the User provided description of the Series.
void	setSeriesInstanceUID(java.lang.String strSeriesInstanceUID) Sets the Unique identifier of the series.
void	setSeriesNumber(java.lang.String strSeriesNumber) Sets number that identifies this series.
void	setSeriesTime(java.lang.String strSeriesTime) Sets Time the Series started.
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

RTSeriesModule

public RTSeriesModule(IDataSet objIDataSet)

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

setModality

public void setModality(EnumModality enumModality)

Sets the Modality in General Series Module. Enumerated Values: RTIMAGE = RT Image RTDOSE = RT Dose RTSTRUCT = RT Structure Set RTPLAN = RT Plan RTRECORD = RT Treatment Record

Parameters:

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

getModality

public java.lang.String getModality()

Retrieves the Modality.

Returns:

- String value of Modality.

setSeriesInstanceUID

public void setSeriesInstanceUID(java.lang.String strSeriesInstanceUID)

Sets the Unique identifier of the series.

Parameters:

strSeriesInstanceUID - - String value of Unique identifier of the Series.

getSeriesInstanceUID

public java.lang.String getSeriesInstanceUID()

Retrieves the Unique identifier of the series.

Returns:

String - String value of Unique identifier of the Series.

setSeriesNumber

public void setSeriesNumber(java.lang.String strSeriesNumber)

Sets number that identifies this series.

Parameters:

strSeriesNumber - - String value of Series Number.

getSeriesNumber

public java.lang.String getSeriesNumber()

Retrieves number that identifies this series.

Returns:

strSeriesNumber - String value of Series Number.

setSeriesDate

public void setSeriesDate(java.lang.String strSeriesDate)

Sets SeriesDate

Parameters:

strSeriesDate - String value of SeriesDate

getSeriesDate

public java.lang.String getSeriesDate()

Retrieves SeriesDate

Returns:

String - value ofSeriesDate

setSeriesTime

public void setSeriesTime(java.lang.String strSeriesTime)

Sets Time the Series started.

Parameters:

strSeriesTime - String value of Time the Series started.

getSeriesTime

public java.lang.String getSeriesTime()

Retrieves Time the Series started.

Returns:

String - value of Time the Series started.

setSeriesDescription

public void setSeriesDescription(java.lang.String strSeriesDescription)

Sets the User provided description of the Series.

Parameters:

strSeriesDescription - - String value of Series Description.

getSeriesDescription

public java.lang.String getSeriesDescription()

Retrieves the User provided description of the Series.

Returns:

strSeriesDescription - String value of Series Description.

getSeriesDescriptionCodeSequence

public SeriesDescriptionCodeSequence getSeriesDescriptionCodeSequence()

Retrieves the pre-initialized object of Series Description CodeSequence.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:

objSeriesDescriptionCodeSequence - object of Series Description CodeSequence.

setOperatorsName

public void setOperatorsName(java.lang.String[] strTimeOfLastCalibration)

Sets Name(s) of the operator(s) supporting the Series

Parameters:

strOperatorsName - String array of Name(s) of the operator(s) supporting the Series

getOperatorsName

public java.lang.String[] getOperatorsName()

Retrieves Name(s) of the operator(s) supporting the Series

Returns:

String - value of Name(s) of the operator(s) supporting the Series

getReferencedPerformedProcedureStepSequence

public ReferencedPerformedProcedureStepSequence getReferencedPerformedProcedureStepSequence()

Retrieves the pre-initialized 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

Returns:

objReferencedPerformedProcedureStepSequence - object of Referenced Performed Procedure Step Sequence.

getRequestAttributesSequence

public RequestAttributesSequence getRequestAttributesSequence()

Retrieves the pre-initialized object of Request Attributes 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:

objRequestAttributesSequence - object of Performed Protocol Code Sequence.

getPerformedProcedureStepSummaryMacro

public PerformedProcedureStepSummaryMacro getPerformedProcedureStepSummaryMacro()

Returns instance of PerformedProcedureStepSummaryMacro

Returns:

Instance of PerformedProcedureStepSummaryMacro

getVectorOfKeys

public ISingleCollection<ITag> getVectorOfKeys()

Retrieves the vector containing the list of DataElements. Image Module specified by DICOM Standard.

Overrides:

getVectorOfKeys in class Module

Returns:

ISingleCollection - custom collection containing the list of DataElements.