An object that can be configured. More...
#include <yarp/os/IConfig.h>
Public Member Functions | |
virtual | ~IConfig () |
Destructor. More... | |
virtual bool | open (Searchable &config) |
Initialize the object. More... | |
virtual bool | close () |
Shut the object down. More... | |
virtual bool | configure (Searchable &config) |
Change online parameters. More... | |
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.
|
virtualdefault |
Destructor.
|
virtual |
Shut the object down.
You should override this.
Reimplemented in yarp::dev::OVRHeadset, pylonCameraDriver, realsense2Driver, realsense2Tracking, realsense2withIMUDriver, RpLidar, RpLidar2, RpLidar3, RpLidar4, UltraPythonDriver, ControlBoard_nws_ros2, FrameGrabber_nws_ros2, FrameTransformGet_nwc_ros2, FrameTransformSet_nwc_ros2, Localization2D_nws_ros2, Map2D_nws_ros2, MobileBaseVelocityControl_nws_ros2, GenericSensor_nws_ros2< ROS_MSG >, GenericSensor_nws_ros2< geometry_msgs::msg::WrenchStamped >, Odometry2D_nws_ros2, Rangefinder2D_controlBoard_nws_ros2, Rangefinder2D_nws_ros2, RgbdSensor_nwc_ros2, RgbdSensor_nws_ros2, RgbdToPointCloudSensor_nws_ros2, Ros2Test, AnalogSensorClient, AnalogWrapper, audioFromFileDevice, AudioPlayerWrapper, AudioRecorderWrapper, audioToFileDevice, BatteryClient, BatteryWrapper, ControlBoard_nws_ros, ControlBoardRemapper, RemoteControlBoardRemapper, ControlBoard_nws_ros, ControlBoard_nws_yarp, ControlBoardWrapper, depthCameraDriver, DeviceGroup, DevicePipe, DynamixelAX12FtdiDriver, FakeAnalogSensor, FakeBattery, FakeBot, fakeDepthCameraDriver, FakeFrameGrabber, fakeIMU, FakeLaser, fakeLocalizer, fakeMicrophone, FakeMotionControl, fakeNavigation, FakeOdometry, FakePositionSensor, fakeSpeaker, FfmpegGrabber, FfmpegWriter, FrameGrabberCropper, FrameTransformClient, FrameTransformGet_nwc_ros, FrameTransformGet_nwc_yarp, FrameTransformGet_nws_yarp, FrameTransformGetMultiplexer, FrameTransformServer, FrameTransformSet_nwc_ros, FrameTransformSet_nwc_yarp, FrameTransformSet_nws_yarp, FrameTransformSetMultiplexer, FrameTransformStorage, BoschIMU, JoypadControlClient, JoypadControlServer, LaserFromDepth, LaserFromExternalPort, LaserFromPointCloud, LaserFromRosTopic, laserHokuyo, Localization2D_nwc_yarp, Localization2D_nws_ros, Localization2D_nws_yarp, Map2D_nwc_yarp, Map2D_nws_ros, Map2D_nws_yarp, Map2DStorage, MobileBaseVelocityControl_nwc_yarp, MobileBaseVelocityControl_nws_ros, MobileBaseVelocityControl_nws_yarp, MultipleAnalogSensorsClient, MultipleAnalogSensorsRemapper, GenericSensorRosPublisher< ROS_MSG >, GenericSensorRosPublisher< yarp::rosmsg::sensor_msgs::Imu >, GenericSensorRosPublisher< yarp::rosmsg::sensor_msgs::MagneticField >, GenericSensorRosPublisher< yarp::rosmsg::geometry_msgs::PoseStamped >, GenericSensorRosPublisher< yarp::rosmsg::sensor_msgs::Temperature >, GenericSensorRosPublisher< yarp::rosmsg::geometry_msgs::WrenchStamped >, MultipleAnalogSensorsServer, Navigation2D_nwc_yarp, navigation2D_nws_yarp, Odometry2D_nws_ros, Odometry2D_nws_yarp, OpenCVGrabber, PortAudioDeviceDriver, PortAudioPlayerDeviceDriver, PortAudioRecorderDeviceDriver, Rangefinder2D_nws_ros, Rangefinder2D_nws_yarp, Rangefinder2DClient, RemoteControlBoard, FrameGrabber_nwc_yarp, RemoteFrameGrabber, RgbdSensor_nws_ros, RgbdSensor_nws_yarp, RGBDSensorClient, RGBDSensorFromRosTopic, RGBDSensorWrapper, RGBDToPointCloudSensor_nws_ros, RobotDescriptionClient, RobotDescriptionServer, SDLJoypad, SerialDeviceDriver, SerialServoBoard, FrameGrabber_nws_ros, FrameGrabber_nws_yarp, ServerGrabber, ServerInertial, ServerSerial, Nop, SegFault, TransformClient, TransformServer, UpowerBattery, USBCameraDriver, V4L_camera, VirtualAnalogWrapper, yarp::dev::DeviceDriver, StubDriver, and yarp::dev::PolyDriver.
Definition at line 18 of file IConfig.cpp.
|
virtual |
Change online parameters.
The parameters that can be changed online (in other words, without closing and reopening) will vary between objects.
config | A list of parameters for the object. |
Reimplemented in DynamixelAX12FtdiDriver.
Definition at line 23 of file IConfig.cpp.
|
virtual |
Initialize the object.
You should override this.
config | is a list of parameters for the object. Which parameters are effective for your object can vary. |
Reimplemented in RemoteControlBoard, SerialServoBoard, ServerSerial, yarp::dev::OVRHeadset, pylonCameraDriver, realsense2Driver, realsense2Tracking, realsense2withIMUDriver, RpLidar, RpLidar2, RpLidar3, RpLidar4, UltraPythonDriver, FrameGrabber_nws_ros2, FrameTransformGet_nwc_ros2, FrameTransformSet_nwc_ros2, Localization2D_nws_ros2, Map2D_nws_ros2, MobileBaseVelocityControl_nws_ros2, Rangefinder2D_controlBoard_nws_ros2, Rangefinder2D_nws_ros2, RgbdSensor_nwc_ros2, RgbdSensor_nws_ros2, RgbdToPointCloudSensor_nws_ros2, Ros2Test, AnalogSensorClient, audioFromFileDevice, AudioRecorderWrapper, audioToFileDevice, BatteryClient, depthCameraDriver, DeviceGroup, DevicePipe, DynamixelAX12FtdiDriver, FakeAnalogSensor, FakeBattery, FakeBot, fakeDepthCameraDriver, FakeFrameGrabber, fakeIMU, FakeLaser, fakeLocalizer, fakeMicrophone, fakeNavigation, FakeOdometry, FakePositionSensor, fakeSpeaker, FfmpegGrabber, FfmpegWriter, FrameGrabberCropper, FrameTransformClient, FrameTransformGet_nwc_ros, FrameTransformGetMultiplexer, FrameTransformServer, FrameTransformSet_nwc_ros, FrameTransformSet_nwc_yarp, FrameTransformSet_nws_yarp, FrameTransformSetMultiplexer, FrameTransformStorage, BoschIMU, JoypadControlClient, LaserFromDepth, LaserFromExternalPort, LaserFromPointCloud, LaserFromRosTopic, laserHokuyo, Localization2D_nwc_yarp, Map2D_nwc_yarp, MobileBaseVelocityControl_nwc_yarp, MobileBaseVelocityControl_nws_ros, MobileBaseVelocityControl_nws_yarp, MultipleAnalogSensorsClient, MultipleAnalogSensorsRemapper, Navigation2D_nwc_yarp, OpenCVGrabber, PortAudioDeviceDriver, PortAudioPlayerDeviceDriver, PortAudioRecorderDeviceDriver, Rangefinder2DClient, FrameGrabber_nwc_yarp, RemoteFrameGrabber, RGBDSensorClient, RGBDSensorFromRosTopic, RobotDescriptionClient, RobotDescriptionServer, SDLJoypad, SerialDeviceDriver, FrameGrabber_nws_ros, FrameGrabber_nws_yarp, ServerGrabber, ServerInertial, Nop, SegFault, TransformClient, UpowerBattery, USBCameraDriver, V4L_camera, VirtualAnalogWrapper, yarp::dev::DeviceDriver, StubDriver, yarp::dev::PolyDriver, yarp::dev::PolyDriver, FakeMotionControl, GenericSensor_nws_ros2< ROS_MSG >, GenericSensor_nws_ros2< geometry_msgs::msg::WrenchStamped >, Odometry2D_nws_ros2, AnalogWrapper, AudioPlayerWrapper, BatteryWrapper, FrameTransformGet_nwc_yarp, FrameTransformGet_nws_yarp, JoypadControlServer, Map2D_nws_ros, Map2D_nws_yarp, Map2DStorage, GenericSensorRosPublisher< ROS_MSG >, GenericSensorRosPublisher< yarp::rosmsg::sensor_msgs::Imu >, GenericSensorRosPublisher< yarp::rosmsg::sensor_msgs::MagneticField >, GenericSensorRosPublisher< yarp::rosmsg::geometry_msgs::PoseStamped >, GenericSensorRosPublisher< yarp::rosmsg::sensor_msgs::Temperature >, GenericSensorRosPublisher< yarp::rosmsg::geometry_msgs::WrenchStamped >, MultipleAnalogSensorsServer, Odometry2D_nws_ros, Odometry2D_nws_yarp, Rangefinder2D_nws_ros, Rangefinder2D_nws_yarp, RgbdSensor_nws_ros, RgbdSensor_nws_yarp, RGBDSensorWrapper, RGBDToPointCloudSensor_nws_ros, TransformServer, ControlBoard_nws_ros2, ControlBoard_nws_ros, ControlBoardRemapper, RemoteControlBoardRemapper, ControlBoard_nws_ros, ControlBoard_nws_yarp, ControlBoardWrapper, Localization2D_nws_ros, Localization2D_nws_yarp, and navigation2D_nws_yarp.
Definition at line 12 of file IConfig.cpp.