eVision::ETopology Class Reference

ETopology aims to restrict the formats of the texts that will be returned by an ETextReader. A ETopology is composed of a list of ETopologyLine. Each entry in the list refers to the corresponding line in a text. Texts with different number of lines will therefore never be matched by the same ETopology. More...

#include <eVision/Easy/ETopology.h>

Collaboration diagram for eVision::ETopology:

Public Member Functions
	ETopology ()
	Creates a ETopology.
	ETopology (const std::vector< eVision::ETopologyLine > &lines)
	Creates a ETopology.
	ETopology (const eVision::ETopology &other)
	Creates a ETopology.
virtual	~ETopology () throw ()
eVision::ETopology &	operator= (const eVision::ETopology &other)
	Assignment operator.
bool	operator== (const eVision::ETopology &other) const
	Checks if this ETopology instance is strictly equal to another ETopology instance.
bool	IsEqual (const eVision::ETopology &other) const
	Checks if this ETopology instance is strictly equal to another ETopology instance.
void	Load (const std::string &path)
	Loads the ETopology.
void	Load (eVision::ESerializer *serializer)
	Loads the ETopology.
void	Save (const std::string &path)
	Saves the ETopology.
void	Save (eVision::ESerializer *serializer)
	Saves the ETopology.
void	SetTopologyLines (const std::vector< eVision::ETopologyLine > &lines)
	ETopology lines.
std::vector< eVision::ETopologyLine >	GetTopologyLines () const
	ETopology lines.
bool	Match (const std::string &text) const
	Returns true if the argument complies with the ETopology.
bool	Match (const eVision::EasyDeepOCR::EText &text) const
	Returns true if the argument complies with the ETopology.
bool	Match (const eVision::EasyDeepOCR::ESample &sample) const
	Returns true if the argument complies with the ETopology.
bool	Match (const eVision::EasyDeepOCR::ESampleList &samples) const
	Returns true if the argument complies with the ETopology.
	ETopology (CppWrapperInternal::InternalConstructor)

Public Attributes
CppWrapperInternal::WrappedClass	wrappedClass_

Detailed Description

ETopology aims to restrict the formats of the texts that will be returned by an ETextReader. A ETopology is composed of a list of ETopologyLine. Each entry in the list refers to the corresponding line in a text. Texts with different number of lines will therefore never be matched by the same ETopology.

License(s): BasicTypes

Constructor & Destructor Documentation

ETopology() [1/4]

eVision::ETopology::ETopology

(

)

Creates a ETopology.

ETopology() [2/4]

eVision::ETopology::ETopology

(

const std::vector< eVision::ETopologyLine > &

lines

)

Creates a ETopology.

Parameters

lines

Lines of the ETopology.

ETopology() [3/4]

eVision::ETopology::ETopology

(

const eVision::ETopology &

other

)

Creates a ETopology.

Parameters

other

Another ETopology to be copied in the new ETopology.

~ETopology()

eVision::ETopology::~ETopology ( ) throw (  )

virtual

ETopology() [4/4]

eVision::ETopology::ETopology

(

CppWrapperInternal::InternalConstructor

)

Member Function Documentation

GetTopologyLines()

std::vector< eVision::ETopologyLine > eVision::ETopology::GetTopologyLines

(

)

const

ETopology lines.

IsEqual()

bool eVision::ETopology::IsEqual

(

const eVision::ETopology &

other

)

const

Checks if this ETopology instance is strictly equal to another ETopology instance.

Parameters

other

Reference to the ETopology instance to compare with

Load() [1/2]

void eVision::ETopology::Load

(

const std::string &

path

)

Loads the ETopology.

Parameters

path	Path where to save the ETopology.

Load() [2/2]

void eVision::ETopology::Load

(

eVision::ESerializer *

serializer

)

Loads the ETopology.

Parameters

serializer

Match() [1/4]

bool eVision::ETopology::Match

(

const eVision::EasyDeepOCR::ESample &

sample

)

const

Returns true if the argument complies with the ETopology.

Parameters

sample

ESample to be checked.

Match() [2/4]

bool eVision::ETopology::Match

(

const eVision::EasyDeepOCR::ESampleList &

samples

)

const

Returns true if the argument complies with the ETopology.

Parameters

samples

ESampleList to be checked.

Match() [3/4]

bool eVision::ETopology::Match

(

const eVision::EasyDeepOCR::EText &

text

)

const

Returns true if the argument complies with the ETopology.

Parameters

text	EText or text string to be checked.

Match() [4/4]

bool eVision::ETopology::Match

(

const std::string &

text

)

const

Returns true if the argument complies with the ETopology.

Parameters

text	EText or text string to be checked.

operator=()

eVision::ETopology & eVision::ETopology::operator=

(

const eVision::ETopology &

other

)

Assignment operator.

Parameters

other

Another ETopology to be assigned in the new ETopology.

operator==()

bool eVision::ETopology::operator==

(

const eVision::ETopology &

other

)

const

Checks if this ETopology instance is strictly equal to another ETopology instance.

Parameters

other

Reference to the ETopology instance to compare with

This operator is strictly equivalent to the ETopology::IsEqual method.

Save() [1/2]

void eVision::ETopology::Save

(

const std::string &

path

)

Saves the ETopology.

Parameters

path	Path where to save the ETopology.

Save() [2/2]

void eVision::ETopology::Save

(

eVision::ESerializer *

serializer

)

Saves the ETopology.

Parameters

serializer

SetTopologyLines()

void eVision::ETopology::SetTopologyLines

(

const std::vector< eVision::ETopologyLine > &

lines

)

ETopology lines.

Member Data Documentation

wrappedClass_

CppWrapperInternal::WrappedClass eVision::ETopology::wrappedClass_