cdac.medinfo.sdk.dcm30_04.dicommodel.modules

Class StudyAcquisitionModule

java.lang.Object

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

cdac.medinfo.sdk.dcm30_04.dicommodel.modules.StudyAcquisitionModule

All Implemented Interfaces:

IModule, ICollectionIterable, java.lang.Iterable

public class StudyAcquisitionModule
extends Module

\* This module defines the Attributes relevant to acquiring a study.

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
StudyAcquisitionModule(IDataSet objIDataSet) Instantiates a new study acquisition module.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getAcquisitionsInStudy() Retrieves Number of series in the study.
java.lang.String[]	getModalitiesInStudy() Retrieves This Attribute may take one or more of the values defined for Modality (0008,0060).
java.lang.String	getSeriesInStudy() Retrieves Number of image data acquisitions used in performing the study.
java.lang.String	getStudyArrivalDate() Retrieves Date that patient arrived at study check-in location.
java.lang.String	getStudyArrivalTime() Retrieves Time at which patient arrived at study check-in location.
java.lang.String	getStudyCompletionDate() Retrieves Date on which the acquisition of study information was completed.
java.lang.String	getStudyCompletionTime() Retrieves Time at which the acquisition of study information was completed.
java.lang.String	getStudyDate() Retrieves Date on which the acquisition of the study information was started.
java.lang.String	getStudyTime() Retrieves Time at which the acquisition of the study information was started.
java.lang.String	getStudyVerifiedDate() Retrieves Date on which the image quality for the patient examination was verified.
java.lang.String	getStudyVerifiedTime() Retrieves Time at which the image quality for the patient examination was verified.
ISingleCollection<ITag>	getVectorOfKeys() This method returns the vector of keys representing the DataElements that belong to this module.
void	setAcquisitionsInStudy(java.lang.String strAcquisitionsInStudy) Number of image data acquisitions used in performing the study.
void	setModalitiesInStudy(java.lang.String[] arrStrModalitiesInStudy) This Attribute may take one or more of the values defined for Modality (0008,0060).
void	setSeriesInStudy(java.lang.String strSeriesInStudy) Number of series in the study.
void	setStudyArrivalDate(java.lang.String strStudyArrivalDate) Sets Date that patient arrived at study check-in location.
void	setStudyArrivalTime(java.lang.String strStudyArrivalTime) Sets Time at which patient arrived at study check-in location.
void	setStudyCompletionDate(java.lang.String strStudyCompletionDate) Sets Date on which the acquisition of study information was completed.
void	setStudyCompletionTime(java.lang.String strStudyCompletionTime) Sets Time at which the acquisition of study information was completed.
void	setStudyDate(java.lang.String strStudyDate) Sets Date on which the acquisition of the study information was started.
void	setStudyTime(java.lang.String strStudyTime) Sets Time at which the acquisition of the study information was started.
void	setStudyVerifiedDate(java.lang.String strStudyVerifiedDate) Date on which the image quality for the patient examination was verified.
void	setStudyVerifiedTime(java.lang.String strStudyVerifiedTime) Time at which the image quality for the patient examination was verified.
boolean	validateModule() Validates the Module's DataElement according to Dicom Standard.

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

StudyAcquisitionModule

public StudyAcquisitionModule(IDataSet objIDataSet)

Instantiates a new study acquisition module.

Parameters:

objIDataSet - the obj i data set

Method Detail

validateModule

public boolean validateModule()
                       throws InvalidModuleException

Description copied from interface: IModule

Validates the Module's DataElement according to Dicom Standard.

Specified by:

validateModule in interface IModule

Specified by:

validateModule in class Module

Returns:

boolean - shows status as success or failure.

Throws:

InvalidModuleException

setStudyArrivalDate

public void setStudyArrivalDate(java.lang.String strStudyArrivalDate)

Sets Date that patient arrived at study check-in location.

Parameters:

strStudyArrivalDate - String value of Study Arrival Date.

setStudyArrivalTime

public void setStudyArrivalTime(java.lang.String strStudyArrivalTime)

