object_database::ObjectDatabaseRecognizer Class Reference

#include <ObjectDatabaseRecognizer.h>

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

ObjectDatabaseRecognizer()

object_database::ObjectDatabaseRecognizer::ObjectDatabaseRecognizer

(

database

db

)

Creates an empty object recognizer object.

Definition at line 29 of file ObjectDatabaseRecognizer.cpp.

~ObjectDatabaseRecognizer()

virtual object_database::ObjectDatabaseRecognizer::~ObjectDatabaseRecognizer ( )

inlinevirtual

destructs the object

Definition at line 76 of file ObjectDatabaseRecognizer.h.

Member Function Documentation

getEntries()

ObjectDatabaseEntryPtrMap object_database::ObjectDatabaseRecognizer::getEntries

(

)

Returns

the entries of the recognizer

Definition at line 163 of file ObjectDatabaseRecognizer.cpp.

getEntry()

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.

getKeyword()

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

(

)

Returns

the keyword associated with the recognizer

Definition at line 34 of file ObjectDatabaseRecognizer.cpp.

getPath()

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

(

)

Returns

the path to the recognizer database folder.

Definition at line 44 of file ObjectDatabaseRecognizer.cpp.

getRegexp()

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.

isRead()

bool object_database::ObjectDatabaseRecognizer::isRead

(

)

Returns

if the entries of this recognizer are already read.

Definition at line 66 of file ObjectDatabaseRecognizer.cpp.

readEntries()

void object_database::ObjectDatabaseRecognizer::readEntries

(

)

Reads the entries to

Definition at line 76 of file ObjectDatabaseRecognizer.cpp.

setKeyword()

void object_database::ObjectDatabaseRecognizer::setKeyword

(

const std::string

kw

)

Parameters

kw	the keyword for the recognizer.

Definition at line 39 of file ObjectDatabaseRecognizer.cpp.

setPath()

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.

setRead()

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.

setRegexp()

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

mDatabase

database object_database::ObjectDatabaseRecognizer::mDatabase

private

database

Definition at line 56 of file ObjectDatabaseRecognizer.h.

mEntries

ObjectDatabaseEntryPtrMap object_database::ObjectDatabaseRecognizer::mEntries

private

holds the entries of the recognizer.

Definition at line 66 of file ObjectDatabaseRecognizer.h.

mRead

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