Changes

From Genome Analysis Wiki
Jump to navigationJump to search
370 bytes added ,  12:41, 19 February 2010
no edit summary
Line 34: Line 34:  
** Return Value
 
** Return Value
 
*** bool: true if there were no errors in the file, false otherwise.
 
*** bool: true if there were no errors in the file, false otherwise.
 +
** Notes:
 +
*** Invalid information is printed to cout until maxReportedErrors is hit.
 
*'''Read a FastQ Sequence From the File:''' readFastQSequence
 
*'''Read a FastQ Sequence From the File:''' readFastQSequence
 
** Parameters: NONE
 
** Parameters: NONE
 
** Return Value
 
** Return Value
*** int: FASTQ_SUCCESS if successfully read and valid, FASTQ_FAILURE if not successfully read, FASTQ_INVALID if the sequence was invalid..
+
*** int: FASTQ_SUCCESS if successfully read and valid, FASTQ_FAILURE if not successfully read, FASTQ_INVALID if the sequence was invalid.
 +
** Notes:
 +
*** Invalid information is printed to cout until maxReportedErrors is hit.
 
*'''Get the Space Type for the File:''' getSpaceType
 
*'''Get the Space Type for the File:''' getSpaceType
 
** Parameters: NONE
 
** Parameters: NONE
 
** Return Value
 
** Return Value
 
*** BaseAsciiMap::SPACETYPE: COLOR_SPACE if the file is color space (0,1,2,3,.), BASE_SPACE if the file is base space (A,C,G,T,N), BOTH_SPACE if the file is both (0,1,2,3,.,A,C,G,T,N), or UNKNOWN if it has yet to be determined.
 
*** BaseAsciiMap::SPACETYPE: COLOR_SPACE if the file is color space (0,1,2,3,.), BASE_SPACE if the file is base space (A,C,G,T,N), BOTH_SPACE if the file is both (0,1,2,3,.,A,C,G,T,N), or UNKNOWN if it has yet to be determined.
 
+
*'''Access last read Sequence Lines'''
 +
** Public String Variables to avoid having to copy the strings:
 +
*** mySequenceIdLine
 +
*** mySequenceIdentifier
 +
*** myRawSequence
 +
*** myPlusLine
 +
*** myQualityString
    
== Validation Criteria ==
 
== Validation Criteria ==

Navigation menu