Represents a parameter of the device. More...

#include <Parameter.h>

Inheritance diagram for mmind::eye::Parameter:

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

Public Member Functions
MMIND_API_EXPORT std::string	name () const
	Returns the name of the device parameter.

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

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

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

MMIND_API_EXPORT 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< class ParameterImpl > &impl, bool needUpdateMaxAndMin=false)

Protected Attributes
std::shared_ptr< class ParameterImpl >	_impl

bool	_needUpdateMaxAndMin

Detailed Description

Represents a parameter of the device.

Definition at line 17 of file Parameter.h.

Member Enumeration Documentation

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.

Definition at line 24 of file Parameter.h.

friend class ParameterFactory

friend

Definition at line 69 of file Parameter.h.

std::shared_ptr<class ParameterImpl> mmind::eye::Parameter::_impl

protected

Definition at line 62 of file Parameter.h.

bool mmind::eye::Parameter::_needUpdateMaxAndMin

protected

Definition at line 63 of file Parameter.h.

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