FinderBase< IDType, FinderInfoType > Class Template Reference

#include <RobotAPI/libraries/PriorKnowledge/core/FinderBase.h>

Inheritance diagram for FinderBase< IDType, FinderInfoType >:

Public Member Functions
virtual bool	accept (const std::filesystem::path &idPath) const =0
virtual bool	check (const IDType &id) const =0
virtual bool	checkAll () const =0
virtual std::optional< FinderInfoType >	find (const IDType &id) const =0
virtual std::vector< FinderInfoType >	findAll () const =0
	FinderBase ()=delete
	FinderBase (const FinderBase &)=default
	FinderBase (const std::string &packageName, const std::filesystem::path &relDir)
	FinderBase (FinderBase &&)=default
std::filesystem::path	getAbsolutePackagePath () const
std::filesystem::path	getFullPath () const
std::string	getPackageName () const
std::filesystem::path	getRelativePath () const
FinderBase &	operator= (const FinderBase &)=default
FinderBase &	operator= (FinderBase &&)=default
void	recalculateBasePath ()
void	setRelativePath (const std::filesystem::path &p)
virtual	~FinderBase ()
Public Member Functions inherited from Logging
SpamFilterDataPtr	deactivateSpam (float deactivationDurationSec=10.0f, const std::string &identifier="", bool deactivate=true) const
	disables the logging for the current line for the given amount of seconds.
MessageTypeT	getEffectiveLoggingLevel () const
	Logging ()
void	setLocalMinimumLoggingLevel (MessageTypeT level)
	With setLocalMinimumLoggingLevel the minimum verbosity-level of log-messages can be set.
void	setTag (const LogTag &tag)
void	setTag (const std::string &tagName)
virtual	~Logging ()

Protected Member Functions
void	checkAbsolutePathIsValid () const
Protected Member Functions inherited from Logging
bool	checkLogLevel (MessageTypeT level) const
const LogSenderPtr &	getLogSender () const
	Retrieve log sender.
LogSenderPtr	loghelper (const char *file, int line, const char *function) const

Protected Attributes
std::string	packageName
Protected Attributes inherited from Logging
MessageTypeT	minimumLoggingLevel
SpamFilterDataPtr	spamFilter
LogTag	tag

Constructor & Destructor Documentation

FinderBase() [1/4]

template<class IDType, class FinderInfoType>

FinderBase ( )

delete

FinderBase() [2/4]

template<class IDType, class FinderInfoType>

FinderBase ( const std::string & packageName, const std::filesystem::path & relDir )

inline

~FinderBase()

template<class IDType, class FinderInfoType>

virtual ~FinderBase ( )

inlinevirtual

FinderBase() [3/4]

template<class IDType, class FinderInfoType>

FinderBase ( FinderBase< IDType, FinderInfoType > && )

default

FinderBase() [4/4]

template<class IDType, class FinderInfoType>

FinderBase ( const FinderBase< IDType, FinderInfoType > & )

default

Member Function Documentation

accept()

template<class IDType, class FinderInfoType>

virtual bool accept ( const std::filesystem::path & idPath ) const

pure virtual

Implemented in MotionFinder, NavigationGraphFinder, ObjectFinder, and RobotFinder.

check()

template<class IDType, class FinderInfoType>

virtual bool check ( const IDType & id ) const

pure virtual

Implemented in DatasetFinderBase< IDType, DatasetType, FinderInfoType >, and PKFinder.

checkAbsolutePathIsValid()

template<class IDType, class FinderInfoType>

void checkAbsolutePathIsValid ( ) const

inlineprotected

checkAll()

template<class IDType, class FinderInfoType>

virtual bool checkAll ( ) const

pure virtual

Implemented in DatasetFinderBase< IDType, DatasetType, FinderInfoType >, DatasetFinderBase< std::string, std::string, PKDatasetFinderInfo >, DatasetFinderBase< std::string, std::string, PKDatasetFinderInfo >, PKDatasetFinder, and PKFinder.

find()

template<class IDType, class FinderInfoType>

virtual std::optional< FinderInfoType > find ( const IDType & id ) const

pure virtual

Implemented in DatasetFinderBase< IDType, DatasetType, FinderInfoType >, and PKFinder.

findAll()

template<class IDType, class FinderInfoType>

virtual std::vector< FinderInfoType > findAll ( ) const

pure virtual

Implemented in DatasetFinderBase< IDType, DatasetType, FinderInfoType >, DatasetFinderBase< std::string, std::string, PKDatasetFinderInfo >, DatasetFinderBase< std::string, std::string, PKDatasetFinderInfo >, PKDatasetFinder, and PKFinder.

getAbsolutePackagePath()

template<class IDType, class FinderInfoType>

std::filesystem::path getAbsolutePackagePath ( ) const

inline

getFullPath()

template<class IDType, class FinderInfoType>

std::filesystem::path getFullPath ( ) const

inline

getPackageName()

template<class IDType, class FinderInfoType>

std::string getPackageName ( ) const

inline

getRelativePath()

template<class IDType, class FinderInfoType>

std::filesystem::path getRelativePath ( ) const

inline

operator=() [1/2]

template<class IDType, class FinderInfoType>

FinderBase & operator= ( const FinderBase< IDType, FinderInfoType > & )

default

operator=() [2/2]

template<class IDType, class FinderInfoType>

FinderBase & operator= ( FinderBase< IDType, FinderInfoType > && )

default

recalculateBasePath()

template<class IDType, class FinderInfoType>

void recalculateBasePath ( )

inline

setRelativePath()

template<class IDType, class FinderInfoType>

void setRelativePath ( const std::filesystem::path & p )

inline

Member Data Documentation

packageName

template<class IDType, class FinderInfoType>

std::string packageName

protected

---

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

• RobotAPI/libraries/PriorKnowledge/core/FinderBase.h