concordia-library/concordia/example.hpp
2015-05-01 14:52:53 +02:00

50 lines
985 B
C++

#ifndef EXAMPLE_HDR
#define EXAMPLE_HDR
#include "concordia/common/config.hpp"
#include "concordia/concordia_exception.hpp"
#include <string>
/*!
Class representing a single sentence to be added into index along with its id.
For more info see \ref tutorial1_2.
*/
class Example {
public:
/*!
Constructor.
\param sentence sentence to be added to index
\param id id of this sentence
*/
explicit Example(const std::string & sentence,
const SUFFIX_MARKER_TYPE & id)
throw(ConcordiaException);
/*! Destructor.
*/
virtual ~Example();
/*! Getter for sentence.
\return sentence
*/
std::string getSentence() const {
return _sentence;
}
/*! Getter for sentence id.
\return sentence id
*/
SUFFIX_MARKER_TYPE getId() const {
return _id;
}
private:
std::string _sentence;
SUFFIX_MARKER_TYPE _id;
};
#endif