robometry::BufferConfig struct

Struct containing the parameters for configuring a robometry::BufferManager.

Public variables

std::string yarp_robot_name
std::vector<std::string> description_list
< The yarp robot name associated to the machine where the logger runs
std::string path
< the description list, e.g.
std::string filename
the file name, to it will be appended the suffix "_<timestamp>.mat".
size_t n_samples
the max number of samples contained in the buffer/s
double save_period
the period in sec of the save thread
size_t data_threshold
the save thread saves to a file if there are at least data_threshold samples
bool auto_save
the flag for enabling the save in the destructor of the robometry::BufferManager
bool save_periodically
the flag for enabling the periodic save thread.
std::vector<ChannelInfo> channels
the list of pairs representing the channels(variables)
bool enable_compression
the flag for enabling the zlib compression
std::string file_indexing
String representing the indexing mode.
matioCpp::FileVersion mat_file_version
Version of the saved matfile.

Variable documentation

std::string robometry::BufferConfig::path

< the description list, e.g.

it can contain the axes names that are logged the path in which the files will be saved.

std::string robometry::BufferConfig::file_indexing

String representing the indexing mode.

If the variable is set to time_since_epoch, BufferManager::m_nowFunction is used. Othewrise std::put_time is used to generate the indexing. https://en.cppreference.com/w/cpp/io/manip/put_time

matioCpp::FileVersion robometry::BufferConfig::mat_file_version

Version of the saved matfile.