Represents an _Roi-type device parameter. More...

#include <Parameter.h>

Inheritance diagram for RoiParameter:

Public Member Functions
ErrorStatus	getValue (ROI &value) const
	Gets the current value of the device parameter.

ErrorStatus	setValue (ROI value)
	Sets the value of the device parameter.

ErrorStatus	getMaxRoiSize (Size &maxSize) const
	Gets the maximum settable value of the device parameter.

Public Member Functions inherited from Parameter
virtual	~Parameter ()

std::string	name () const
	Returns the name of the device parameter.

Type	type () const
	Returns the data type of the device parameter.

std::string	description () const
	Returns the description of the device parameter.

bool	isWritable () const
	Returns a Boolean value that indicates the write permission of the device parameter.

bool	isReadable () const
	Returns a Boolean value that indicates the read permission of the device parameter.

Protected Member Functions
	Parameter (const std::string &name, const std::shared_ptr< ZmqClientImpl > &client, const std::shared_ptr< Json::Value > &parameterInfo, bool needUpdateMaxAndMin=false, bool isVirtual=false)

Protected Member Functions inherited from Parameter
	Parameter (const std::string &name, const std::shared_ptr< ZmqClientImpl > &client, const std::shared_ptr< Json::Value > &parameterInfo, bool needUpdateMaxAndMin=false, bool isVirtual=false)

Additional Inherited Members
Public Types inherited from Parameter
enum	Type { _Int , _Float , _Bool , _Enum , _Roi , _Range , _FloatArray , _RoiArray , _ProfileRoi }
	Describes the device parameter data types. More...

Protected Attributes inherited from Parameter
std::shared_ptr< class ParameterImpl >	_impl

Detailed Description

Represents an _Roi-type device parameter.

Member Function Documentation

ErrorStatus getMaxRoiSize ( Size & maxSize ) const

Gets the maximum settable value of the device parameter.

ErrorStatus getValue ( ROI & value ) const

Gets the current value of the device parameter.

Parameter	(	const std::string &	name,
		const std::shared_ptr< ZmqClientImpl > &	client,
		const std::shared_ptr< Json::Value > &	parameterInfo,
		bool	needUpdateMaxAndMin = `false`,
		bool	isVirtual = `false`
	)

protected

ErrorStatus setValue ( ROI value )

Sets the value of the device parameter.

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