OrthographyResults Class Reference

#include <OrthographyResults.h>

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

enum OrthographyResults::SUPPORTLEVEL

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, _tries, and AladdinFreePublicLicense::pData.

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

References _hits, _pData, _tries, and AladdinFreePublicLicense::pData.

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

References FRAGMENTARY, FULL, getCommonName(), getMissingValuesAsString(), getNativeName(), getPercentCoverage(), getSupportLevel(), PARTIAL, and UNSUPPORTED.

const char * OrthographyResults::getSampleCharacters

(

void

)

const

References _pData, and OrthographyData::sampleCharacters.

const char * OrthographyResults::getSampleSentence

(

int

nth

)

const

References _pData, and OrthographyData::sampleSentences.

OrthographyResults::SUPPORTLEVEL OrthographyResults::getSupportLevel

(

void

)

const

References _hits, _tries, FRAGMENTARY, FULL, minCoverage, PARTIAL, and UNSUPPORTED.

Referenced by getReport(), and getSupportLevelAsCString().

const char * OrthographyResults::getSupportLevelAsCString

(

void

)

const

References FRAGMENTARY, FULL, getSupportLevel(), PARTIAL, and UNSUPPORTED.

UINT32 OrthographyResults::getTries

(

void

)

const

References _tries.

void OrthographyResults::setReportOnMissing

(

bool

x

)

References _reportMissing.

const char * OrthographyResults::UTF32ValueToUTF8 ( UTF32  UTF32Value ) const

private

Referenced by getMissingValuesAsString().

Member Data Documentation

UINT32 OrthographyResults::_hits

private

Referenced by getHits(), getPercentCoverage(), getSupportLevel(), and OrthographyResults().

std::vector<UTF32> OrthographyResults::_missingValues

private

Referenced by getMissingValuesAsString(), and OrthographyResults().

const OrthographyData* OrthographyResults::_pData

private

Referenced by getCommonName(), getNativeName(), getSampleCharacters(), getSampleSentence(), OrthographyResults::compare::operator()(), and OrthographyResults().

bool OrthographyResults::_reportMissing

private

Referenced by setReportOnMissing().

SUPPORTLEVEL OrthographyResults::_supportLevel

private

UINT32 OrthographyResults::_tries

private

Referenced by getPercentCoverage(), getSupportLevel(), getTries(), and OrthographyResults().

const int OrthographyResults::minCoverage =80

static

Referenced by getSupportLevel().

---

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

• OrthographyResults.h
• OrthographyResults.cpp