COM ATTRIBUTES

PROPERTIES

Name

ID	1
Description	The name of the DAT file without directory path.
Type	BSTR
Length	64 characters including file extension.
Access	Read-Write
Remarks	It accepts any valid short file name with no path specified (e.g. Hu6800.DAT). If path is specified when setting the Name property, a COM error will be thrown. However, the DataPath property must be set to identify the exact location of the image file. Returns error if setting invalid file name characters: \/:;*?"<>|'`,{}[]Throw COM error if file name is not with ".DAT" extension. Returns error if file name is not with “.DAT” extension

DataPath

ID	2
Description	The directory where the CHP files are stored.
Type	BSTR
Access	Read-Write
Remarks	Must be set prior to using the interface methods. Returns error if setting Invalid path characters: /;*?<>|'`,{}[] The format of the data path, when reading data stored in a LIMS/GCOS server system, must be \\SERVERNAME\gclims\data where SERVERNAME is the name of the LIMS or GCOS server.

LibPath

ID	3
Description	The directory where the the library files (CDF) are stored.
Type	BSTR
Access	Read-Write
Remarks	Must be set prior to using the interface methods. Returns error if setting invalid file name characters: \/:;*?"<>|'`,{}[] The format of the library path, when reading data stored in a LIMS/GCOS server system, must be \\SERVERNAME\gclims\library where SERVERNAME is the name of the LIMS or GCOS server.

FullPathName

ID	4
Description	The full path file name for the image file.
Type	BSTR
Access	Read-only
Remarks	The property value is set after specifying the Name and DataPath properties.

ChipType

ID	5
Description	The probe array type associated with the image file.
Type	BSTR
Access	Read-only
Remarks	Read() must be called prior to use. Returns an empty string if the image file header has not been read.

Date

ID	6
Description	The file creation timestamp.
Type	BSTR
Format	MMM DD YYYY HH:MM:SS AM/PM
Access	Read-only
Remarks	Read() must be called prior to use. Returns an empty string if the image file header has not been read.

NumPixelsPerRow

ID	7
Description	The number of pixels per row in the image file.
Type	long
Access	Read-only
Remarks	Read() must be called prior to use. Returns 0 if the image file header has not been read.

NumRows

ID	8
Description	The number of rows of pixels in the file.
Type	long
Access	Read-only
Remarks	Read() must be called prior to use. Returns 0 if the image file header has not been read.

MinData

ID	9
Description	The minimum pixel value in the image.
Type	long
Access	Read-only
Remarks	Read() must be called prior to use. Returns 0 if the image file header has not been read.

MaxData

ID	10
Description	The maximum pixel value in the image.
Type	long
Access	Read-only
Remarks	Read() must be called prior to use. Returns 0 if the image file header has not been read.

PixelSize

ID	11
Description	The size of the pixel, in microns, used to create the file.
Type	long
Access	Read-only
Remarks	Read() must be called prior to use. Returns 0 if the image file header has not been read.

CellMargin

ID	12
Description	The number of pixels for the border of each feature when calculating the CEL intensities.
Type	long
Access	Read-only
Remarks	Read() must be called prior to use. Returns 0 if the image file header has not been read.

ScanSpeed

ID	13
Description	The scan speed.
Type	long
Access	Read-only
Remarks	Read() must be called prior to use. Returns 0 if the image file header has not been read.

ScanDate

ID	14
Description	The scan date.
Type	BSTR
Format	MMM DD YYYY HH:MM:SS AM/PM
Access	Read-only
Remarks	Read() must be called prior to use. Returns 0 if the image file header has not been read.

ScannerID

ID	15
Description	The ID of the scanner if set on the MAS instrument workstation.
Type	BSTR
Access	Read-only
Remarks	Read() must be called prior to use. Returns an empty string if the image file header has not been read.

UpperLeftX

ID	16
Description	The upper-left x-position of the grid corner of the image file
Type	long
Access	Read-only
Remarks	Read() must be called prior to use. Returns 0 if the image file header has not been read.

UpperLeftY

