PKDatasetFinder Class Reference

The PKDatasetFinder class. More...

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

+ Inheritance diagram for PKDatasetFinder:

Public Member Functions

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 void registerPropertyDefinitions (armarx::PropertyDefinitionsPtr &defs, const std::string &prefix)
 
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 >
virtual bool accept (const std::filesystem::path &idPath) 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

- 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 PKDatasetFinder class.

Definition at line 25 of file PKDatasetFinder.h.

Constructor & Destructor Documentation

◆ PKDatasetFinder()

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

Definition at line 35 of file PKDatasetFinder.h.

◆ ~PKDatasetFinder()

virtual ~PKDatasetFinder ( )
inlinevirtual

Definition at line 39 of file PKDatasetFinder.h.

Member Function Documentation

◆ check() [1/2]

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

Implements DatasetFinderBase< std::string, std::string, PKDatasetFinderInfo >.

Definition at line 91 of file PKDatasetFinder.cpp.

+ Here is the call graph for this function:

◆ check() [2/2]

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

Implements FinderBase< std::string, PKDatasetFinderInfo >.

Definition at line 110 of file PKDatasetFinder.cpp.

+ Here is the call graph for this function:

◆ checkAll() [1/2]

bool checkAll ( ) const
override

Definition at line 60 of file PKDatasetFinder.cpp.

+ Here is the call graph for this function:

◆ checkAll() [2/2]

bool checkAll ( const std::string &  dataset) const
overridevirtual

Implements DatasetFinderBase< std::string, std::string, PKDatasetFinderInfo >.

Definition at line 29 of file PKDatasetFinder.cpp.

+ Here is the call graph for this function:

◆ find() [1/2]

std::optional< PKDatasetFinderInfo > find ( const std::string &  dataset,
const std::string &  id 
) const
overridevirtual

Implements DatasetFinderBase< std::string, std::string, PKDatasetFinderInfo >.

Definition at line 141 of file PKDatasetFinder.cpp.

+ Here is the call graph for this function:

◆ find() [2/2]

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

Implements FinderBase< std::string, PKDatasetFinderInfo >.

Definition at line 159 of file PKDatasetFinder.cpp.

+ Here is the call graph for this function:

◆ findAll() [1/2]

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

Definition at line 191 of file PKDatasetFinder.cpp.

+ Here is the call graph for this function:

◆ findAll() [2/2]

std::vector< PKDatasetFinderInfo > findAll ( const std::string &  dataset) const
overridevirtual

Implements DatasetFinderBase< std::string, std::string, PKDatasetFinderInfo >.

Definition at line 221 of file PKDatasetFinder.cpp.

+ Here is the call graph for this function:

◆ init()

void init ( )
virtual

Definition at line 23 of file PKDatasetFinder.cpp.

+ Here is the call graph for this function:

◆ registerPropertyDefinitions()

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

Reimplemented in ObjectFinder, and MotionFinder.

Definition at line 11 of file PKDatasetFinder.cpp.

+ Here is the caller graph for this function:

Member Data Documentation

◆ DEFAULT_PACKAGE

const constexpr auto DEFAULT_PACKAGE = "PriorKnowledgeData"
staticconstexpr

Definition at line 31 of file PKDatasetFinder.h.


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