DatasetFinderBase< IDType, DatasetType, FinderInfoType > Class Template Referenceabstract

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

+ Inheritance diagram for DatasetFinderBase< IDType, DatasetType, FinderInfoType >:

Public Types

using Base = FinderBase< IDType, FinderInfoType >
 

Public Member Functions

virtual bool check (const DatasetType &dataset, const IDType &id) const =0
 
virtual bool check (const IDType &id) const=0
 
virtual bool checkAll () const=0
 
virtual bool checkAll (const DatasetType &dataset) const =0
 
 DatasetFinderBase (const std::string &packageName, const std::filesystem::path &relDir)
 
virtual std::optional< FinderInfoType > find (const DatasetType &dataset, const IDType &id) const =0
 
virtual std::optional< FinderInfoType > find (const IDType &id) const=0
 
virtual std::vector< FinderInfoType > findAll () const=0
 
virtual std::vector< FinderInfoType > findAll (const DatasetType &dataset) const =0
 
std::filesystem::path getFullPath (const std::filesystem::path &relPath) const
 
- Public Member Functions inherited from FinderBase< IDType, FinderInfoType >
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
 
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 ()
 

Additional Inherited Members

- Protected Member Functions inherited from FinderBase< IDType, FinderInfoType >
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< IDType, FinderInfoType >
std::string packageName
 
- Protected Attributes inherited from Logging
MessageTypeT minimumLoggingLevel
 
SpamFilterDataPtr spamFilter
 
LogTag tag
 

Detailed Description

template<class IDType, class DatasetType, class FinderInfoType>
class armarx::priorknowledge::core::DatasetFinderBase< IDType, DatasetType, FinderInfoType >

Definition at line 119 of file FinderBase.h.

Member Typedef Documentation

◆ Base

using Base = FinderBase<IDType, FinderInfoType>

Definition at line 123 of file FinderBase.h.

Constructor & Destructor Documentation

◆ DatasetFinderBase()

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

Definition at line 125 of file FinderBase.h.

Member Function Documentation

◆ check() [1/2]

virtual bool check ( const DatasetType &  dataset,
const IDType &  id 
) const
pure virtual

Implemented in PKDatasetFinder.

◆ check() [2/2]

virtual bool check

◆ checkAll() [1/2]

virtual bool checkAll

◆ checkAll() [2/2]

virtual bool checkAll ( const DatasetType &  dataset) const
pure virtual

Implemented in PKDatasetFinder.

◆ find() [1/2]

virtual std::optional<FinderInfoType> find ( const DatasetType &  dataset,
const IDType &  id 
) const
pure virtual

Implemented in PKDatasetFinder.

◆ find() [2/2]

virtual std::optional<FinderInfoType> find

◆ findAll() [1/2]

virtual std::vector<FinderInfoType> findAll

◆ findAll() [2/2]

virtual std::vector<FinderInfoType> findAll ( const DatasetType &  dataset) const
pure virtual

Implemented in PKDatasetFinder.

◆ getFullPath()

std::filesystem::path getFullPath ( const std::filesystem::path &  relPath) const
inline

Definition at line 131 of file FinderBase.h.


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