The IGDACCDFFile interface provides read-only access to chip description (CDF)
files. The CDF file contains layout information about an Affymetrix GeneChip probe
array. The layout information describes which probes belong to probe sets on the
arrray. Intensity data is not stored in the CDF file and thus are not available
from objects retrieved from this class.
COM
ATTRIBUTES
Attribute
Type/Supported
Threading model
Both
Interface
Dual
Aggregation
No
ISupportErrorInfo
Yes
Connection Points
No
Free Threading Marshaler
No
PROPERTIES
ChipType
ID
1
Description
The probe array type which is used to identify the CDF file. This value must
be set prior to reading the CDF file.
Type
BSTR
Length
32
characters
Access
Read-Write
Remarks
The CDF file name is ChipType.CDF. For example, Hu6800.CDF.
LibPath
ID
2
Description
The directory where the the library files (CDF) are stored. If the requesting
CDF file is stored within a LIMS/GCOS server system the format of this property
must be "\\<<server_name>>\gclims\library" where <<server_name>>
is the name of the LIMS or GCOS server.
Type
BSTR
Access
Read-Write
Remarks
Must be set before using the interface.
FullPathName
ID
3
Description
The full name for the CDF file.
Type
BSTR
Access
Read-only
Remarks
The property value is set after specifying the ChipType
and LibPath
properties.
Date
ID
4
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 CDF file has not
been read.
Rows
ID
5
Description
This is the number of features in the y direction of the array.
Type
long
Access
Read-only
Remarks
Read() must
be called prior to use. Returns 0 if the CDF file has not been read.
Cols
ID
6
Description
This is the number of features in the x direction of the array.
Type
long
Access
Read-only
Remarks
Read() must
be called prior to use. Returns 0 the CDF file has not been read.
NumProbeSets
ID
7
Description
This is the number of probe sets on the array, not including the control probe
sets.
Type
long
Access
Read-only
Remarks
Read() must
be called prior to use. Returns 0 if the CDF file has not been read.
NumQCProbeSets
ID
8
Description
This is the number of control probe sets in the array.
Type
long
Access
Read-only
Remarks
Read() must
be called prior to use. Returns 0 if the CDF file has not been read.
FilterQCType
ID
9
Description
This value is used to filter on the type of control probe set to load.
long
nIndex - The index of the probe set (input). Must be between 0 and the number
of probe sets loaded (i.e. NumProbeSetsLoaded
property) IGDACProbeSet
*iProbeSet - ProbeSet object (input/output)
Return
HRESULT
- S_OK if successful, E_FAIL otherwise
Remarks
LoadProbeSets()
must be called prior to use. The contents of the IGDACProbeSet
object will be reset if the CDF filehas not been read.
The user has to create
the IGDACProbeSet object
instance before passing into the method.
GetProbeSets
ID
16
Description
Returns
an array of expression or control probe sets.
Prototype
HRESULT
GetProbeSets(VARIANT *iProbeSets)
Parameters
VARIANT
*iProbeSets - _variant_t pointer to objects (input/output)
Return
HRESULT
- S_OK if successful or E_FAIL otherwise.
Remarks
LoadProbeSets()
must be called prior to use. The variant will be returned empty (i.e. VT_EMPTY)
if the CDF file has not been read.
This method will create an individual
IGDACProbeSet instance
for each probe set element and add it to the output variant array. The user can
use the NumProbeSetsLoaded
to get the total number of probe sets available and iterate the variant array.
It is required to destroy each object inside the array after use.
GetCustomSeqProbeSet
ID
17
Description
Returns
a single CustomSeq probe set given an index value between 0 and the number of
probe sets - 1.
long nIndex - The index to the probe set. Must be between 0 and the number of
probe sets loaded (input) IGDACCustomSeqProbeSet
*iProbeSet - The probe set data (intput/output).
VARIANT *iProbeSets - _variant_t pointer to objects (input/output)
Return
HRESULT
- S_OK if successful or E_FAIL otherwise.
Remarks
LoadProbeSets()
must be called prior to use. The variant will be returned empty (i.e. VT_EMPTY)
if the CDF file has not been read.
This method will create an individual
IGDACCustomSeqProbeSet
instance for each probe set element and add it to the output variant array. The
user can use the NumProbeSetsLoaded
to get the total number of probe sets available and iterate the variant array.
It is required to destroy each object inside the array after use.
GetGenotypeProbeSet
ID
19
Description
Returns
a single genotyping probe set given an index value between 0 and the number of
probe sets - 1.
Prototype
HRESULT
GetGenotypeProbeSet([in] long nIndex, [in] IGDACGenotypeProbeSet
*iProbeSet)
Parameters
long nIndex - The index to the probe set. Must be between 0 and the number of
probe sets loaded (input) IGDACGenotypeProbeSet
*iProbeSet - The probe set data (intput/output).
VARIANT *iProbeSets - _variant_t pointer to objects (input/output)
Return
HRESULT
- S_OK if successful or E_FAIL otherwise.
Remarks
LoadProbeSets()
must be called prior to use. The variant will be returned empty (i.e. VT_EMPTY)
if the CDF file has not been read.
This method will create an individual
IGDACGenotypeProbeSet
instance for each probe set element and add it to the output variant array. The
user can use the NumProbeSetsLoaded
to get the total number of probe sets available and iterate the variant array.
It is required to destroy each object inside the array after use.
GetControlProbeSet
ID
21
Description
Returns
a single control probe set given an index value between 0 and the number of control
probe sets - 1.
Prototype
HRESULT
GetControlProbeSet([in] long nIndex, [in] IGDACControlProbeSet
*iProbeSet)
Parameters
long nIndex - The index to the probe set. Must be between 0 and the number of
probe sets loaded (input) IGDACControlProbeSet
*iProbeSet - The probe set data (intput/output).
Return
HRESULT
- S_OK if successful or E_FAIL otherwise.
Remarks
LoadProbeSets()
must be called prior to use. The contents of the IGDACControlProbeSet
object will be reset if the CDF file has not been read.
The user has to
create the IGDACControlProbeSet
object instance before passing into the method.
VARIANT *iProbeSets - _variant_t pointer to objects (input/output)
Return
HRESULT
- S_OK if successful or E_FAIL otherwise.
Remarks
LoadProbeSets()
must be called prior to use. The variant will be returned empty (i.e. VT_EMPTY)
if the CDF file has not been read.
This method will create an individual
IGDACControlProbeSet
instance for each probe set element and add it to the output variant array. The
user can use the NumProbeSetsLoaded
to get the total number of probe sets available and iterate the variant array.
It is required to destroy each object inside the array after use.
GetProbeSetType
ID
23
Description
This
function retreives the type of probe set stored at the input index after the LoadProbeSets
function has been called.
