yarp::os::IConfig Class Reference

An object that can be configured. More...

#include <yarp/os/IConfig.h>

Inheritance diagram for yarp::os::IConfig:

Public Member Functions
virtual	~IConfig ()
	Destructor.
virtual bool	open (Searchable &config)
	Initialize the object.
virtual bool	close ()
	Shut the object down.
virtual bool	configure (Searchable &config)
	Change online parameters.

Detailed Description

An object that can be configured.

When possible, we separate out the configuration for modules and devices into external files, command line options, or GUIs.

Definition at line 22 of file IConfig.h.

Constructor & Destructor Documentation

~IConfig()

yarp::os::IConfig::~IConfig ( )

virtualdefault

Destructor.

Member Function Documentation

close()

bool yarp::os::IConfig::close ( )

virtual

Shut the object down.

You should override this.

Returns

true/false on success/failure.

Reimplemented in yarp::dev::OVRHeadset, pylonCameraDriver, realsense2Driver, realsense2Tracking, realsense2withIMUDriver, RpLidar, RpLidar2, RpLidar3, RpLidar4, WhisperSpeechTranscription, DeviceTemplate, UltraPythonDriver, GPTDevice, ControlBoard_nws_ros, FrameGrabber_nws_ros, FrameTransformGet_nwc_ros, FrameTransformSet_nwc_ros, LaserFromRosTopic, Localization2D_nws_ros, Map2D_nws_ros, MobileBaseVelocityControl_nws_ros, GenericSensorRosPublisher< ROS_MSG >, GenericSensorRosPublisher< yarp::rosmsg::geometry_msgs::PoseStamped >, GenericSensorRosPublisher< yarp::rosmsg::geometry_msgs::WrenchStamped >, GenericSensorRosPublisher< yarp::rosmsg::sensor_msgs::Imu >, GenericSensorRosPublisher< yarp::rosmsg::sensor_msgs::MagneticField >, GenericSensorRosPublisher< yarp::rosmsg::sensor_msgs::Temperature >, Odometry2D_nws_ros, Rangefinder2D_nws_ros, RgbdSensor_nws_ros, RGBDSensorFromRosTopic, RGBDToPointCloudSensor_nws_ros, Battery_nws_ros2, ControlBoard_nws_ros2, FrameGrabber_nws_ros2, FrameTransformGet_nwc_ros2, FrameTransformSet_nwc_ros2, Localization2D_nws_ros2, Map2D_nws_ros2, MobileBaseVelocityControl_nws_ros2, GenericSensor_nwc_ros2< ROS_MSG >, GenericSensor_nwc_ros2< sensor_msgs::msg::Imu >, GenericSensor_nws_ros2< ROS_MSG >, GenericSensor_nws_ros2< geometry_msgs::msg::WrenchStamped >, GenericSensor_nws_ros2< sensor_msgs::msg::Imu >, Odometry2D_nws_ros2, Rangefinder2D_controlBoard_nws_ros2, Rangefinder2D_nwc_ros2, Rangefinder2D_nws_ros2, RgbdSensor_nwc_ros2, RgbdSensor_nws_ros2, RgbdToPointCloudSensor_nws_ros2, Ros2Test, AnalogSensorClient, AnalogWrapper, audioFromFileDevice, AudioPlayerWrapper, AudioRecorder_nwc_yarp, AudioRecorder_nws_yarp, AudioRecorderWrapper, audioToFileDevice, Battery_nwc_yarp, Battery_nws_yarp, ChatBot_nwc_yarp, ChatBot_nws_yarp, ControlBoard_nws_yarp, ControlBoardRemapper, RemoteControlBoardRemapper, DynamixelAX12FtdiDriver, FakeAnalogSensor, FakeBattery, FakeBot, fakeDepthCameraDriver, FakeFrameGrabber, fakeIMU, FakeJointCoupling, FakeJoypad, FakeLaser, FakeLaserWithMotor, fakeLocalizer, fakeMicrophone, FakeMotionControl, FakeMotionControlMicro, fakeNavigation, FakeOdometry2D, FakePositionSensor, FakeSerialPort, fakeSpeaker, FakeSpeechSynthesizer, FakeSpeechTranscription, FfmpegGrabber, FfmpegWriter, FrameGrabber_nwc_yarp, FrameGrabber_nws_yarp, FrameGrabberCropper, FrameTransformClient, FrameTransformGet_nwc_yarp, FrameTransformGet_nws_yarp, FrameTransformGetMultiplexer, FrameTransformServer, FrameTransformSet_nwc_yarp, FrameTransformSet_nws_yarp, FrameTransformSetMultiplexer, FrameTransformStorage, BoschIMU, JoypadControlClient, JoypadControlServer, LaserFromDepth, LaserFromExternalPort, LaserFromPointCloud, laserHokuyo, LLM_nwc_yarp, LLM_nws_yarp, Localization2D_nwc_yarp, Localization2D_nws_yarp, Map2D_nwc_yarp, Map2D_nws_yarp, Map2DStorage, MobileBaseVelocityControl_nwc_yarp, MobileBaseVelocityControl_nws_yarp, MultipleAnalogSensorsClient, MultipleAnalogSensorsRemapper, MultipleAnalogSensorsServer, Navigation2D_nwc_yarp, navigation2D_nws_yarp, Odometry2D_nws_yarp, OpenCVGrabber, depthCameraDriver, PortAudioDeviceDriver, PortAudioPlayerDeviceDriver, PortAudioRecorderDeviceDriver, Rangefinder2D_nwc_yarp, Rangefinder2D_nws_yarp, Rangefinder2DClient, RemoteControlBoard, RgbdSensor_nws_yarp, RGBDSensorClient, RobotDescriptionClient, RobotDescriptionServer, SDLJoypad, SerialDeviceDriver, SerialPort_nwc_yarp, SerialPort_nws_yarp, SerialServoBoard, SpeechSynthesizer_nwc_yarp, SpeechSynthesizer_nws_yarp, SpeechTranscription_nwc_yarp, SpeechTranscription_nws_yarp, Nop, SegFault, UpowerBattery, USBCameraDriver, V4L_camera, VirtualAnalogWrapper, yarp::dev::DeviceDriver, StubDriver, and yarp::dev::PolyDriver.

