C++ Class: InputFile - Revision history

Ppwhite: /* InputFile Class Documentation */

2017-02-02T14:47:49Z

InputFile Class Documentation

← Older revision		Revision as of 10:47, 2 February 2017
Line 19:		Line 19:
	=== InputFile Class Documentation ===		=== InputFile Class Documentation ===

	See: http://~~www~~.sph.umich.edu/~~csg~~/mktrost/doxygen/current/classInputFile.html		See: http://csg.sph.umich.edu//mktrost/doxygen/current/classInputFile.html


	=== BGZF Notes ===		=== BGZF Notes ===

2017-02-02T14:47:33Z

Global IFILE Methods

← Older revision		Revision as of 10:47, 2 February 2017
Line 15:		Line 15:
	=== Global IFILE Methods ===		=== Global IFILE Methods ===

	See: http://~~www~~.sph.umich.edu/~~csg~~/mktrost/doxygen/current/InputFile_8h.html for documentation on the global IFILE methods.		See: http://csg.sph.umich.edu//mktrost/doxygen/current/InputFile_8h.html for documentation on the global IFILE methods.

	=== InputFile Class Documentation ===		=== InputFile Class Documentation ===

2011-08-24T13:23:26Z

@@ Line 14: / Line 14: @@
 === Global IFILE Methods ===
-When reading a file (not from stdin), the file compression type is determined by reading the file.
+See: http://www.sph.umich.edu/csg/mktrost/doxygen/current/InputFile_8h.html for documentation on the global IFILE methods.
-When reading from stdin and writing anywhere the file compression type is determined by the passed in parameter.
+=== InputFile Class Documentation ===
-=== Class Enums ===
+See: http://www.sph.umich.edu/csg/mktrost/doxygen/current/classInputFile.html

2011-01-07T18:48:49Z

Example

← Older revision		Revision as of 14:48, 7 January 2011
Line 97:		Line 97:
	const char* filename = "-";		const char* filename = "-";
	IFILE myFilePtr = ifopen(filename, "rb", InputFile::BGZF);		IFILE myFilePtr = ifopen(filename, "rb", InputFile::BGZF);
	if (myFilePtr != NULL)		if (myFilePtr == NULL)
	{		{
	std::cerr << "Failed to open the file\n";		std::cerr << "Failed to open the file\n";

2010-11-17T20:14:33Z

2010-11-02T05:58:26Z

@@ Line 1: / Line 1: @@
 = 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 (for reading from a file - for reading from stdin and writing, the user has to specify which type to open).
@@ Line 110: / Line 115: @@
+  }
 </source>

2010-09-29T21:50:11Z

2010-09-29T21:45:57Z

2010-09-29T21:28:39Z

← Older revision		Revision as of 17:28, 29 September 2010
Line 85:		Line 85:
	NOTE: even when reading from stdin, you MUST specify the file type. It does not read from stdin to determine the compression type like it does for other files.		NOTE: even when reading from stdin, you MUST specify the file type. It does not read from stdin to determine the compression type like it does for other files.

			'''When writing programs that will use stdout and pipes to send input from one program to the next, make sure that all error, debug, or info messages are written to stderr/cerr and not stdout/cout.'''

	=== Example ===		=== Example ===

2010-09-29T21:26:39Z

Example

@@ Line 86: / Line 86: @@
-==== Example ====
+=== Example ===
 <source lang="cpp">
   const char* filename = "-";
   IFILE myFilePtr = ifopen(filename, "rb", InputFile::BGZF);
 </source>