#include <CartesianControlServer_ParamsParser.h>

Inheritance diagram for CartesianControlServer_ParamsParser:

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 = {"CartesianControlServer"}

const std::string	m_device_name = {"CartesianControlServer"}

bool	m_parser_is_strict = false

const parser_version_type	m_parser_version = {}

const std::string	m_name_defaultValue = {"/CartesianServer"}

const std::string	m_fkPeriod_defaultValue = {"20"}

const std::string	m_coordRepr_defaultValue = {"cartesian"}

const std::string	m_angleRepr_defaultValue = {"axisAngleScaled"}

const std::string	m_angularUnits_defaultValue = {"degrees"}

std::string	m_name = {"/CartesianServer"}

int	m_fkPeriod = {20}

std::string	m_coordRepr = {"cartesian"}

std::string	m_angleRepr = {"axisAngleScaled"}

std::string	m_angularUnits = {"degrees"}

Detailed Description

This class is the parameters parser for class CartesianControlServer.

These are the used parameters:

Group name	Parameter name	Type	Units	Default Value	Description	Notes
-	name	string	-	/CartesianServer	local port prefix	-
-	fkPeriod	int	ms	20	FK stream period	-
-	coordRepr	string	-	cartesian	coordinate representation for transform port	cartesian, cylindrical, spherical, none
-	angleRepr	string	-	axisAngleScaled	angle representation for transform port	axisAngle, axisAngleScaled, RPY, eulerYZ, eulerZYZ, polarAzimuth, none
-	angularUnits	string	-	degrees	angle representation for transform port	degrees, radians

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

yarpdev --device CartesianControlServer --name /CartesianServer --fkPeriod 20 --coordRepr cartesian --angleRepr axisAngleScaled --angularUnits degrees

yarpdev --device CartesianControlServer

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

libraries/YarpPlugins/CartesianControlServer/CartesianControlServer_ParamsParser.h
libraries/YarpPlugins/CartesianControlServer/CartesianControlServer_ParamsParser.cpp

Classes

Public Member Functions

Public Attributes

Detailed Description