Classes | Public Types | Public Member Functions | Static Public Attributes | Private Member Functions | Private Attributes

OrthographyResults Class Reference

#include <OrthographyResults.h>

List of all members.

Classes

struct  compare

Public Types

enum  SUPPORTLEVEL { UNSUPPORTED = 0, FRAGMENTARY, PARTIAL, FULL }

Public Member Functions

 OrthographyResults (const OrthographyData *pData, UINT32 hits, UINT32 tries, std::vector< UTF32 > &missing)
 OrthographyResults (const OrthographyData *pData, UINT32 hits, UINT32 tries)
 ~OrthographyResults ()
UINT32 getHits (void) const
UINT32 getTries (void) const
int getPercentCoverage (void) const
SUPPORTLEVEL getSupportLevel (void) const
const char * getSupportLevelAsCString (void) const
const char * getCommonName (void) const
const char * getNativeName (void) const
const char * getSampleCharacters (void) const
const char * getSampleSentence (int nth) const
std::string getMissingValuesAsString (void) const
std::string getReport (bool reportMissing) const
void setReportOnMissing (bool x)

Static Public Attributes

static const int minCoverage = 80

Private Member Functions

const char * UTF32ValueToUTF8 (UTF32 UTF32Value) const

Private Attributes

const OrthographyData_pData
UINT32 _hits
UINT32 _tries
SUPPORTLEVEL _supportLevel
std::vector< UTF32_missingValues
bool _reportMissing

Member Enumeration Documentation

Enumerator:
UNSUPPORTED 
FRAGMENTARY 
PARTIAL 
FULL 

Constructor & Destructor Documentation

OrthographyResults::OrthographyResults ( const OrthographyData pData,
UINT32  hits,
UINT32  tries,
std::vector< UTF32 > &  missing 
)

References _hits, _missingValues, _pData, and _tries.

OrthographyResults::OrthographyResults ( const OrthographyData pData,
UINT32  hits = 0,
UINT32  tries = 0 
)

References _hits, _pData, and _tries.

OrthographyResults::~OrthographyResults (  ) 

Member Function Documentation

const char * OrthographyResults::getCommonName ( void   )  const

References _pData, and OrthographyData::commonName.

Referenced by getReport().

UINT32 OrthographyResults::getHits ( void   )  const

References _hits.

std::string OrthographyResults::getMissingValuesAsString ( void   )  const

References _missingValues, and UTF32ValueToUTF8().

Referenced by getReport().

const char * OrthographyResults::getNativeName ( void   )  const

References _pData, and OrthographyData::nativeName.

Referenced by getReport().

int OrthographyResults::getPercentCoverage ( void   )  const

References _hits, and _tries.

Referenced by getReport().

std::string OrthographyResults::getReport ( bool  reportMissing  )  const
const char * OrthographyResults::getSampleCharacters ( void   )  const
const char * OrthographyResults::getSampleSentence ( int  nth  )  const
OrthographyResults::SUPPORTLEVEL OrthographyResults::getSupportLevel ( void   )  const

References _hits, _tries, and minCoverage.

Referenced by getReport(), and getSupportLevelAsCString().

const char * OrthographyResults::getSupportLevelAsCString ( void   )  const
UINT32 OrthographyResults::getTries ( void   )  const

References _tries.

void OrthographyResults::setReportOnMissing ( bool  x  ) 

References _reportMissing.

const char * OrthographyResults::UTF32ValueToUTF8 ( UTF32  UTF32Value  )  const [private]

Member Data Documentation

std::vector<UTF32> OrthographyResults::_missingValues [private]

Referenced by setReportOnMissing().

const int OrthographyResults::minCoverage = 80 [static]

Referenced by getSupportLevel().


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