Mech-Eye API 2.5.1
API reference documentation for Mech-Eye 3D Laser Profiler
Loading...
Searching...
No Matches
Public Member Functions | Friends
VirtualUserSet Class Reference

#include <VirtualUserSet.h>

Public Member Functions

virtual ~VirtualUserSet ()
 Destructor.
 
ErrorStatus getName (std::string &userSetName) const
 Gets the name of the parameter group used when the virtual device was saved.
 
ErrorStatus getAvailableParameterNames (std::vector< std::string > &parameterArrayNames) const
 Gets the names of all available parameters of the virtual device.
 
std::vector< Parameter * > getAvailableParameters () const
 Returns the pointer to the elements in the vector storing all available parameters.
 
Parameter * getParameter (const std::string &parameterName) const
 Gets the pointer to the elements of a specific parameter.
 
Parameter * operator[] (const std::string &parameterName) const
 Gets the pointer to the elements of a specific parameter.
 
ErrorStatus getIntValue (const std::string &parameterName, int &value) const
 Gets the current value of an _Int-type parameter. See Parameter for details.
 
ErrorStatus getFloatValue (const std::string &parameterName, double &value) const
 Gets the current value of a _Float-type parameter. See Parameter for details.
 
ErrorStatus getBoolValue (const std::string &parameterName, bool &value) const
 Gets the current value of a _Bool-type parameter. See Parameter for details.
 
ErrorStatus getEnumValue (const std::string &parameterName, int &value) const
 Gets the current value of an _Enum-type parameter in the form of the integer value. See Parameter for details.
 
ErrorStatus getEnumValue (const std::string &parameterName, std::string &valueStr) const
 Gets the current value of an _Enum-type parameter in the form of a string. See Parameter for details.
 
ErrorStatus getRoiValue (const std::string &parameterName, ROI &value) const
 Gets the current value of an _Roi-type parameter. See Parameter for details.
 
ErrorStatus getProfileRoiValue (const std::string &parameterName, ProfileROI &value) const
 Gets the current value of an _ProfileRoi-type parameter. See Parameter for details.
 
ErrorStatus getFloatArrayValue (const std::string &parameterName, std::vector< double > &value) const
 Gets the current value of a _FloatArray-type parameter. See Parameter for details.
 
ErrorStatus getRangeValue (const std::string &parameterName, Range< int > &value) const
 Gets the current value of a _Range-type parameter. See Parameter for details.
 

Friends

class VirtualProfilerImpl
 

Constructor & Destructor Documentation

◆ ~VirtualUserSet()

virtual ~VirtualUserSet ( )
virtual

Destructor.

Member Function Documentation

◆ getAvailableParameterNames()

ErrorStatus getAvailableParameterNames ( std::vector< std::string > &  parameterArrayNames) const

Gets the names of all available parameters of the virtual device.

Parameters
[out]parameterArrayNamesAn array storing the parameter names.
Returns
ErrorStatus::MMIND_STATUS_SUCCESS Success.

◆ getAvailableParameters()

std::vector< Parameter * > getAvailableParameters ( ) const

Returns the pointer to the elements in the vector storing all available parameters.

◆ getBoolValue()

ErrorStatus getBoolValue ( const std::string &  parameterName,
bool &  value 
) const

Gets the current value of a _Bool-type parameter. See Parameter for details.

Returns
ErrorStatus::MMIND_STATUS_SUCCESS Success.
ErrorStatus::MMIND_STATUS_PARAMETER_ERROR Parameter not found, please check the input parameter name.

◆ getEnumValue() [1/2]

ErrorStatus getEnumValue ( const std::string &  parameterName,
int &  value 
) const

Gets the current value of an _Enum-type parameter in the form of the integer value. See Parameter for details.

Returns
ErrorStatus::MMIND_STATUS_SUCCESS Success.
ErrorStatus::MMIND_STATUS_PARAMETER_ERROR Parameter not found, please check the input parameter name.

◆ getEnumValue() [2/2]

ErrorStatus getEnumValue ( const std::string &  parameterName,
std::string &  valueStr 
) const

Gets the current value of an _Enum-type parameter in the form of a string. See Parameter for details.

Returns
ErrorStatus::MMIND_STATUS_SUCCESS Success.
ErrorStatus::MMIND_STATUS_PARAMETER_ERROR Parameter not found, please check the input parameter name.

◆ getFloatArrayValue()

ErrorStatus getFloatArrayValue ( const std::string &  parameterName,
std::vector< double > &  value 
) const

Gets the current value of a _FloatArray-type parameter. See Parameter for details.

Returns
ErrorStatus::MMIND_STATUS_SUCCESS Success.
ErrorStatus::MMIND_STATUS_PARAMETER_ERROR Parameter not found, please check the input parameter name.

◆ getFloatValue()

ErrorStatus getFloatValue ( const std::string &  parameterName,
double &  value 
) const

Gets the current value of a _Float-type parameter. See Parameter for details.

Returns
ErrorStatus::MMIND_STATUS_SUCCESS Success.
ErrorStatus::MMIND_STATUS_PARAMETER_ERROR Parameter not found, please check the input parameter name.

◆ getIntValue()

ErrorStatus getIntValue ( const std::string &  parameterName,
int &  value 
) const

Gets the current value of an _Int-type parameter. See Parameter for details.

Returns
ErrorStatus::MMIND_STATUS_SUCCESS Success.
ErrorStatus::MMIND_STATUS_PARAMETER_ERROR Parameter not found, please check the input parameter name.

◆ getName()

ErrorStatus getName ( std::string &  userSetName) const

Gets the name of the parameter group used when the virtual device was saved.

Parameters
[out]userSetNameThe name of the parameter group.
Returns
ErrorStatus::MMIND_STATUS_SUCCESS Success.

◆ getParameter()

Parameter * getParameter ( const std::string &  parameterName) const

Gets the pointer to the elements of a specific parameter.

◆ getProfileRoiValue()

ErrorStatus getProfileRoiValue ( const std::string &  parameterName,
ProfileROI &  value 
) const

Gets the current value of an _ProfileRoi-type parameter. See Parameter for details.

Returns
ErrorStatus::MMIND_STATUS_SUCCESS Success.
ErrorStatus::MMIND_STATUS_PARAMETER_ERROR Parameter not found, please check the input parameter name.

◆ getRangeValue()

ErrorStatus getRangeValue ( const std::string &  parameterName,
Range< int > &  value 
) const

Gets the current value of a _Range-type parameter. See Parameter for details.

Returns
ErrorStatus::MMIND_STATUS_SUCCESS Success.
ErrorStatus::MMIND_STATUS_PARAMETER_ERROR Parameter not found, please check the input parameter name.

◆ getRoiValue()

ErrorStatus getRoiValue ( const std::string &  parameterName,
ROI &  value 
) const

Gets the current value of an _Roi-type parameter. See Parameter for details.

Returns
ErrorStatus::MMIND_STATUS_SUCCESS Success.
ErrorStatus::MMIND_STATUS_PARAMETER_ERROR Parameter not found, please check the input parameter name.

◆ operator[]()

Parameter * operator[] ( const std::string &  parameterName) const

Gets the pointer to the elements of a specific parameter.

Friends And Related Symbol Documentation

◆ VirtualProfilerImpl

friend class VirtualProfilerImpl
friend
The documentation for this class was generated from the following file:
Generated by doxygen 1.9.7