PKFinder Class Reference

The ObjectFinder class. More...

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

+ Inheritance diagram for PKFinder:

Public Member Functions

bool check (const std::string &id) const override
 
bool checkAll () const override
 
std::optional< PKFinderInfofind (const std::string &id) const override
 
std::vector< PKFinderInfofindAll () const override
 
virtual void init ()
 
 PKFinder (const std::filesystem::path &relDir)
 
virtual void registerPropertyDefinitions (armarx::PropertyDefinitionsPtr &defs, const std::string &prefix)
 
virtual ~PKFinder ()
 
- Public Member Functions inherited from FinderBase< std::string, PKFinderInfo >
virtual bool accept (const std::filesystem::path &idPath) const=0
 
virtual bool checkAll () const=0
 
virtual std::vector< PKFinderInfofindAll () 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
 
FinderBaseoperator= (const FinderBase &)=default
 
FinderBaseoperator= (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. More...
 
MessageTypeT getEffectiveLoggingLevel () const
 
 Logging ()
 
void setLocalMinimumLoggingLevel (MessageTypeT level)
 With setLocalMinimumLoggingLevel the minimum verbosity-level of log-messages can be set. More...
 
void setTag (const LogTag &tag)
 
void setTag (const std::string &tagName)
 
virtual ~Logging ()
 

Static Public Attributes

static const constexpr auto DEFAULT_PACKAGE = "PriorKnowledgeData"
 

Additional Inherited Members

- Protected Member Functions inherited from FinderBase< std::string, PKFinderInfo >
void checkAbsolutePathIsValid () const
 
- Protected Member Functions inherited from Logging
bool checkLogLevel (MessageTypeT level) const
 
const LogSenderPtrgetLogSender () const
 Retrieve log sender. More...
 
LogSenderPtr loghelper (const char *file, int line, const char *function) const
 
- Protected Attributes inherited from FinderBase< std::string, PKFinderInfo >
std::string packageName
 
- Protected Attributes inherited from Logging
MessageTypeT minimumLoggingLevel
 
SpamFilterDataPtr spamFilter
 
LogTag tag
 

Detailed Description

The ObjectFinder class.

Definition at line 25 of file PKFinder.h.

Constructor & Destructor Documentation

◆ PKFinder()

PKFinder ( const std::filesystem::path &  relDir)
inline

Definition at line 34 of file PKFinder.h.

◆ ~PKFinder()

virtual ~PKFinder ( )
inlinevirtual

Definition at line 38 of file PKFinder.h.

Member Function Documentation

◆ check()

bool check ( const std::string &  id) const
overridevirtual

Implements FinderBase< std::string, PKFinderInfo >.

Definition at line 56 of file PKFinder.cpp.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ checkAll()

bool checkAll ( ) const
override

Definition at line 30 of file PKFinder.cpp.

+ Here is the call graph for this function:

◆ find()

std::optional< PKFinderInfo > find ( const std::string &  id) const
overridevirtual

Implements FinderBase< std::string, PKFinderInfo >.

Definition at line 69 of file PKFinder.cpp.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ findAll()

std::vector< PKFinderInfo > findAll ( ) const
override

Definition at line 82 of file PKFinder.cpp.

+ Here is the call graph for this function:

◆ init()

void init ( )
virtual

Definition at line 24 of file PKFinder.cpp.

+ Here is the call graph for this function:

◆ registerPropertyDefinitions()

void registerPropertyDefinitions ( armarx::PropertyDefinitionsPtr defs,
const std::string &  prefix 
)
virtual

Reimplemented in RobotFinder, and NavigationGraphFinder.

Definition at line 12 of file PKFinder.cpp.

+ Here is the caller graph for this function:

Member Data Documentation

◆ DEFAULT_PACKAGE

const constexpr auto DEFAULT_PACKAGE = "PriorKnowledgeData"
staticconstexpr

Definition at line 30 of file PKFinder.h.


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