Definition at line 18 of file IConfig.cpp.

configure()

bool yarp::os::IConfig::configure ( Searchable &  config )

virtual

Change online parameters.

The parameters that can be changed online (in other words, without closing and reopening) will vary between objects.

Parameters

config

A list of parameters for the object.

Returns

true/false on success/failure.

Reimplemented in DynamixelAX12FtdiDriver.

Definition at line 23 of file IConfig.cpp.

open()

bool yarp::os::IConfig::open ( Searchable &  config )

virtual

Initialize the object.

You should override this.

Parameters

config

is a list of parameters for the object. Which parameters are effective for your object can vary.

Returns

true/false upon success/failure

Reimplemented in RemoteControlBoard, SerialServoBoard, SerialPort_nwc_yarp, yarp::dev::OVRHeadset, pylonCameraDriver, realsense2Driver, realsense2Tracking, realsense2withIMUDriver, RpLidar, RpLidar2, RpLidar3, RpLidar4, WhisperSpeechTranscription, DeviceTemplate, UltraPythonDriver, GPTDevice, FrameGrabber_nws_ros, FrameTransformGet_nwc_ros, FrameTransformSet_nwc_ros, LaserFromRosTopic, MobileBaseVelocityControl_nws_ros, RGBDSensorFromRosTopic, FrameGrabber_nws_ros2, FrameTransformGet_nwc_ros2, FrameTransformSet_nwc_ros2, Localization2D_nws_ros2, Map2D_nws_ros2, MobileBaseVelocityControl_nws_ros2, Rangefinder2D_controlBoard_nws_ros2, Rangefinder2D_nwc_ros2, Rangefinder2D_nws_ros2, RgbdSensor_nwc_ros2, RgbdSensor_nws_ros2, RgbdToPointCloudSensor_nws_ros2, Ros2Test, AnalogSensorClient, audioFromFileDevice, AudioRecorder_nwc_yarp, AudioRecorder_nws_yarp, AudioRecorderWrapper, audioToFileDevice, Battery_nwc_yarp, ChatBot_nwc_yarp, ChatBot_nws_yarp, DynamixelAX12FtdiDriver, FakeAnalogSensor, FakeBattery, FakeBot, fakeDepthCameraDriver, FakeFrameGrabber, fakeIMU, FakeJoypad, FakeLaser, FakeLaserWithMotor, fakeLocalizer, fakeMicrophone, fakeNavigation, FakeOdometry2D, FakePositionSensor, FakeSerialPort, fakeSpeaker, FakeSpeechSynthesizer, FakeSpeechTranscription, FfmpegGrabber, FfmpegWriter, FrameGrabber_nwc_yarp, FrameGrabber_nws_yarp, FrameGrabberCropper, FrameTransformClient, FrameTransformGetMultiplexer, FrameTransformServer, FrameTransformSet_nwc_yarp, FrameTransformSet_nws_yarp, FrameTransformSetMultiplexer, FrameTransformStorage, BoschIMU, JoypadControlClient, LaserFromDepth, LaserFromExternalPort, LaserFromPointCloud, laserHokuyo, LLM_nwc_yarp, Localization2D_nwc_yarp, Map2D_nwc_yarp, MobileBaseVelocityControl_nwc_yarp, MobileBaseVelocityControl_nws_yarp, MultipleAnalogSensorsClient, MultipleAnalogSensorsRemapper, Navigation2D_nwc_yarp, OpenCVGrabber, depthCameraDriver, PortAudioDeviceDriver, PortAudioPlayerDeviceDriver, PortAudioRecorderDeviceDriver, Rangefinder2D_nwc_yarp, Rangefinder2DClient, RGBDSensorClient, RobotDescriptionClient, RobotDescriptionServer, SDLJoypad, SerialDeviceDriver, SerialPort_nws_yarp, SpeechSynthesizer_nwc_yarp, SpeechSynthesizer_nws_yarp, SpeechTranscription_nwc_yarp, SpeechTranscription_nws_yarp, Nop, SegFault, UpowerBattery, USBCameraDriver, V4L_camera, VirtualAnalogWrapper, yarp::dev::DeviceDriver, StubDriver, yarp::dev::PolyDriver, yarp::dev::PolyDriver, FakeJointCoupling, FakeMotionControl, FakeMotionControlMicro, Map2D_nws_ros, GenericSensorRosPublisher< ROS_MSG >, GenericSensorRosPublisher< yarp::rosmsg::geometry_msgs::PoseStamped >, GenericSensorRosPublisher< yarp::rosmsg::geometry_msgs::WrenchStamped >, GenericSensorRosPublisher< yarp::rosmsg::sensor_msgs::Imu >, GenericSensorRosPublisher< yarp::rosmsg::sensor_msgs::MagneticField >, GenericSensorRosPublisher< yarp::rosmsg::sensor_msgs::Temperature >, Odometry2D_nws_ros, Rangefinder2D_nws_ros, RgbdSensor_nws_ros, RGBDToPointCloudSensor_nws_ros, Battery_nws_ros2, GenericSensor_nwc_ros2< ROS_MSG >, GenericSensor_nwc_ros2< sensor_msgs::msg::Imu >, GenericSensor_nws_ros2< ROS_MSG >, GenericSensor_nws_ros2< geometry_msgs::msg::WrenchStamped >, GenericSensor_nws_ros2< sensor_msgs::msg::Imu >, Odometry2D_nws_ros2, AnalogWrapper, AudioPlayerWrapper, Battery_nws_yarp, FrameTransformGet_nwc_yarp, FrameTransformGet_nws_yarp, JoypadControlServer, Map2D_nws_yarp, Map2DStorage, MultipleAnalogSensorsServer, Odometry2D_nws_yarp, Rangefinder2D_nws_yarp, RgbdSensor_nws_yarp, ControlBoard_nws_ros, Localization2D_nws_ros, ControlBoard_nws_ros2, ControlBoard_nws_yarp, ControlBoardRemapper, RemoteControlBoardRemapper, LLM_nws_yarp, Localization2D_nws_yarp, and navigation2D_nws_yarp.

Definition at line 12 of file IConfig.cpp.

---

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

• src/libYARP_os/src/yarp/os/IConfig.h
• src/libYARP_os/src/yarp/os/IConfig.cpp