cdac.medinfo.sdk.dcm30_04.dicommodel.modules

Class GeneralEquipmentModule

java.lang.Object

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

cdac.medinfo.sdk.dcm30_04.dicommodel.modules.GeneralEquipmentModule

All Implemented Interfaces:

IModule, ICollectionIterable, java.lang.Iterable

public class GeneralEquipmentModule
extends Module

This class specifies the Attributes that identify and describe the piece of equipment that produces a Series of Composite Instances.

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
GeneralEquipmentModule(IDataSet objIDataSet) Instantiates a new general equipment module.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String[]	getDateOfLastCalibration() Gets the date of last calibration.
java.lang.String	getDeviceSerialNumber() Gets the device serial number.
java.lang.String	getGantryID() Gets the Gantry ID.
java.lang.String	getInstitutionAddress() Gets the institution address.
java.lang.String	getInstitutionalDepartmentName() Gets the institutional department name.
java.lang.String	getInstitutionName() Gets the institution name.
java.lang.String	getManufacturer() Gets the manufacturer.
java.lang.String	getManufacturerModelName() Gets the manufacturer model name.
short	getPixelPaddingValue() Retrieves the pixel padding value.
java.lang.String[]	getSoftwareVersions() Gets the software versions.
java.lang.String	getSpatialResolution() Gets the spatial resolution.
java.lang.String	getStationName() Gets the station name.
java.lang.String[]	getTimeOfLastCalibration() Gets the time of last calibration.
ISingleCollection<ITag>	getVectorOfKeys() This method returns the custom collection containing the list of DataElements belonging to the CT Image Module specified by DICOM Standard.
void	setDateOfLastCalibration(java.lang.String[] arrStrDateOfLastCalibration) This method is used to set Date when the image acquisition device calibration was last changed in any way.
void	setDeviceSerialNumber(java.lang.String strDeviceSerialNumber) The method is used to set Manufacturers serial number of the equipment that produced the composite instances.
void	setGantryID(java.lang.String strGantryID) Sets Gantry ID.
void	setInstitutionAddress(java.lang.String strInstitutionAddress) The method is used to set Mailing address of the institution where the equipment that produced the composite instances is located.
void	setInstitutionalDepartmentName(java.lang.String strInstitutionalDepartmentName) The method is used to set Department in the institution where the equipment that produced the composite instances is located.
void	setInstitutionName(java.lang.String strInstitutionName) The method is used to set Institution where the equipment that produced the composite instances is located.
void	setManufacturer(java.lang.String strManufacturer) The method is used to set Manufacturer of the equipment that produced the composite instances.
void	setManufacturerModelName(java.lang.String strManufacturerModelName) The method is used to Manufacturers model name of the equipment that produced the composite instances.
void	setPixelPaddingValue(short sPixelPaddingValue) Value of pixels added to non-rectangular image to pad to rectangular format.
void	setSoftwareVersions(java.lang.String[] arrStrSoftwareVersions) This method is used to set Manufacturers designation of software version of the equipment that produced the composite instances.
void	setSpatialResolution(java.lang.String strSpatialResolution) The method is used to set The inherent limiting resolution in mm of the acquisition equipment for high contrast objects for the data gathering and reconstruction technique chosen.
void	setStationName(java.lang.String strStationName) The method is used to set User defined name identifying the machine that produced the composite instances.
void	setTimeOfLastCalibration(java.lang.String[] arrStrTimeOfLastCalibration) The Method is used to set Time when the image acquisition device calibration was last changed in any way.
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

GeneralEquipmentModule

public GeneralEquipmentModule(IDataSet objIDataSet)

Instantiates a new general equipment 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:

true, if validate module

Throws:

InvalidModuleException - - If validation of Module fails

setManufacturer

public void setManufacturer(java.lang.String strManufacturer)

The method is used to set Manufacturer of the equipment that produced the composite instances. The function accepts a String Value and creates the DE based on the transfer syntax and populates the DE with right values. This De is then added to the Module HashMap

Parameters:

strManufacturer - :The name of the Manufacturer of the equipment

setInstitutionName

public void setInstitutionName(java.lang.String strInstitutionName)

The method is used to set Institution where the equipment that produced the composite instances is located. The function accepts a String Value and creates the DE based on the transfer syntax and populates the DE with right values. This De is then added to the Module HashMap

Parameters:

strInstitutionName - :The name of Institution

setInstitutionAddress

public void setInstitutionAddress(java.lang.String strInstitutionAddress)

The method is used to set Mailing address of the institution where the equipment that produced the composite instances is located. The function accepts a String Value and creates the DE based on the transfer syntax and populates the DE with right values. This De is then added to the Module HashMap

Parameters:

strInstitutionAddress - :The address of Institution

setStationName

public void setStationName(java.lang.String strStationName)

The method is used to set User defined name identifying the machine that produced the composite instances. The function accepts a String Value and creates the DE based on the transfer syntax and populates the DE with right values. This De is then added to the Module HashMap

Parameters:

strStationName - the str station name

setInstitutionalDepartmentName

public void setInstitutionalDepartmentName(java.lang.String strInstitutionalDepartmentName)

