Info Class Reference

Accessor for human profile files. More...

#include <VisionX/libraries/armem_human/Info.h>

Public Types

using path = std::filesystem::path
 
using Person = armarx::human::arondto::Person
 

Public Member Functions

virtual bool checkPaths () const
 Checks the existence of expected files.
 
PackagePath faceImageDir () const
 
std::vector< PackagePath > faceImages (const std::vector< std::string > &extensions={".png", ".jpg"}) const
 
PackagePath file (const std::string &extension, const std::string &suffix="") const
 
std::string id () const
 
 Info (const std::string &packageName, const path &absPackageDataDir, const path &relativePath, const std::string &id)
 Info.
 
std::optional< Person > loadProfile (const bool loadFaceImages=true) const
 
std::string package () const
 
PackagePath profileJson () const
 
void setLogError (bool enabled)
 
PackagePath sub_directory (const std::string &suffix) const
 
virtual ~Info ()=default
 

Detailed Description

Accessor for human profile files.

Member Typedef Documentation

◆ path

using path = std::filesystem::path

◆ Person

using Person = armarx::human::arondto::Person

Constructor & Destructor Documentation

◆ Info()

Info ( const std::string & packageName,
const path & absPackageDataDir,
const path & relativePath,
const std::string & id )

Info.

Parameters
packageNameThe ArmarX package.
absPackageDataDirAbsolute path to the package's data directory.
relativePathThe path where human profiles are stored in the data directory.
idThe human profile ID.

◆ ~Info()

virtual ~Info ( )
virtualdefault

Member Function Documentation

◆ checkPaths()

bool checkPaths ( ) const
virtual

Checks the existence of expected files.

If a file is does not exist, emits a warning returns false.

Returns
True if all existing files are found, false otherwise.

◆ faceImageDir()

PackagePath faceImageDir ( ) const

◆ faceImages()

std::vector< PackagePath > faceImages ( const std::vector< std::string > & extensions = {".png", ".jpg"}) const

◆ file()

PackagePath file ( const std::string & extension,
const std::string & suffix = "" ) const

◆ id()

std::string id ( ) const

◆ loadProfile()

std::optional< Info::Person > loadProfile ( const bool loadFaceImages = true) const

◆ package()

std::string package ( ) const

◆ profileJson()

PackagePath profileJson ( ) const

◆ setLogError()

void setLogError ( bool enabled)

◆ sub_directory()

PackagePath sub_directory ( const std::string & suffix) const

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