EnumParameter Class Reference

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

#include <Parameter.h>

Inheritance diagram for EnumParameter:

Public Member Functions
ErrorStatus	getValue (int &value) const
	Gets the current value of the device parameter in the form of the integer value.
ErrorStatus	setValue (int value)
	Sets the value of the device parameter by inputting the integer value of an enumerator.
ErrorStatus	getValue (std::string &valueStr) const
	Gets the current value of the device parameter in the form of a string.
ErrorStatus	setValue (const std::string &value)
	Sets the value of the device parameter by inputting a string.
ErrorStatus	getValues (std::map< std::string, int > &valueList) const
	Gets the list of available values of the device parameter in the form of a map.
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 _Enum-type device parameter.

Member Function Documentation

getValue() [1/2]

ErrorStatus getValue

(

int &

value

)

const

Gets the current value of the device parameter in the form of the integer value.

getValue() [2/2]

ErrorStatus getValue

(

std::string &

valueStr

)

const

Gets the current value of the device parameter in the form of a string.

getValues()

ErrorStatus getValues

(

std::map< std::string, int > &

valueList

)

const

Gets the list of available values of the device parameter in the form of a map.

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

setValue() [1/2]

ErrorStatus setValue

(

const std::string &

value

)

Sets the value of the device parameter by inputting a string.

setValue() [2/2]

ErrorStatus setValue

(

int

value

)

Sets the value of the device parameter by inputting the integer value of an enumerator.

---

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

• Parameter.h