fingersTuner_IDL Class Reference

fingersTuner_IDL IDL Interface to Fingers PID Tuner services. More...

#include <fingersTuner_IDL.h>

Inheritance diagram for fingersTuner_IDL:

Public Member Functions
	fingersTuner_IDL ()
virtual bool	sync (const std::string &part, const yarp::os::Value &val)
	Synchronize PID values with values stored in the configuration file.
virtual bool	tune (const std::string &part, const yarp::os::Value &val)
	Tune PID of a joint or a set of joints.
virtual bool	save ()
	Save the PID parameters on configuration file.
virtual bool	quit ()
	Quit the module.
virtual bool	read (yarp::os::ConnectionReader &connection) override
virtual std::vector< std::string >	help (const std::string &functionName="--all")

Detailed Description

fingersTuner_IDL IDL Interface to Fingers PID Tuner services.

Definition at line 17 of file fingersTuner_IDL.h.

Constructor & Destructor Documentation

fingersTuner_IDL()

fingersTuner_IDL::fingersTuner_IDL

(

)

Member Function Documentation

help()

virtual std::vector< std::string > fingersTuner_IDL::help ( const std::string &  functionName = "--all" )

virtual

quit()

virtual bool fingersTuner_IDL::quit ( )

virtual

Quit the module.

Returns

true/false on success/failure.

Reimplemented in TunerModule.

read()

virtual bool fingersTuner_IDL::read ( yarp::os::ConnectionReader &  connection )

overridevirtual

save()

virtual bool fingersTuner_IDL::save ( )

virtual

Save the PID parameters on configuration file.

Returns

true/false on success/failure.

Reimplemented in TunerModule.

sync()

virtual bool fingersTuner_IDL::sync ( const std::string &  part, const yarp::os::Value &  val  )

virtual

Synchronize PID values with values stored in the configuration file.

Parameters

part	specifies the part name as per configuration file.
val	accounts for a single joint if the corresponding integer is given or a set of joints if the corresponding alias is provided as defined within the configuration file.

Returns

true/false on success/failure.

tune()

virtual bool fingersTuner_IDL::tune ( const std::string &  part, const yarp::os::Value &  val  )

virtual

Tune PID of a joint or a set of joints.

Parameters

part	specifies the part name as per configuration file.
val	accounts for a single joint if the corresponding integer is given or a set of joints if the corresponding alias is provided as defined within the configuration file.

Returns

true/false on success/failure.

---

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

• icub-main/src/tools/fingersTuner/idl_dox/fingersTuner_IDL.h