List of all members | Public Member Functions | Protected Member Functions | Protected Attributes
FinderInfoBase< IDType > Class Template Reference

The FinderInfoBase class Indicates an into to 'something' of type IDType. More...

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

+ Inheritance diagram for FinderInfoBase< IDType >:

Public Member Functions

 FinderInfoBase (const std::string &packageName, const std::filesystem::path &absPackageDataPath, const std::filesystem::path &relPathToId, const IDType &id)
 
std::filesystem::path getAbsolutePackageDataPath () const
 
virtual std::filesystem::path getFullPath () const
 
IDType getID () const
 
std::string getPackageName () const
 
std::filesystem::path getRelativePath () const
 
PackageFileLocation toPackageFileLocation ()
 
virtual ~FinderInfoBase ()
 

Protected Member Functions

void checkAbsolutePathIsValid () const
 

Protected Attributes

bool logError = true
 

Detailed Description

template<class IDType>
class armarx::priorknowledge::core::FinderInfoBase< IDType >

The FinderInfoBase class Indicates an into to 'something' of type IDType.

Definition at line 34 of file FinderInfoBase.h.

Constructor & Destructor Documentation

◆ FinderInfoBase()

template<class IDType>
FinderInfoBase ( const std::string & packageName,
const std::filesystem::path & absPackageDataPath,
const std::filesystem::path & relPathToId,
const IDType & id )
inline

Definition at line 37 of file FinderInfoBase.h.

◆ ~FinderInfoBase()

template<class IDType>
virtual ~FinderInfoBase ( )
inlinevirtual

Definition at line 49 of file FinderInfoBase.h.

Member Function Documentation

◆ checkAbsolutePathIsValid()

template<class IDType>
void checkAbsolutePathIsValid ( ) const
inlineprotected

Definition at line 93 of file FinderInfoBase.h.

+ Here is the caller graph for this function:

◆ getAbsolutePackageDataPath()

template<class IDType>
std::filesystem::path getAbsolutePackageDataPath ( ) const
inline

Definition at line 72 of file FinderInfoBase.h.

◆ getFullPath()

template<class IDType>
virtual std::filesystem::path getFullPath ( ) const
inlinevirtual

Definition at line 79 of file FinderInfoBase.h.

+ Here is the caller graph for this function:

◆ getID()

template<class IDType>
IDType getID ( ) const
inline

Definition at line 86 of file FinderInfoBase.h.

◆ getPackageName()

template<class IDType>
std::string getPackageName ( ) const
inline

Definition at line 60 of file FinderInfoBase.h.

+ Here is the caller graph for this function:

◆ getRelativePath()

template<class IDType>
std::filesystem::path getRelativePath ( ) const
inline

Definition at line 66 of file FinderInfoBase.h.

+ Here is the caller graph for this function:

◆ toPackageFileLocation()

template<class IDType>
PackageFileLocation toPackageFileLocation ( )
inline

Definition at line 54 of file FinderInfoBase.h.

Member Data Documentation

◆ logError

template<class IDType>
bool logError = true
protected

Definition at line 104 of file FinderInfoBase.h.

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