config_double_limit Class Reference

A config_double with minimum and/or maximum values Attempting to set a value lower than the minimum or greater than the maximum will fail with an error both programmatically and in the Config Web UI. More...

#include <config_obj.h>

Inherits config_double.

Public Member Functions
	config_double_limit (config_obj &owner, double def_val, double minv=-DBL_MAX, double maxv=DBL_MAX, double stepv=0.01, const char *name=NULL, const char *desc=NULL)
	Object constructor with the parent/owner leaf parameter and limits.
	config_double_limit (double def_val, double minv=-DBL_MAX, double maxv=DBL_MAX, double stepv=0.01, const char *name=NULL, const char *desc=NULL)
	Object constructor with limits.
config_double_limit &	operator= (const config_double &ci)
	Copy a config_double object into the config_double_limit.
config_double_limit &	operator= (const config_double_limit &cil)
	Copy one config_double_limit object to another.
virtual void	GetTypeValue (NBString &s) override
	Copy the object type value in the specified NBString object.
Public Member Functions inherited from config_double
virtual void	GetTextValue (NBString &s) override
	Copy the object value as a text string to the specified NBString object.
	config_double (config_obj &owner, double def_val, const char *name, const char *desc=NULL)
	Object constructor with the parent/owner leaf parameter.
	config_double (double def_val, const char *name, const char *desc=NULL)
	Object constructor.
	operator int () const
	Return the object value as an int.
	operator float () const
	Return the object value as a float.
	operator double () const
	Returns the object value as a double float.
config_double &	operator= (const double d)
	Assign the config_double object value from a double value.
config_double &	operator= (const config_double &ci)
	Copy one config_double object to another.

Additional Inherited Members
Protected Member Functions inherited from config_value
	config_value (config_obj &owner, const char *name, const char *desc)
	Object constructor with the parent/owner leaf parameter.
	config_value (const char *name, const char *desc)
	Object constructor.

Detailed Description

A config_double with minimum and/or maximum values Attempting to set a value lower than the minimum or greater than the maximum will fail with an error both programmatically and in the Config Web UI.

Constructor & Destructor Documentation

config_double_limit() [1/2]

config_double_limit::config_double_limit ( config_obj & owner, double def_val, double minv = -DBL_MAX, double maxv = DBL_MAX, double stepv = 0.01, const char * name = NULL, const char * desc = NULL )

inline

Object constructor with the parent/owner leaf parameter and limits.

Parameters

owner	Reference to owner/parent leaf
def_val	Default value
minv	Minimum value
maxv	Maximum value
stepv	Step value (for HTML-side validation, not strictly enforced)
name	Field name assigned to the value
desc	Description used for info/tool tip

config_double_limit() [2/2]

config_double_limit::config_double_limit ( double def_val, double minv = -DBL_MAX, double maxv = DBL_MAX, double stepv = 0.01, const char * name = NULL, const char * desc = NULL )

inline

Object constructor with limits.

Parameters

def_val	Default value
minv	Minimum value
maxv	Maximum value
stepv	Step value (for HTML-side validation, not strictly enforced)
name	Field name assigned to the value
desc	Description used for info/tool tip

Member Function Documentation

GetTypeValue()

virtual void config_double_limit::GetTypeValue ( NBString & s )

inlineoverridevirtual

Copy the object type value in the specified NBString object.

The type value "number" is written to the NBString object.

Parameters

s	Reference to a NBString object

Reimplemented from config_double.

operator=() [1/2]

config_double_limit & config_double_limit::operator= ( const config_double & ci )

inline

Copy a config_double object into the config_double_limit.

Parameters

ci	Reference to a config_double object

operator=() [2/2]

config_double_limit & config_double_limit::operator= ( const config_double_limit & cil )

inline

Copy one config_double_limit object to another.

Parameters

cil	Reference to a config_double_limit object

---

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

• config_obj.h