tesseract::DocumentCache Class Reference

#include <imagedata.h>

Public Member Functions
	DocumentCache (inT64 max_memory)
	~DocumentCache ()
void	Clear ()
bool	LoadDocuments (const GenericVector< STRING > &filenames, const char *lang, CachingStrategy cache_strategy, FileReader reader)
bool	AddToCache (DocumentData *data)
DocumentData *	FindDocument (const STRING &document_name) const
const ImageData *	GetPageBySerial (int serial)
const PointerVector< DocumentData > &	documents () const
int	TotalPages ()

Detailed Description

Definition at line 314 of file imagedata.h.

Constructor & Destructor Documentation

DocumentCache()

tesseract::DocumentCache::DocumentCache ( inT64  max_memory )

explicit

Definition at line 552 of file imagedata.cpp.

    : num_pages_per_doc_(0), max_memory_(max_memory) {}

~DocumentCache()

tesseract::DocumentCache::~DocumentCache

(

)

Definition at line 554 of file imagedata.cpp.

{}

Member Function Documentation

AddToCache()

bool tesseract::DocumentCache::AddToCache

(

DocumentData *

data

)

Definition at line 584 of file imagedata.cpp.

                                                 {
  inT64 new_memory = data->memory_used();
  documents_.push_back(data);
  return true;
}

Clear()

void tesseract::DocumentCache::Clear ( )

inline

Definition at line 320 of file imagedata.h.

               {
    documents_.clear();
    num_pages_per_doc_ = 0;
  }

documents()

const PointerVector<DocumentData>& tesseract::DocumentCache::documents ( ) const

inline

Definition at line 344 of file imagedata.h.

                                                       {
    return documents_;
  }

FindDocument()

DocumentData * tesseract::DocumentCache::FindDocument

(

const STRING &

document_name

)

const

Definition at line 591 of file imagedata.cpp.

                                                                           {
  for (int i = 0; i < documents_.size(); ++i) {
    if (documents_[i]->document_name() == document_name)
      return documents_[i];
  }
  return NULL;
}

GetPageBySerial()

const ImageData* tesseract::DocumentCache::GetPageBySerial ( int  serial )

inline

Definition at line 337 of file imagedata.h.

                                               {
    if (cache_strategy_ == CS_SEQUENTIAL)
      return GetPageSequential(serial);
    else
      return GetPageRoundRobin(serial);
  }

LoadDocuments()

bool tesseract::DocumentCache::LoadDocuments	(	const GenericVector< STRING > &	filenames,
		const char *	lang,
		CachingStrategy	cache_strategy,
		FileReader	reader
	)

Definition at line 558 of file imagedata.cpp.

                                                     {
  cache_strategy_ = cache_strategy;
  inT64 fair_share_memory = 0;
  // In the round-robin case, each DocumentData handles restricting its content
  // to its fair share of memory. In the sequential case, DocumentCache
  // determines which DocumentDatas are held entirely in memory.
  if (cache_strategy_ == CS_ROUND_ROBIN)
    fair_share_memory = max_memory_ / filenames.size();
  for (int arg = 0; arg < filenames.size(); ++arg) {
    STRING filename = filenames[arg];
    DocumentData* document = new DocumentData(filename);
    document->SetDocument(filename.string(), lang, fair_share_memory, reader);
    AddToCache(document);
  }
  if (!documents_.empty()) {
    // Try to get the first page now to verify the list of filenames.
    if (GetPageBySerial(0) != NULL) return true;
    tprintf("Load of page 0 failed!\n");
  }
  return false;
}

TotalPages()

int tesseract::DocumentCache::TotalPages

(

)

Definition at line 601 of file imagedata.cpp.

                              {
  if (cache_strategy_ == CS_SEQUENTIAL) {
    // In sequential mode, we assume each doc has the same number of pages
    // whether it is true or not.
    if (num_pages_per_doc_ == 0) GetPageSequential(0);
    return num_pages_per_doc_ * documents_.size();
  }
  int total_pages = 0;
  int num_docs = documents_.size();
  for (int d = 0; d < num_docs; ++d) {
    // We have to load a page to make NumPages() valid.
    documents_[d]->GetPage(0);
    total_pages += documents_[d]->NumPages();
  }
  return total_pages;
}

---

The documentation for this class was generated from the following files:

• ccstruct/imagedata.h
• ccstruct/imagedata.cpp