Finder Class Reference

Used to find human profiles in the Prior Knowledge Data repository [1]. More...

#include <VisionX/libraries/armem_human/server/profile/Finder.h>

+ Inheritance diagram for Finder:

Public Types

using Info = armarx::armem::human::Info
 
using path = std::filesystem::path
 

Public Member Functions

std::optional< Infofind (const std::string &name) const
 
std::vector< InfofindAll (bool checkPaths=true) const
 
 Finder (const std::string &packageName=DefaultPackageName, const path &relativeDirectory=DefaultRelativeDirectory)
 
std::string getPackageName () const
 
void setPath (const std::string &path)
 

Static Public Attributes

static const std::string DefaultPackageName = "PriorKnowledgeData"
 
static const std::string DefaultRelativeDirectory = "humans/profiles"
 

Detailed Description

Used to find human profiles in the Prior Knowledge Data repository [1].

See also
[1] https://gitlab.com/ArmarX/PriorKnowledgeData

Definition at line 19 of file Finder.h.

Member Typedef Documentation

◆ Info

Definition at line 23 of file Finder.h.

◆ path

using path = std::filesystem::path

Definition at line 22 of file Finder.h.

Constructor & Destructor Documentation

◆ Finder()

Finder ( const std::string &  packageName = DefaultPackageName,
const path relativeDirectory = DefaultRelativeDirectory 
)

Definition at line 17 of file Finder.cpp.

+ Here is the call graph for this function:

Member Function Documentation

◆ find()

std::optional< armarx::armem::human::Info > find ( const std::string &  name) const

Definition at line 71 of file Finder.cpp.

◆ findAll()

std::vector< armarx::armem::human::Info > findAll ( bool  checkPaths = true) const

Definition at line 87 of file Finder.cpp.

+ Here is the caller graph for this function:

◆ getPackageName()

std::string getPackageName ( ) const

Definition at line 31 of file Finder.cpp.

◆ setPath()

void setPath ( const std::string &  path)

Definition at line 24 of file Finder.cpp.

Member Data Documentation

◆ DefaultPackageName

const std::string DefaultPackageName = "PriorKnowledgeData"
inlinestatic

Definition at line 25 of file Finder.h.

◆ DefaultRelativeDirectory

const std::string DefaultRelativeDirectory = "humans/profiles"
inlinestatic

Definition at line 26 of file Finder.h.


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