object_database::ObjectDatabaseRecognizer Class Reference

#include <ObjectDatabaseRecognizer.h>

List of all members.

Public Member Functions
ObjectDatabaseEntryPtrMap	getEntries ()
const ObjectDatabaseEntryPtr &	getEntry (const std::string objectName)
const std::string	getKeyword ()
const fs::path	getPath ()
const std::string	getRegexp ()
bool	isRead ()
	ObjectDatabaseRecognizer (database db)
void	readEntries ()
void	setKeyword (const std::string kw)
void	setPath (const fs::path pt)
void	setRegexp (const std::string regexp)
virtual	~ObjectDatabaseRecognizer ()
Private Member Functions
void	setRead (bool rd)
Private Attributes
database	mDatabase
ObjectDatabaseEntryPtrMap	mEntries
bool	mRead

---

Detailed Description

The ObjectDatabaseRecognizer class contains all information about

Definition at line 51 of file ObjectDatabaseRecognizer.h.

---

Constructor & Destructor Documentation

object_database::ObjectDatabaseRecognizer::ObjectDatabaseRecognizer

(

database

db

)

Creates an empty object recognizer object.

Definition at line 29 of file ObjectDatabaseRecognizer.cpp.

virtual object_database::ObjectDatabaseRecognizer::~ObjectDatabaseRecognizer

(

)

[inline, virtual]

destructs the object

Definition at line 76 of file ObjectDatabaseRecognizer.h.

---

Member Function Documentation

ObjectDatabaseEntryPtrMap object_database::ObjectDatabaseRecognizer::getEntries

(

)

Returns:

the entries of the recognizer

Definition at line 163 of file ObjectDatabaseRecognizer.cpp.

const ObjectDatabaseEntryPtr & object_database::ObjectDatabaseRecognizer::getEntry

(

const std::string

objectName

)

Parameters:

objectName

the name of the object entry to be found

Returns:

a special entry.

Definition at line 168 of file ObjectDatabaseRecognizer.cpp.

const std::string object_database::ObjectDatabaseRecognizer::getKeyword

(

)

Returns:

the keyword associated with the recognizer

Definition at line 34 of file ObjectDatabaseRecognizer.cpp.

const fs::path object_database::ObjectDatabaseRecognizer::getPath

(

)

Returns:

the path to the recognizer database folder.

Definition at line 44 of file ObjectDatabaseRecognizer.cpp.

const std::string object_database::ObjectDatabaseRecognizer::getRegexp

(

)

Returns:

the regular expression for matching the recognizer's entry file or directory.

Definition at line 56 of file ObjectDatabaseRecognizer.cpp.

bool object_database::ObjectDatabaseRecognizer::isRead

(

)

Returns:

if the entries of this recognizer are already read.

Definition at line 66 of file ObjectDatabaseRecognizer.cpp.

void object_database::ObjectDatabaseRecognizer::readEntries

(

)

Reads the entries to

Definition at line 76 of file ObjectDatabaseRecognizer.cpp.

void object_database::ObjectDatabaseRecognizer::setKeyword

(

const std::string

kw

)

Parameters:

kw	the keyword for the recognizer.

Definition at line 39 of file ObjectDatabaseRecognizer.cpp.

void object_database::ObjectDatabaseRecognizer::setPath

(

const fs::path

pt

)

Parameters:

pt	the path to the recognizer database folder.

Definition at line 50 of file ObjectDatabaseRecognizer.cpp.

void object_database::ObjectDatabaseRecognizer::setRead

(

bool

rd

)

[private]

Parameters:

rd	if the entries are read or not.

Definition at line 71 of file ObjectDatabaseRecognizer.cpp.

void object_database::ObjectDatabaseRecognizer::setRegexp

(

const std::string

regexp

)

Parameters:

the	regular expression to use for matching the recognizer's entries.

Definition at line 61 of file ObjectDatabaseRecognizer.cpp.

---

Member Data Documentation

database object_database::ObjectDatabaseRecognizer::mDatabase [private]

database

Definition at line 56 of file ObjectDatabaseRecognizer.h.

ObjectDatabaseEntryPtrMap object_database::ObjectDatabaseRecognizer::mEntries [private]

holds the entries of the recognizer.

Definition at line 66 of file ObjectDatabaseRecognizer.h.

bool object_database::ObjectDatabaseRecognizer::mRead [private]

indicates if read or not

Definition at line 61 of file ObjectDatabaseRecognizer.h.

---

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

• ObjectDatabaseRecognizer.h
• ObjectDatabaseRecognizer.cpp