dvsense::CameraTool Class Reference

The base class of camera tools. Tools refer to the abstract concept used to control the camera, which can be used to set various camera parameters, obtain camera parameter information, perform data processing, etc. More...

#include <CameraTool.h>

Public Member Functions
	CameraTool (std::string prefix="")
virtual	~CameraTool ()
virtual const ToolInfo	getToolInfo ()=0
	Get the information of the tool. More...
virtual std::map< std::string, BasicParameterInfo >	getAllParamInfo ()=0
	Get the basic information of all parameters. If you want to get the detailed information of a parameter, please refer to CameraTool::getParamInfo . More...
virtual bool	getParamInfo (const std::string name, IntParameterInfo &info)=0
	Get the detailed information of a parameter. More...
virtual bool	getParamInfo (const std::string name, FloatParameterInfo &info)=0
virtual bool	getParamInfo (const std::string name, BoolParameterInfo &info)=0
virtual bool	getParamInfo (const std::string name, EnumParameterInfo &info)=0
virtual bool	getParam (const std::string name, int &value)
	Get the value of a parameter. More...
virtual bool	getParam (const std::string name, float &value)
virtual bool	getParam (const std::string name, bool &value)
virtual bool	getParam (const std::string name, std::string &value)
virtual bool	setParam (const std::string name, const int &value)
	Set the value of a parameter. More...
virtual bool	setParam (const std::string name, const float &value)
virtual bool	setParam (const std::string name, const double &value)
virtual bool	setParam (const std::string name, const bool &value)
virtual bool	setParam (const std::string name, const char *value)
virtual bool	setParam (const std::string name, const std::string &value)

Protected Attributes
std::string	prefix_ = ""

Detailed Description

The base class of camera tools. Tools refer to the abstract concept used to control the camera, which can be used to set various camera parameters, obtain camera parameter information, perform data processing, etc.

Constructor & Destructor Documentation

CameraTool()

dvsense::CameraTool::CameraTool ( std::string  prefix = "" )

inline

~CameraTool()

virtual dvsense::CameraTool::~CameraTool ( )

inlinevirtual

Member Function Documentation

getToolInfo()

virtual const ToolInfo dvsense::CameraTool::getToolInfo ( )

pure virtual

Get the information of the tool.

Returns

The information of the tool.

getAllParamInfo()

virtual std::map<std::string, BasicParameterInfo> dvsense::CameraTool::getAllParamInfo ( )

pure virtual

Get the basic information of all parameters. If you want to get the detailed information of a parameter, please refer to CameraTool::getParamInfo .

Returns

The information of all parameters.

getParamInfo() [1/4]

virtual bool dvsense::CameraTool::getParamInfo ( const std::string  name, IntParameterInfo &  info  )

pure virtual

Get the detailed information of a parameter.

Parameters

name	The name of the parameter.
info	The detailed information of the parameter.

Returns

True if the parameter exists, otherwise false.

getParamInfo() [2/4]

virtual bool dvsense::CameraTool::getParamInfo ( const std::string  name, FloatParameterInfo &  info  )

pure virtual

getParamInfo() [3/4]

virtual bool dvsense::CameraTool::getParamInfo ( const std::string  name, BoolParameterInfo &  info  )

pure virtual

getParamInfo() [4/4]

virtual bool dvsense::CameraTool::getParamInfo ( const std::string  name, EnumParameterInfo &  info  )

pure virtual

getParam() [1/4]

virtual bool dvsense::CameraTool::getParam ( const std::string  name, int &  value  )

virtual

Get the value of a parameter.

Parameters

name	The name of the parameter.
value	The value of the parameter.

Returns

True if the parameter exists, otherwise false.

getParam() [2/4]

virtual bool dvsense::CameraTool::getParam ( const std::string  name, float &  value  )

virtual

getParam() [3/4]

virtual bool dvsense::CameraTool::getParam ( const std::string  name, bool &  value  )

virtual

getParam() [4/4]

virtual bool dvsense::CameraTool::getParam ( const std::string  name, std::string &  value  )

virtual

setParam() [1/6]

virtual bool dvsense::CameraTool::setParam ( const std::string  name, const int &  value  )

virtual

Set the value of a parameter.

Parameters

name	The name of the parameter.
value	The value of the parameter.

Returns

True if the parameter exists, otherwise false.

setParam() [2/6]

virtual bool dvsense::CameraTool::setParam ( const std::string  name, const float &  value  )

virtual

setParam() [3/6]

virtual bool dvsense::CameraTool::setParam ( const std::string  name, const double &  value  )

virtual

setParam() [4/6]

virtual bool dvsense::CameraTool::setParam ( const std::string  name, const bool &  value  )

virtual

setParam() [5/6]

virtual bool dvsense::CameraTool::setParam ( const std::string  name, const char *  value  )

virtual

setParam() [6/6]

virtual bool dvsense::CameraTool::setParam ( const std::string  name, const std::string &  value  )

virtual

Member Data Documentation

prefix_

std::string dvsense::CameraTool::prefix_ = ""

protected