ObjectFinder Class Reference

The ObjectFinder class TODO (fabian.peller): Merge with ArmarXObjects object finder! More...

#include <RobotAPI/libraries/PriorKnowledge/objects/ObjectFinder.h>

+ Inheritance diagram for ObjectFinder:

Public Member Functions

bool accept (const std::filesystem::path &idPath) const final
 
 ObjectFinder (const std::filesystem::path &relDir=DEFAULT_DIR_TO_DATASETS)
 
void registerPropertyDefinitions (armarx::PropertyDefinitionsPtr &defs, const std::string &prefix="pk.finder.objects.") final
 
- Public Member Functions inherited from PKDatasetFinder
bool check (const std::string &dataset, const std::string &id) const override
 
bool check (const std::string &id) const override
 
bool checkAll () const override
 
bool checkAll (const std::string &dataset) const override
 
std::optional< PKDatasetFinderInfofind (const std::string &dataset, const std::string &id) const override
 
std::optional< PKDatasetFinderInfofind (const std::string &id) const override
 
std::vector< PKDatasetFinderInfofindAll () const override
 
std::vector< PKDatasetFinderInfofindAll (const std::string &dataset) const override
 
virtual void init ()
 
 PKDatasetFinder (const std::filesystem::path &relDir)
 
virtual ~PKDatasetFinder ()
 
- Public Member Functions inherited from DatasetFinderBase< std::string, std::string, PKDatasetFinderInfo >
virtual bool check (const std::string &id) const =0
 
virtual bool checkAll () const =0
 
 DatasetFinderBase (const std::string &packageName, const std::filesystem::path &relDir)
 
virtual std::optional< PKDatasetFinderInfofind (const std::string &id) const =0
 
virtual std::vector< PKDatasetFinderInfofindAll () const =0
 
std::filesystem::path getFullPath (const std::filesystem::path &relPath) const
 
- Public Member Functions inherited from FinderBase< std::string, PKDatasetFinderInfo >
 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_DIR_TO_DATASETS = "objects"
 
- Static Public Attributes inherited from PKDatasetFinder
static const constexpr auto DEFAULT_PACKAGE = "PriorKnowledgeData"
 

Additional Inherited Members

- Public Types inherited from DatasetFinderBase< std::string, std::string, PKDatasetFinderInfo >
using Base = FinderBase< std::string, PKDatasetFinderInfo >
 
- Protected Member Functions inherited from FinderBase< std::string, PKDatasetFinderInfo >
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, PKDatasetFinderInfo >
std::string packageName
 
- Protected Attributes inherited from Logging
MessageTypeT minimumLoggingLevel
 
SpamFilterDataPtr spamFilter
 
LogTag tag
 

Detailed Description

The ObjectFinder class TODO (fabian.peller): Merge with ArmarXObjects object finder!

Definition at line 11 of file ObjectFinder.h.

Constructor & Destructor Documentation

◆ ObjectFinder()

ObjectFinder ( const std::filesystem::path &  relDir = DEFAULT_DIR_TO_DATASETS)
inline

Definition at line 17 of file ObjectFinder.h.

Member Function Documentation

◆ accept()

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

Implements FinderBase< std::string, PKDatasetFinderInfo >.

Definition at line 23 of file ObjectFinder.h.

◆ registerPropertyDefinitions()

void registerPropertyDefinitions ( armarx::PropertyDefinitionsPtr defs,
const std::string &  prefix = "pk.finder.objects." 
)
inlinefinalvirtual

Reimplemented from PKDatasetFinder.

Definition at line 29 of file ObjectFinder.h.

+ Here is the call graph for this function:

Member Data Documentation

◆ DEFAULT_DIR_TO_DATASETS

const constexpr auto DEFAULT_DIR_TO_DATASETS = "objects"
staticconstexpr

Definition at line 15 of file ObjectFinder.h.


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