NCBI C++ ToolKit
Classes | Macros | Typedefs | Enumerations
row_reader.hpp File Reference
#include <corelib/ncbistd.hpp>
#include <corelib/ncbifile.hpp>
#include "row_reader.inl"
+ Include dependency graph for row_reader.hpp:
+ This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Go to the SVN repository for this file.

Classes

class  CRR_FieldType< TFieldType >
 Basic or an extended field type with an added arbitrary string property. More...
 
class  CRR_Field< TTraits >
 A single field in a row abstraction. More...
 
class  CRR_Row< TTraits >
 Represents one row from an input stream. More...
 
struct  CRR_Row< TTraits >::SFieldMetaInfo
 
class  CRowReader< TTraits >
 Callback style template to iterate over a row stream. More...
 
class  CRowReader< TTraits >::CRowIterator
 A (forward-only) iterator to iterate over the rows from a stream. More...
 

Macros

#define UTIL___ROW_READER_INCLUDE__INL
 

Typedefs

typedef Uint8 TStreamPos
 Position in the data stream (zero based) More...
 
typedef Uint8 TLineNo
 Line number (in the data stream, zero based) More...
 
typedef Uint4 TFieldNo
 Field number (zero based) More...
 

Enumerations

enum  ERR_FieldType {
  eRR_String , eRR_Boolean , eRR_Integer , eRR_Double ,
  eRR_DateTime
}
 Basic field data types. More...
 
enum  ERR_RowType { eRR_Data , eRR_Comment , eRR_Metadata , eRR_Invalid }
 Row type. More...
 
enum  ERR_FieldValidationMode { eRR_NoFieldValidation , eRR_FieldValidation }
 Whether to check validity of the fields (names and/or values) More...
 

Macro Definition Documentation

◆ UTIL___ROW_READER_INCLUDE__INL

#define UTIL___ROW_READER_INCLUDE__INL

Definition at line 128 of file row_reader.hpp.

Typedef Documentation

◆ TFieldNo

typedef Uint4 TFieldNo

Field number (zero based)

Definition at line 53 of file row_reader.hpp.

◆ TLineNo

typedef Uint8 TLineNo

Line number (in the data stream, zero based)

Definition at line 50 of file row_reader.hpp.

◆ TStreamPos

typedef Uint8 TStreamPos

Position in the data stream (zero based)

Definition at line 47 of file row_reader.hpp.

Enumeration Type Documentation

◆ ERR_FieldType

Basic field data types.

Note
The row reader does not perform any data conversion by itself. It is up to the user to set a certain field type and how to use it further. The row reader merely provides a storage for the user provided field data types.
Enumerator
eRR_String 

string

eRR_Boolean 

bool

eRR_Integer 

int

eRR_Double 

double

eRR_DateTime 

CTime.

Definition at line 62 of file row_reader.hpp.

◆ ERR_FieldValidationMode

Whether to check validity of the fields (names and/or values)

Enumerator
eRR_NoFieldValidation 

don't validate fields' value and name

eRR_FieldValidation 

check that the field's value (or name) is valid

Definition at line 117 of file row_reader.hpp.

◆ ERR_RowType

Row type.

Enumerator
eRR_Data 

row contains data

eRR_Comment 

row contains a comment

eRR_Metadata 

row contains metadata

eRR_Invalid 

row is invalid

Definition at line 108 of file row_reader.hpp.

Modified on Wed May 15 15:08:56 2024 by modify_doxy.py rev. 669887