Info Class Reference

Accessor for human profile files. More...

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

Public Types

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

Public Member Functions

virtual bool checkPaths () const
 Checks the existence of expected files. More...
 
PackagePath faceImageDir () const
 
std::vector< PackagePathfaceImages (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. More...
 
std::optional< ProfileloadProfile () 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.

Definition at line 20 of file Info.h.

Member Typedef Documentation

◆ path

using path = std::filesystem::path

Definition at line 23 of file Info.h.

◆ Profile

using Profile = armarx::human::arondto::Profile

Definition at line 24 of file Info.h.

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.

Definition at line 25 of file Info.cpp.

◆ ~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.

Definition at line 152 of file Info.cpp.

+ Here is the call graph for this function:

◆ faceImageDir()

PackagePath faceImageDir ( ) const

Definition at line 88 of file Info.cpp.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ faceImages()

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

Definition at line 94 of file Info.cpp.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ file()

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

Definition at line 61 of file Info.cpp.

+ Here is the caller graph for this function:

◆ id()

std::string id ( ) const

Definition at line 49 of file Info.cpp.

+ Here is the caller graph for this function:

◆ loadProfile()

std::optional< Info::Profile > loadProfile ( ) const

Definition at line 117 of file Info.cpp.

+ Here is the call graph for this function:

◆ package()

std::string package ( ) const

Definition at line 43 of file Info.cpp.

◆ profileJson()

PackagePath profileJson ( ) const

Definition at line 82 of file Info.cpp.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ setLogError()

void setLogError ( bool  enabled)

Definition at line 37 of file Info.cpp.

◆ sub_directory()

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

Definition at line 75 of file Info.cpp.

+ Here is the caller graph for this function:

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