ID	17
Description	The upper-left y-position of the grid corner of the image file
Type	long
Access	Read-only
Remarks	Read() must be called prior to use. Returns 0 if the image file header has not been read.

UpperRightX

ID	18
Description	The upper-right x-position of the grid corner of the image file
Type	long
Access	Read-only
Remarks	Read() must be called prior to use. Returns 0 if the image file header has not been read.

UpperRightY

ID	19
Description	The upper-right y-position of the grid corner of the image file
Type	long
Access	Read-only
Remarks	Read() must be called prior to use. Returns 0 if the image file header has not been read.

LowerLeftX

ID	20
Description	The lower-left x-position of the grid corner of the image file
Type	long
Access	Read-only
Remarks	Read() must be called prior to use. Returns 0 if the image file header has not been read.

LowerLeftY

ID	21
Description	The lower-left y-position of the grid corner of the image file
Type	long
Access	Read-only
Remarks	Read() must be called prior to use. Returns 0 if the image file header has not been read.

LowerRightX

ID	22
Description	The lower-right x-position of the grid corner of the image file
Type	long
Access	Read-only
Remarks	Read() must be called prior to use. Returns 0 if the image file header has not been read.

LowerRightY

ID	23
Description	The lower-right y-position of the grid corner of the image file
Type	long
Access	Read-only
Remarks	Read() must be called prior to use. Returns 0 if the image file header has not been read.

ServerName

ID	24
Description	The name of the LIMS server if the data resides on a LIMS system. This value should be blank if the data is not stored within a LIMS system.
Type	BSTR
Access	Read-Write
Remarks	This property must be set in LIMS Mode

NTUserName

ID	25
Description	This value is not used by the SDK.
Type	BSTR
Access	Read-Write, Reserved
Remarks	This value is not used by the SDK.

METHODS

Exists

ID	26
Description	This function returns a flag indicating if the DAT file exists within the specified data directory.
Prototype	HRESULT Exists(BOOL *pbExists)
Parameters	BOOL *pbExists - Flag indicating existence (output)
Return	HRESULT - S_OK if successful, E_FAIL otherwise
Remarks	The Name and DataPath properties are required.

Read

ID	27
Description	Reads the contents of the DAT file into memory.
Prototype	HRESULT Read( )
Parameters	N/A
Return	HRESULT - S_OK if successful, E_FAIL otherwise
Remarks	The Name, DataPath and LibPath properties are required.

ReadHeader

ID	28
Description	Reads the header of the DAT file into memory. Reading the header will populate all of the properties of this class (NumRows, NumPixelsPerRow, ChipType, etc.).
Prototype	HRESULT Read( )
Parameters	N/A
Return	HRESULT - S_OK if successful, E_FAIL otherwise
Remarks	The Name, DataPath and LibPath properties are required.

GetIntensity

ID	29
Description	This function returns the intensity at a specific position of the image file.
Prototype	HRESULT GetIntensity(long x, long y, long *pVal)
Parameters	long x - The x-coordinate of the pixel. It is 0-based and must be in between 0 and NumPixelsPerRow (input) long y - The y-coordinate of the pixel. It is 0-based and must be in between 0 and NumRows (input)unsigned short *pVal - A pointer to the data value at (x,y) (output/Return)
Return	HRESULT - S_OK if successful, E_FAIL otherwise
Remarks	Read() must be called prior to use. The intensity returned will be 65535 (USHRT_MAX) if the image file has not been read.

GetLineIntensities

ID	30
Description	This function returns the array of intensities at a specific line of the image file.
Prototype	HRESULT GetLineIntensities(long nLine, SAFEARRAY** ppsaInten)
Parameters	long nLine - The line number. It is 0-based and must be in between 0 and NumRows (input) SAFEARRAY(long)* ppsaInten - A safearray of intensity (output/Return)
Return	HRESULT - S_OK if successful, E_POINTER if ppsaInten is NULL or E_FAIL otherwise
Remarks	Read() must be called prior to use. The savearray will return empty if the image file has not been read.