YARP
Yet Another Robot Platform
yarp::os::IConfig Class Reference

An object that can be configured. More...

#include <yarp/os/IConfig.h>

+ Inheritance diagram for yarp::os::IConfig:

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 26 of file 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...
 

Constructor & Destructor Documentation

◆ ~IConfig()

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

Destructor.

Member Function Documentation

◆ close()

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

Shut the object down.

You should override this.

Returns
true/false on success/failure.

Reimplemented in yarp::dev::RemoteControlBoard, yarp::dev::RemoteFrameGrabber, yarp::dev::ControlBoardWrapper, yarp::dev::TestMotor, yarp::dev::FakeMotionControl, yarp::dev::ServerGrabber, yarp::dev::RGBDSensorWrapper, RpLidar, yarp::dev::depthCameraDriver, yarp::dev::FakeBot, yarp::dev::BoschIMU, yarp::dev::ControlBoardRemapper, yarp::dev::RGBDSensorClient, StubDriver, yarp::dev::DynamixelAX12FtdiDriver, yarp::dev::AnalogWrapper, yarp::dev::MultipleAnalogSensorsRemapper, yarp::dev::ServerInertial, SerialServoBoard, yarp::dev::realsense2Driver, FakeLaser, yarp::dev::RemoteControlBoardRemapper, yarp::dev::ServerSoundGrabber, yarp::dev::FrameTransformClient, yarp::dev::ServerSerial, yarp::dev::AnalogSensorClient, yarp::dev::ServerFrameGrabber, yarp::dev::Rangefinder2DClient, yarp::dev::PolyDriver, yarp::dev::SerialDeviceDriver, yarp::dev::PortAudioDeviceDriver, yarp::dev::BatteryClient, laserHokuyo, yarp::dev::FrameTransformServer, yarp::dev::MultipleAnalogSensorsClient, RpLidar2, LaserFromDepth, yarp::dev::MultipleAnalogSensorsServer, yarp::dev::JoypadControlServer, yarp::dev::Map2DServer, yarp::dev::SDLJoypad, yarp::dev::VirtualAnalogWrapper, yarp::dev::OpenCVGrabber, yarp::dev::OVRHeadset, yarp::dev::JoypadControlClient, yarp::dev::FfmpegGrabber, yarp::dev::Navigation2DClient, yarp::dev::Localization2DClient, yarp::dev::Rangefinder2DWrapper, yarp::dev::TestFrameGrabber, yarp::dev::BatteryWrapper, yarp::dev::Map2DClient, yarp::dev::FfmpegWriter, yarp::dev::DeviceDriver, yarp::dev::RobotDescriptionServer, yarp::dev::RobotDescriptionClient, yarp::dev::fakeIMU, yarp::dev::FakeAnalogSensor, yarp::dev::fakeDepthCameraDriver, yarp::dev::DeviceGroup, and yarp::dev::DevicePipe.

Definition at line 21 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
configA list of parameters for the object.
Returns
true/false on success/failure.

Reimplemented in yarp::dev::DynamixelAX12FtdiDriver.

Definition at line 26 of file IConfig.cpp.

◆ open()

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

Initialize the object.

You should override this.

Parameters
configis a list of parameters for the object. Which parameters are effective for your object can vary.
Returns
true/false upon success/failure

Reimplemented in yarp::dev::RemoteControlBoard, yarp::dev::RemoteFrameGrabber, yarp::dev::ControlBoardWrapper, yarp::dev::ServerGrabber, yarp::dev::FakeMotionControl, yarp::dev::RGBDSensorWrapper, RpLidar, yarp::dev::depthCameraDriver, yarp::dev::ControlBoardRemapper, yarp::dev::BoschIMU, yarp::dev::RGBDSensorClient, StubDriver, yarp::dev::AnalogWrapper, yarp::dev::DynamixelAX12FtdiDriver, yarp::dev::MultipleAnalogSensorsRemapper, yarp::dev::ServerInertial, yarp::dev::realsense2Driver, yarp::dev::ServerSerial, FakeLaser, yarp::dev::RemoteControlBoardRemapper, yarp::dev::FrameTransformClient, yarp::dev::ServerFrameGrabber, yarp::dev::AnalogSensorClient, yarp::dev::Rangefinder2DClient, yarp::dev::BatteryClient, laserHokuyo, yarp::dev::SerialDeviceDriver, yarp::dev::FrameTransformServer, yarp::dev::MultipleAnalogSensorsClient, RpLidar2, LaserFromDepth, yarp::dev::MultipleAnalogSensorsServer, yarp::dev::Map2DServer, yarp::dev::JoypadControlServer, yarp::dev::SDLJoypad, yarp::dev::PortAudioDeviceDriver, yarp::dev::TestFrameGrabber, yarp::dev::VirtualAnalogWrapper, yarp::dev::OpenCVGrabber, yarp::dev::OVRHeadset, yarp::dev::JoypadControlClient, SerialServoBoard, yarp::dev::ServerSoundGrabber, yarp::dev::PolyDriver, yarp::dev::FakeBot, yarp::dev::Navigation2DClient, yarp::dev::FfmpegGrabber, yarp::dev::TestMotor, yarp::dev::Localization2DClient, yarp::dev::Rangefinder2DWrapper, yarp::dev::BatteryWrapper, yarp::dev::Map2DClient, yarp::dev::FfmpegWriter, yarp::dev::RobotDescriptionServer, yarp::dev::DeviceDriver, yarp::dev::RobotDescriptionClient, yarp::dev::fakeIMU, yarp::dev::FakeAnalogSensor, yarp::dev::fakeDepthCameraDriver, yarp::dev::DeviceGroup, and yarp::dev::DevicePipe.

Definition at line 15 of file IConfig.cpp.


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