Sets Time at which patient arrived at study check-in location.

Parameters:

strStudyArrivalTime - String value of Study Arrival Time.

setStudyDate

public void setStudyDate(java.lang.String strStudyDate)

Sets Date on which the acquisition of the study information was started.

Parameters:

strStudyDate - String value of Study Date.

setStudyTime

public void setStudyTime(java.lang.String strStudyTime)

Sets Time at which the acquisition of the study information was started.

Parameters:

strStudyTime - String value of Study time.

setStudyCompletionDate

public void setStudyCompletionDate(java.lang.String strStudyCompletionDate)

Sets Date on which the acquisition of study information was completed.

Parameters:

strStudyCompletionDate - String value of Study Completion Date.

setStudyCompletionTime

public void setStudyCompletionTime(java.lang.String strStudyCompletionTime)

Sets Time at which the acquisition of study information was completed.

Parameters:

strStudyCompletionTime - String value of Study Completion Time.

setStudyVerifiedDate

public void setStudyVerifiedDate(java.lang.String strStudyVerifiedDate)

Date on which the image quality for the patient examination was verified.

Parameters:

strStudyVerifiedDate - String value of Study Verified Date.

setStudyVerifiedTime

public void setStudyVerifiedTime(java.lang.String strStudyVerifiedTime)

Time at which the image quality for the patient examination was verified.

Parameters:

strStudyVerifiedTime - String value of Study Verified Time.

setModalitiesInStudy

public void setModalitiesInStudy(java.lang.String[] arrStrModalitiesInStudy)

This Attribute may take one or more of the values defined for Modality (0008,0060).

Parameters:

arrStrModalitiesInStudy - String array of Modalities In Study.

setSeriesInStudy

public void setSeriesInStudy(java.lang.String strSeriesInStudy)

Number of series in the study.

Parameters:

strSeriesInStudy - String value of Series In Study.

setAcquisitionsInStudy

public void setAcquisitionsInStudy(java.lang.String strAcquisitionsInStudy)

Number of image data acquisitions used in performing the study.

Parameters:

strAcquisitionsInStudy - String value of Acquisition in study.

getStudyArrivalDate

public java.lang.String getStudyArrivalDate()

Retrieves Date that patient arrived at study check-in location.

Returns:

String - String value of Study Arrival Date

getStudyArrivalTime

public java.lang.String getStudyArrivalTime()

Retrieves Time at which patient arrived at study check-in location.

Returns:

String - String value of Study Arrival Time

getStudyDate

public java.lang.String getStudyDate()

Retrieves Date on which the acquisition of the study information was started.

Returns:

String - String value of Study Date

getStudyTime

public java.lang.String getStudyTime()

Retrieves Time at which the acquisition of the study information was started.

Returns:

String - String value of Study Time

getStudyCompletionDate

public java.lang.String getStudyCompletionDate()

Retrieves Date on which the acquisition of study information was completed.

Returns:

String - String value of Study Completion Date

getStudyCompletionTime

public java.lang.String getStudyCompletionTime()

Retrieves Time at which the acquisition of study information was completed.

Returns:

String - String value of Study Completion Time

getStudyVerifiedDate

public java.lang.String getStudyVerifiedDate()

Retrieves Date on which the image quality for the patient examination was verified.

Returns:

String - String value of Study Verified Date

getStudyVerifiedTime

public java.lang.String getStudyVerifiedTime()

Retrieves Time at which the image quality for the patient examination was verified.

Returns:

String - String value of Study Verified Time.

getModalitiesInStudy

public java.lang.String[] getModalitiesInStudy()

Retrieves This Attribute may take one or more of the values defined for Modality (0008,0060).

Returns:

String[] - String array of Modalities In Study.

getAcquisitionsInStudy

public java.lang.String getAcquisitionsInStudy()

Retrieves Number of series in the study.

Returns:

String - String value of Acquisitions In Study.

getSeriesInStudy

public java.lang.String getSeriesInStudy()

Retrieves Number of image data acquisitions used in performing the study.

Returns:

String - String value of Series In Study.

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