OPENTREP::OpenTrepSearcher Struct Reference

API wrapper around the OpenTREP C++ API, so that Python scripts can use it seamlessly. More...

Public Member Functions
std::string	getPaths ()
std::string	index ()
std::string	generate (const std::string &iOutputFormatString, const NbOfMatches_T &iNbOfDraws)
std::string	search (const std::string &iOutputFormatString, const std::string &iTravelQuery)
	OpenTrepSearcher ()
	OpenTrepSearcher (const OpenTrepSearcher &iOpenTrepSearcher)
	~OpenTrepSearcher ()
bool	init (const std::string &iTravelDBFilePath, const std::string &iSQLiteDBFilePath, const std::string &iLogFilePath)
bool	finalize ()

Detailed Description

API wrapper around the OpenTREP C++ API, so that Python scripts can use it seamlessly.

Definition at line 26 of file pyopentrep.cpp.

Constructor & Destructor Documentation

OPENTREP::OpenTrepSearcher::OpenTrepSearcher ( )

inline

Default constructor.

Definition at line 594 of file pyopentrep.cpp.

OPENTREP::OpenTrepSearcher::OpenTrepSearcher ( const OpenTrepSearcher &  iOpenTrepSearcher )

inline

Default copy constructor.

Definition at line 600 of file pyopentrep.cpp.

OPENTREP::OpenTrepSearcher::~OpenTrepSearcher ( )

inline

Default constructor.

Definition at line 608 of file pyopentrep.cpp.

Member Function Documentation

std::string OPENTREP::OpenTrepSearcher::getPaths ( )

inline

Get the file-paths for the:

• ORI-maintained list of POR (points of reference)
• Xapian-based travel database/index

Definition at line 36 of file pyopentrep.cpp.

Referenced by BOOST_PYTHON_MODULE().

std::string OPENTREP::OpenTrepSearcher::index ( )

inline

Public wrapper around the indexation use case.

Definition at line 43 of file pyopentrep.cpp.

Referenced by BOOST_PYTHON_MODULE().

std::string OPENTREP::OpenTrepSearcher::generate ( const std::string &  iOutputFormatString, const NbOfMatches_T &  iNbOfDraws  )

inline

Public wrapper around the random generation use case.

Definition at line 50 of file pyopentrep.cpp.

References OPENTREP::OutputFormat::getFormat().

Referenced by BOOST_PYTHON_MODULE().

std::string OPENTREP::OpenTrepSearcher::search ( const std::string &  iOutputFormatString, const std::string &  iTravelQuery  )

inline

Public wrapper around the search use case.

Definition at line 61 of file pyopentrep.cpp.

References OPENTREP::OutputFormat::getFormat().

Referenced by BOOST_PYTHON_MODULE().

bool OPENTREP::OpenTrepSearcher::init ( const std::string &  iTravelDBFilePath, const std::string &  iSQLiteDBFilePath, const std::string &  iLogFilePath  )

inline

Wrapper around the search use case.

Definition at line 616 of file pyopentrep.cpp.

References OPENTREP::RootException::what().

Referenced by BOOST_PYTHON_MODULE().

bool OPENTREP::OpenTrepSearcher::finalize ( )

inline

Wrapper around the search use case.

Definition at line 671 of file pyopentrep.cpp.

Referenced by BOOST_PYTHON_MODULE().

---

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

• opentrep/python/pyopentrep.cpp