LibStatGen: GLF: Difference between revisions

From Genome Analysis Wiki
Jump to navigationJump to search
No edit summary
Line 10: Line 10:
! Class Name !!  Description
! Class Name !!  Description
|-
|-
| <code>[http://www.sph.umich.edu/csg/mktrost/doxygen/classGlfFile.html GlfFile]</code>
| <code>[http://www.sph.umich.edu/csg/mktrost/doxygen/current/classGlfFile.html GlfFile]</code>
| Class used for reading/writing GLF files and their headers, section headers, and records.
| Class used for reading/writing GLF files and their headers, section headers, and records.
|-
|-
| <code>[http://www.sph.umich.edu/csg/mktrost/doxygen/classGlfHeader.html GlfHeader]</code>
| <code>[http://www.sph.umich.edu/csg/mktrost/doxygen/current/classGlfHeader.html GlfHeader]</code>
| Class used for storing the header.  Allows access for getting and setting header values when both reading & writing GLF files.
| Class used for storing the header.  Allows access for getting and setting header values when both reading & writing GLF files.
|-
|-
| <code>[http://www.sph.umich.edu/csg/mktrost/doxygen/classGlfRefSection.html GlfRefSection]</code>
| <code>[http://www.sph.umich.edu/csg/mktrost/doxygen/current/classGlfRefSection.html GlfRefSection]</code>
| Class used for storing the GLF Reference Section.  Allows access for getting and setting values when both reading & writing GLF files.
| Class used for storing the GLF Reference Section.  Allows access for getting and setting values when both reading & writing GLF files.
|-
|-
| <code>[http://www.sph.umich.edu/csg/mktrost/doxygen/classGlfRecord.html GlfRecord]</code>
| <code>[http://www.sph.umich.edu/csg/mktrost/doxygen/current/classGlfRecord.html GlfRecord]</code>
| Class used for storing a GLF Record.  Allows access for getting and setting record values when both reading & writing GLF files.
| Class used for storing a GLF Record.  Allows access for getting and setting record values when both reading & writing GLF files.
|-
|-
| <code>[http://www.sph.umich.edu/csg/mktrost/doxygen/classGlfStatus.html GlfStatus]</code>
| <code>[http://www.sph.umich.edu/csg/mktrost/doxygen/current/classGlfStatus.html GlfStatus]</code>
| Status value used by the glf classes for returning the status of the operations.
| Status value used by the glf classes for returning the status of the operations.
|-
|-
| <code>[http://www.sph.umich.edu/csg/mktrost/doxygen/classGlfException.html GlfException]</code>
| <code>[http://www.sph.umich.edu/csg/mktrost/doxygen/current/classGlfException.html GlfException]</code>
| Exception class for GLF.
| Exception class for GLF.
|}
|}

Revision as of 10:02, 24 August 2011


GLF

Further documentation is coming soon.

GLF Classes

Class Name Description
GlfFile Class used for reading/writing GLF files and their headers, section headers, and records.
GlfHeader Class used for storing the header. Allows access for getting and setting header values when both reading & writing GLF files.
GlfRefSection Class used for storing the GLF Reference Section. Allows access for getting and setting values when both reading & writing GLF files.
GlfRecord Class used for storing a GLF Record. Allows access for getting and setting record values when both reading & writing GLF files.
GlfStatus Status value used by the glf classes for returning the status of the operations.
GlfException Exception class for GLF.