Finder Class Reference

Finds the human profiles of one source: a directory in an ArmarX package, by default humans/profiles in the Prior Knowledge Data repository [1], or an absolute directory. 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< Info > find (const std::string &name) const
 
std::vector< Info > findAll (bool checkPaths=true) const
 
 Finder (const Source &source)
 
 Finder (const std::string &packageName=DefaultPackageName, const path &relativeDirectory=DefaultRelativeDirectory)
 
std::string getPackageName () const
 Empty for an absolute directory.
 
const Source & getSource () const
 
void setPath (const std::string &path)
 Sets the package (keeps the directory).
 

Static Public Attributes

static const std::string DefaultPackageName = "PriorKnowledgeData"
 
static const std::string DefaultRelativeDirectory
 

Detailed Description

Finds the human profiles of one source: a directory in an ArmarX package, by default humans/profiles in the Prior Knowledge Data repository [1], or an absolute directory.

See also
[1] https://git.h2t.iar.kit.edu/sw/armarx/prior-knowledge-data

Member Typedef Documentation

◆ Info

◆ path

using path = std::filesystem::path

Constructor & Destructor Documentation

◆ Finder() [1/2]

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

◆ Finder() [2/2]

Finder ( const Source & source)

Member Function Documentation

◆ find()

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

◆ findAll()

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

◆ getPackageName()

std::string getPackageName ( ) const

Empty for an absolute directory.

◆ getSource()

const Source & getSource ( ) const

◆ setPath()

void setPath ( const std::string & path)

Sets the package (keeps the directory).

Member Data Documentation

◆ DefaultPackageName

const std::string DefaultPackageName = "PriorKnowledgeData"
inlinestatic

◆ DefaultRelativeDirectory

const std::string DefaultRelativeDirectory
inlinestatic
Initial value:
=
static const path DefaultRelativeDirectory
Definition Source.h:26

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