List of all members | Public Member Functions | Protected Member Functions | Protected Attributes
FinderBase< IDType, FinderInfoType > Class Template Referenceabstract

#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. 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 ()
 

Protected Member Functions

void checkAbsolutePathIsValid () const
 
- Protected Member Functions inherited from Logging
bool checkLogLevel (MessageTypeT level) const
 
const LogSenderPtr & getLogSender () const
 Retrieve log sender. More...
 
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
 

Detailed Description

template<class IDType, class FinderInfoType>
class armarx::priorknowledge::core::FinderBase< IDType, FinderInfoType >

Definition at line 19 of file FinderBase.h.

Constructor & Destructor Documentation

◆ FinderBase() [1/4]

FinderBase ( )
delete

◆ FinderBase() [2/4]

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

Definition at line 24 of file FinderBase.h.

◆ ~FinderBase()

virtual ~FinderBase ( )
inlinevirtual

Definition at line 49 of file FinderBase.h.

◆ FinderBase() [3/4]

FinderBase ( FinderBase< IDType, FinderInfoType > &&  )
default

◆ FinderBase() [4/4]

FinderBase ( const FinderBase< IDType, FinderInfoType > &  )
default

Member Function Documentation

◆ accept()

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

Implemented in ObjectFinder, MotionFinder, NavigationGraphFinder, and RobotFinder.

◆ check()

virtual bool check ( const IDType &  id) const
pure virtual

Implemented in PKDatasetFinder, and PKFinder.

◆ checkAbsolutePathIsValid()

void checkAbsolutePathIsValid ( ) const
inlineprotected

Definition at line 98 of file FinderBase.h.

+ Here is the caller graph for this function:

◆ checkAll()

virtual bool checkAll ( ) const
pure virtual

Implemented in DatasetFinderBase< std::string, std::string, PKDatasetFinderInfo >.

◆ find()

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

Implemented in PKDatasetFinder, and PKFinder.

◆ findAll()

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

Implemented in DatasetFinderBase< std::string, std::string, PKDatasetFinderInfo >.

◆ getAbsolutePackagePath()

std::filesystem::path getAbsolutePackagePath ( ) const
inline

Definition at line 77 of file FinderBase.h.

◆ getFullPath()

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

Definition at line 84 of file FinderBase.h.

+ Here is the caller graph for this function:

◆ getPackageName()

std::string getPackageName ( ) const
inline

Definition at line 65 of file FinderBase.h.

◆ getRelativePath()

std::filesystem::path getRelativePath ( ) const
inline

Definition at line 71 of file FinderBase.h.

◆ operator=() [1/2]

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

◆ operator=() [2/2]

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

◆ recalculateBasePath()

void recalculateBasePath ( )
inline

Definition at line 31 of file FinderBase.h.

+ Here is the caller graph for this function:

◆ setRelativePath()

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

Definition at line 59 of file FinderBase.h.

Member Data Documentation

◆ packageName

std::string packageName
protected

Definition at line 109 of file FinderBase.h.

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