OPENTREP::DistanceErrorRule Struct Reference

#include <opentrep/DistanceErrorRule.hpp>

Inheritance diagram for OPENTREP::DistanceErrorRule:

Public Member Functions
const DistanceErrorScale_T &	getDistanceErrorScale () const
NbOfErrors_T	getAllowedDistanceError (const NbOfLetters_T &iNbOfLetters) const
void	toStream (std::ostream &ioOut) const
void	fromStream (std::istream &)
std::string	toShortString () const
std::string	toString () const
	DistanceErrorRule (const DistanceErrorScale_T &iScale)
	DistanceErrorRule (const NbOfErrors_T iSize, const NbOfLetters_T iScaleArray[])
	DistanceErrorRule (const DistanceErrorScaleArray_T &iScaleArray)

Detailed Description

Structure modelling a (geographical) distanceerrorrule.

Definition at line 43 of file DistanceErrorRule.hpp.

Constructor & Destructor Documentation

OPENTREP::DistanceErrorRule::DistanceErrorRule ( const DistanceErrorScale_T &  iScale )

inline

Main Constructor.

Definition at line 129 of file DistanceErrorRule.hpp.

OPENTREP::DistanceErrorRule::DistanceErrorRule ( const NbOfErrors_T  iSize, const NbOfLetters_T  iScaleArray[]  )

inline

Constructor.

Definition at line 136 of file DistanceErrorRule.hpp.

OPENTREP::DistanceErrorRule::DistanceErrorRule ( const DistanceErrorScaleArray_T &  iScaleArray )

inline

Constructor.

Definition at line 147 of file DistanceErrorRule.hpp.

Member Function Documentation

const DistanceErrorScale_T& OPENTREP::DistanceErrorRule::getDistanceErrorScale ( ) const

inline

Get the DistanceErrorRule code.

Definition at line 49 of file DistanceErrorRule.hpp.

NbOfErrors_T OPENTREP::DistanceErrorRule::getAllowedDistanceError ( const NbOfLetters_T &  iNbOfLetters ) const

inline

Get, for a given number of letters, the corresponding allowed (distance) error.

Definition at line 63 of file DistanceErrorRule.hpp.

void OPENTREP::DistanceErrorRule::toStream ( std::ostream &  ioOut ) const

inlinevirtual

Dump a structure into an output stream.

Parameters

ostream&

the output stream.

Implements OPENTREP::OPENTREP_Abstract.

Definition at line 87 of file DistanceErrorRule.hpp.

References toString().

void OPENTREP::DistanceErrorRule::fromStream ( std::istream &  )

inlinevirtual

Read a structure from an input stream.

Parameters

istream&

the input stream.

Implements OPENTREP::OPENTREP_Abstract.

Definition at line 96 of file DistanceErrorRule.hpp.

std::string OPENTREP::DistanceErrorRule::toShortString ( ) const

inline

Get a short display of the DistanceErrorRule structure.

Definition at line 102 of file DistanceErrorRule.hpp.

Referenced by toString().

std::string OPENTREP::DistanceErrorRule::toString ( ) const

inlinevirtual

Get the serialised version of the DistanceErrorRule structure.

Implements OPENTREP::OPENTREP_Abstract.

Definition at line 118 of file DistanceErrorRule.hpp.

References toShortString().

Referenced by toStream().

---

The documentation for this struct was generated from the following file:

• opentrep/DistanceErrorRule.hpp