From Genome Analysis Wiki
Jump to navigationJump to search
956 bytes added
, 11:49, 20 May 2010
Line 1: |
Line 1: |
| = InputFile / IFILE = | | = InputFile / IFILE = |
| This is our class for file operations. It hides the underlying file structure from the user. That way code can generically open and operate on a file using the exact same interface without having to know if the file is standard, gzip, or bgzf format. | | This is our class for file operations. It hides the underlying file structure from the user. That way code can generically open and operate on a file using the exact same interface without having to know if the file is standard, gzip, or bgzf format. |
| + | |
| + | |
| + | === static Class Methods === |
| + | {| style="margin: 1em 1em 1em 0; background-color: #f9f9f9; border: 1px #aaa solid; border-collapse: collapse;" border="1" |
| + | |-style="background: #f2f2f2; text-align: center;" |
| + | ! Method Name !! Description |
| + | |- |
| + | | void InputFile::setWriteFileType(FileTypeEnum fileType) |
| + | | Set the type of file to open when opening a file for write. |
| + | Must be called prior to calling ifopen(). |
| + | |
| + | Defaults to [[C++ Class: InputFile#ClassEnums|DEFAULT]] which determines the file type from the extension when opening a file for write. |
| + | |} |
| | | |
| | | |
Line 10: |
Line 23: |
| | ***NEEDS TO BE FILLED IN*** | | | ***NEEDS TO BE FILLED IN*** |
| | ***NEEDS TO BE FILLED IN*** | | | ***NEEDS TO BE FILLED IN*** |
| + | |} |
| + | |
| + | === Class Enums === |
| + | {| style="margin: 1em 1em 1em 0; background-color: #f9f9f9; border: 1px #aaa solid; border-collapse: collapse;" border="1" |
| + | |-style="background: #f2f2f2; text-align: center;" |
| + | |
| + | ! Enum Value !! Description |
| + | |- |
| + | ! colspan="2"| enum FileTypeEnum |
| + | |- |
| + | | DEFAULT |
| + | | Use the default method for determining file type. |
| + | |- |
| + | | STD |
| + | | Standard File Type. |
| + | |- |
| + | | GZ |
| + | | Gzip File Type. |
| + | |- |
| + | | BGZF |
| + | | bgzf File Type. |
| |} | | |} |
| | | |