The method is used to set Department in the institution where the equipment that produced the composite instances is located. The function accepts a String Value and creates the DE based on the transfer syntax and populates the DE with right values. This De is then added to the Module HashMap

Parameters:

strInstitutionalDepartmentName - :The string value of Institutional Department Name

setManufacturerModelName

public void setManufacturerModelName(java.lang.String strManufacturerModelName)

The method is used to Manufacturers model name of the equipment that produced the composite instances. The function accepts a String Value and creates the DE based on the transfer syntax and populates the DE with right values. This De is then added to the Module HashMap

Parameters:

strManufacturerModelName - :Manufacturer Model Name

setDeviceSerialNumber

public void setDeviceSerialNumber(java.lang.String strDeviceSerialNumber)

The method is used to set Manufacturers serial number of the equipment that produced the composite instances. The function accepts a String Value and creates the DE based on the transfer syntax and populates the DE with right values. This De is then added to the Module HashMap

Parameters:

strDeviceSerialNumber - :String value of Device Serial Number

setSoftwareVersions

public void setSoftwareVersions(java.lang.String[] arrStrSoftwareVersions)

This method is used to set Manufacturers designation of software version of the equipment that produced the composite instances. The function accepts a String Value and creates the DE based on the transfer syntax and populates the DE with right values. This De is then added to the Module HashMap

Parameters:

arrStrSoftwareVersions - :StrSoftware Versions

setGantryID

public void setGantryID(java.lang.String strGantryID)

Sets Gantry ID. Identifier of the gantry or positioner.

Parameters:

strGantryID - String value of Gantry ID.

setSpatialResolution

public void setSpatialResolution(java.lang.String strSpatialResolution)

The method is used to set The inherent limiting resolution in mm of the acquisition equipment for high contrast objects for the data gathering and reconstruction technique chosen. The function accepts a String Value and creates the DE based on the transfer syntax and populates the DE with right values. This De is then added to the Module HashMap

Parameters:

strSpatialResolution - the str spatial resolution

setDateOfLastCalibration

public void setDateOfLastCalibration(java.lang.String[] arrStrDateOfLastCalibration)

This method is used to set Date when the image acquisition device calibration was last changed in any way. Multiple entries may be used for additional calibrations at other times. The function accepts a String Value and creates the DE based on the transfer syntax and populates the DE with right values. This De is then added to the Module HashMap

Parameters:

arrStrDateOfLastCalibration - :Date Of Last Calibration

setTimeOfLastCalibration

public void setTimeOfLastCalibration(java.lang.String[] arrStrTimeOfLastCalibration)

The Method is used to set Time when the image acquisition device calibration was last changed in any way. The function accepts a String Value and creates the DE based on the transfer syntax and populates the DE with right values. This De is then added to the Module HashMap

Parameters:

arrStrTimeOfLastCalibration - :Time Of Last Calibration

setPixelPaddingValue

public void setPixelPaddingValue(short sPixelPaddingValue)

Value of pixels added to non-rectangular image to pad to rectangular format. The function accepts a String Value and creates the DE based on the transfer syntax and populates the DE with right values. This De is then added to the Module HashMap

Parameters:

sPixelPaddingValue - : Pixel Padding Value

getManufacturer

public java.lang.String getManufacturer()

Gets the manufacturer.

Returns:

the manufacturer

getInstitutionName

public java.lang.String getInstitutionName()

Gets the institution name.

Returns:

the institution name

getInstitutionAddress

public java.lang.String getInstitutionAddress()

Gets the institution address.

Returns:

the institution address

getStationName

public java.lang.String getStationName()

Gets the station name.

Returns:

the station name

getInstitutionalDepartmentName

public java.lang.String getInstitutionalDepartmentName()

Gets the institutional department name.

Returns:

the institutional department name

getManufacturerModelName

public java.lang.String getManufacturerModelName()

Gets the manufacturer model name.

Returns:

the manufacturer model name

getDeviceSerialNumber

public java.lang.String getDeviceSerialNumber()

Gets the device serial number.

Returns:

the device serial number

getSoftwareVersions

public java.lang.String[] getSoftwareVersions()

Gets the software versions.

Returns:

the software versions

getGantryID

public java.lang.String getGantryID()

Gets the Gantry ID. Identifier of the gantry or positioner.

Returns:

the Gantry ID

getSpatialResolution

public java.lang.String getSpatialResolution()

Gets the spatial resolution.

Returns:

the spatial resolution

getDateOfLastCalibration

public java.lang.String[] getDateOfLastCalibration()

Gets the date of last calibration.

Returns:

the date of last calibration

getTimeOfLastCalibration

public java.lang.String[] getTimeOfLastCalibration()

Gets the time of last calibration.

Returns:

the time of last calibration

getPixelPaddingValue

public short getPixelPaddingValue()

Retrieves the pixel padding value.

Returns:

short - returns the pixel padding value

getVectorOfKeys

public ISingleCollection<ITag> getVectorOfKeys()

This method returns the custom collection containing the list of DataElements belonging to the CT Image Module specified by DICOM Standard.

Overrides:

getVectorOfKeys in class Module

Returns:

- the customized collection containing the dataelement tags that beling to this module