YARP
Yet Another Robot Platform
 
Loading...
Searching...
No Matches
Classes | Public Member Functions | Public Attributes | List of all members
argusCameraDriver_ParamsParser Class Reference

This class is the parameters parser for class argusCameraDriver. More...

#include </home/runner/work/yarp-documentation/yarp-documentation/yarp/opt-modules/yarp-device-argus/src/devices/argusCamera/argusCameraDriver_ParamsParser.h>

+ Inheritance diagram for argusCameraDriver_ParamsParser:

Classes

struct  parser_version_type
 

Public Member Functions

 argusCameraDriver_ParamsParser ()
 
 ~argusCameraDriver_ParamsParser () override=default
 
bool parseParams (const yarp::os::Searchable &config) override
 Parse the DeviceDriver parameters.
 
std::string getDeviceClassName () const override
 Get the name of the DeviceDriver class.
 
std::string getDeviceName () const override
 Get the name of the device (i.e.
 
std::string getDocumentationOfDeviceParams () const override
 Get the documentation of the DeviceDriver's parameters.
 
std::vector< std::string > getListOfParams () const override
 Return a list of all params used by the device.
 
- Public Member Functions inherited from yarp::dev::IDeviceDriverParams
virtual ~IDeviceDriverParams ()
 

Public Attributes

const std::string m_device_classname = {"argusCameraDriver"}
 
const std::string m_device_name = {"argusCamera"}
 
bool m_parser_is_strict = false
 
const parser_version_type m_parser_version = {}
 
const std::string m_d_defaultValue = {"0"}
 
const std::string m_period_defaultValue = {"0.033"}
 
const std::string m_rotation_defaultValue = {"0.0"}
 
const std::string m_width_defaultValue = {"640"}
 
const std::string m_height_defaultValue = {"480"}
 
const std::string m_rotation_with_crop_defaultValue = {"false"}
 
int m_d = {0}
 
double m_period = {0.033}
 
double m_rotation = {0.0}
 
int m_width = {640}
 
int m_height = {480}
 
bool m_rotation_with_crop = {false}
 

Detailed Description

This class is the parameters parser for class argusCameraDriver.

These are the used parameters:

Group name Parameter name Type Units Default Value Required Description Notes
- d int - 0 0 Enumeration of the camera device -
- period double seconds 0.033 0 Refresh period of acquistion of the camera in s Check the camera documentation for the fps cap
- rotation double degrees 0.0 0 Rotation applied from the center of the image Depending the size requested some rotations are not allowed. The rotation worse the performance of the device. Allowed values: 0.0, 90.0, -90.0, 180.0.
- width int pixel 640 0 Width of the images requested to the camera The cameras has a value cap for the width of the image that can provide, check the documentation. Zero or negative value not accepted
- height int pixel 480 0 Height of the images requested to the camera The cameras has a value cap for the width of the image that can provide, check the documentation. Zero or negative value not accepted
- rotation_with_crop bool - false 0 The rotation, if the param is true, is obtained swapping x with y The image will have a resolution swapper respect to what is requested

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

yarpdev --device argusCamera --d 0 --period 0.033 --rotation 0.0 --width 640 --height 480 --rotation_with_crop false
yarpdev --device argusCamera

Definition at line 46 of file argusCameraDriver_ParamsParser.h.

Constructor & Destructor Documentation

◆ argusCameraDriver_ParamsParser()

argusCameraDriver_ParamsParser::argusCameraDriver_ParamsParser ( )

Definition at line 23 of file argusCameraDriver_ParamsParser.cpp.

◆ ~argusCameraDriver_ParamsParser()

argusCameraDriver_ParamsParser::~argusCameraDriver_ParamsParser ( )
overridedefault

Member Function Documentation

◆ getDeviceClassName()

std::string argusCameraDriver_ParamsParser::getDeviceClassName ( ) const
inlineoverridevirtual

Get the name of the DeviceDriver class.

Returns
A string containing the name of the class.

Implements yarp::dev::IDeviceDriverParams.

Definition at line 78 of file argusCameraDriver_ParamsParser.h.

◆ getDeviceName()

std::string argusCameraDriver_ParamsParser::getDeviceName ( ) const
inlineoverridevirtual

Get the name of the device (i.e.

the plugin name).

Returns
A string containing the name of the device.

Implements yarp::dev::IDeviceDriverParams.

Definition at line 79 of file argusCameraDriver_ParamsParser.h.

◆ getDocumentationOfDeviceParams()

std::string argusCameraDriver_ParamsParser::getDocumentationOfDeviceParams ( ) const
overridevirtual

Get the documentation of the DeviceDriver's parameters.

Returns
A string containing the documentation.

Implements yarp::dev::IDeviceDriverParams.

Definition at line 164 of file argusCameraDriver_ParamsParser.cpp.

◆ getListOfParams()

std::vector< std::string > argusCameraDriver_ParamsParser::getListOfParams ( ) const
overridevirtual

Return a list of all params used by the device.

Returns
A vector containing the names of parameters used by the device.

Implements yarp::dev::IDeviceDriverParams.

Definition at line 28 of file argusCameraDriver_ParamsParser.cpp.

◆ parseParams()

bool argusCameraDriver_ParamsParser::parseParams ( const yarp::os::Searchable &  config)
overridevirtual

Parse the DeviceDriver parameters.

Returns
true if the parsing is successful, false otherwise

Implements yarp::dev::IDeviceDriverParams.

Definition at line 41 of file argusCameraDriver_ParamsParser.cpp.

Member Data Documentation

◆ m_d

int argusCameraDriver_ParamsParser::m_d = {0}

Definition at line 70 of file argusCameraDriver_ParamsParser.h.

◆ m_d_defaultValue

const std::string argusCameraDriver_ParamsParser::m_d_defaultValue = {"0"}

Definition at line 63 of file argusCameraDriver_ParamsParser.h.

◆ m_device_classname

const std::string argusCameraDriver_ParamsParser::m_device_classname = {"argusCameraDriver"}

Definition at line 53 of file argusCameraDriver_ParamsParser.h.

◆ m_device_name

const std::string argusCameraDriver_ParamsParser::m_device_name = {"argusCamera"}

Definition at line 54 of file argusCameraDriver_ParamsParser.h.

◆ m_height

int argusCameraDriver_ParamsParser::m_height = {480}

Definition at line 74 of file argusCameraDriver_ParamsParser.h.

◆ m_height_defaultValue

const std::string argusCameraDriver_ParamsParser::m_height_defaultValue = {"480"}

Definition at line 67 of file argusCameraDriver_ParamsParser.h.

◆ m_parser_is_strict

bool argusCameraDriver_ParamsParser::m_parser_is_strict = false

Definition at line 55 of file argusCameraDriver_ParamsParser.h.

◆ m_parser_version

const parser_version_type argusCameraDriver_ParamsParser::m_parser_version = {}

Definition at line 61 of file argusCameraDriver_ParamsParser.h.

◆ m_period

double argusCameraDriver_ParamsParser::m_period = {0.033}

Definition at line 71 of file argusCameraDriver_ParamsParser.h.

◆ m_period_defaultValue

const std::string argusCameraDriver_ParamsParser::m_period_defaultValue = {"0.033"}

Definition at line 64 of file argusCameraDriver_ParamsParser.h.

◆ m_rotation

double argusCameraDriver_ParamsParser::m_rotation = {0.0}

Definition at line 72 of file argusCameraDriver_ParamsParser.h.

◆ m_rotation_defaultValue

const std::string argusCameraDriver_ParamsParser::m_rotation_defaultValue = {"0.0"}

Definition at line 65 of file argusCameraDriver_ParamsParser.h.

◆ m_rotation_with_crop

bool argusCameraDriver_ParamsParser::m_rotation_with_crop = {false}

Definition at line 75 of file argusCameraDriver_ParamsParser.h.

◆ m_rotation_with_crop_defaultValue

const std::string argusCameraDriver_ParamsParser::m_rotation_with_crop_defaultValue = {"false"}

Definition at line 68 of file argusCameraDriver_ParamsParser.h.

◆ m_width

int argusCameraDriver_ParamsParser::m_width = {640}

Definition at line 73 of file argusCameraDriver_ParamsParser.h.

◆ m_width_defaultValue

const std::string argusCameraDriver_ParamsParser::m_width_defaultValue = {"640"}

Definition at line 66 of file argusCameraDriver_ParamsParser.h.

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