FirteX－高性能全文索引和检索平台

API Documentation

首页 | 名字空间列表 | 类继承关系 | 组合类型列表 | $(BL\录(B | 文件列表 | 名字空间成员 | 组合类型成员 | 文件成员

firtex::utility::CReader类参考

#include <Reader.h>

继承图，类firtex::utility::CReader

firtex::utility::CFileReader firtex::utility::CStringReader 所有成员的列表。

公有成员

 CReader (char *buffer, size_t buffsize)
 CReader (size_t buffsize=0)
virtual ~CReader (void)
void read (char *data, size_t length)
char * readWithNoCopy (size_t &length)
virtual void close ()
int64_t getFilePointer ()
void seek (int64_t pos)
virtual bool isEof ()
int64_t length ()
virtual CReader * clone (char *buffer, size_t buffsize)=0
virtual CReader * clone ()=0

保护成员

virtual void seekInternal (int64_t position)=0
virtual void readInternal (char *b, size_t offset, size_t length)=0
void refill ()

保护属性

char * m_buffer
size_t m_bufferSize
int64_t m_bufferStart
size_t m_bufferLength
size_t m_bufferPosition
int64_t m_length
bool m_bOwnBuff

构造及析构函数文档

firtex::utility::CReader::CReader (  char *  buffer,
size_t  buffsize
) 
 

firtex::utility::CReader::CReader (  size_t  buffsize = 0  ) 
 

virtual firtex::utility::CReader::~CReader (  void   )  [virtual]
 

成员函数文档

virtual CReader* firtex::utility::CReader::clone (   )  [pure virtual]
 

克隆一个CReader对象,克隆对象使用自己私有的内存作为缓冲

在firtex::utility::CFileReader及firtex::utility::CStringReader内被实现。

virtual CReader* firtex::utility::CReader::clone (  char *  buffer,
size_t  buffsize
)  [pure virtual]
 

克隆一个CReader对象,克隆对象使用buffer作为缓冲

在firtex::utility::CFileReader及firtex::utility::CStringReader内被实现。

virtual void firtex::utility::CReader::close (   )  [virtual]
 

关闭文件，子类需实现

被firtex::utility::CFileReader重载。

int64_t firtex::utility::CReader::getFilePointer (   )  [inline]
 

返回在文件中的当前位置，下一次读从这个位置开始

virtual bool firtex::utility::CReader::isEof (   )  [inline, virtual]
 

判断文件数据是否读完毕

int64_t firtex::utility::CReader::length (   )  [inline]
 

返回文件长度

void firtex::utility::CReader::read (  char *  data,
size_t  length
) 
 

读取数据块

参数:
data 目标数据块首地址
length 目标数据块大小

virtual void firtex::utility::CReader::readInternal (  char *  b,
size_t  offset,
size_t  length
)  [protected, pure virtual]
 

从文件中当前位置读数据，子类需实现此函数

参数:
b 目标地址
offset 偏移量 长度

在firtex::utility::CFileReader及firtex::utility::CStringReader内被实现。

char* firtex::utility::CReader::readWithNoCopy (  size_t &  length  ) 
 

直接读取数据块,没有数据拷贝

参数:
length 数据块大小
返回:
数据块首地址

void firtex::utility::CReader::refill (   )  [inline, protected]
 

从文件中中读数据填充到缓冲区中

void firtex::utility::CReader::seek (  int64_t  pos  ) 
 

设置文件的当前读位置，下一次读从这个位置开始

参数:
pos 定位的位置

virtual void firtex::utility::CReader::seekInternal (  int64_t  position  )  [protected, pure virtual]
 

实现文件定位操作，readInternal的读操作从这个位置开始，需子类实现

参数:
pos 定位位置

在firtex::utility::CFileReader及firtex::utility::CStringReader内被实现。

成员数据文档

bool firtex::utility::CReader::m_bOwnBuff [protected]
 

char* firtex::utility::CReader::m_buffer [protected]
 

size_t firtex::utility::CReader::m_bufferLength [protected]
 

size_t firtex::utility::CReader::m_bufferPosition [protected]
 

size_t firtex::utility::CReader::m_bufferSize [protected]
 

int64_t firtex::utility::CReader::m_bufferStart [protected]
 

int64_t firtex::utility::CReader::m_length [protected]
 

该类的文档由以下文件生成：

http://www.firtex.org http://www.sourceforge.net/projects/firtex