tools
Loading...
Searching...
No Matches
Classes | Public Member Functions | Public Attributes | List of all members
PlaybackThread_ParamsParser Class Reference

#include <PlaybackThread_ParamsParser.h>

Inheritance diagram for PlaybackThread_ParamsParser:
PlaybackThread

Classes

struct  parser_version_type
 

Public Member Functions

bool parseParams (const yarp::os::Searchable &config) override
 
std::string getDeviceClassName () const override
 
std::string getDeviceName () const override
 
std::string getDocumentationOfDeviceParams () const override
 
std::vector< std::string > getListOfParams () const override
 

Public Attributes

const std::string m_device_classname = {"PlaybackThread"}
 
const std::string m_device_name = {"PlaybackThread"}
 
bool m_parser_is_strict = false
 
const parser_version_type m_parser_version = {}
 
const std::string m_file_defaultValue = {"test.txt"}
 
const std::string m_timeIdx_defaultValue = {"0"}
 
const std::string m_timeScale_defaultValue = {"1.0"}
 
const std::string m_mask_defaultValue = {""}
 
std::string m_file = {"test.txt"}
 
int m_timeIdx = {0}
 
double m_timeScale = {1.0}
 
std::vector< int > m_mask = {}
 

Detailed Description

This class is the parameters parser for class PlaybackThread.

These are the used parameters:

Group name Parameter name Type Units Default Value Required Description Notes
- file string - test.txt 0 file name -
- timeIdx int - 0 0 index of timestamp -
- timeScale double - 1.0 0 time scaling of timestamp -
- mask vector<int> - - 1 filter to apply to each item in a row 1: process, 0: ignore

The device can be launched by yarpdev using one of the following examples (with and without all optional parameters):

yarpdev --device PlaybackThread --file test.txt --timeIdx 0 --timeScale 1.0 --mask <mandatory_value>
yarpdev --device PlaybackThread --mask <mandatory_value>

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