Represents a parameter of the device. More...

#include <Parameter.h>

Inheritance diagram for Parameter:

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

Public Member Functions
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 Attributes
std::shared_ptr< class ParameterImpl >	_impl

Friends
class	ParameterFactory

Detailed Description

Represents a parameter of the device.

Member Enumeration Documentation

◆ Type

enum Type

Describes the device parameter data types.

Enumerator
_Int	Integer type.
_Float	Double type.
_Bool	Boolean type.
_Enum	Enumeration type.
_Roi	ROI type. See ROI for details.
_Range	Range type. See Range for details.
_FloatArray	Vector of double types.
_RoiArray	Vector of ROI types.
_ProfileRoi	Profile ROI type. See ProfileROI for details.

Constructor & Destructor Documentation

◆ ~Parameter()

virtual ~Parameter ( )

virtual

◆ 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

Member Function Documentation

◆ description()

std::string description ( ) const

Returns the description of the device parameter.

◆ isReadable()

bool isReadable ( ) const

Returns a Boolean value that indicates the read permission of the device parameter.

◆ isWritable()

bool isWritable ( ) const

Returns a Boolean value that indicates the write permission of the device parameter.

◆ name()

std::string name ( ) const

Returns the name of the device parameter.

◆ type()

Type type ( ) const

Returns the data type of the device parameter.

Friends And Related Symbol Documentation

◆ ParameterFactory

friend class ParameterFactory

friend

Field Documentation

◆ _impl

std::shared_ptr<class ParameterImpl> _impl