config_int_limit Class Reference

A config_int 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_int.

Public Member Functions
	config_int_limit (config_obj &owner, int def_val, int minv=INT_MIN, int maxv=INT_MAX, const char *name=NULL, const char *desc=NULL)
	Object constructor with the parent/owner leaf parameter and limits.
	config_int_limit (int def_val, int minv=INT_MIN, int maxv=INT_MAX, const char *name=NULL, const char *desc=NULL)
	Object constructor with limits.
	config_int_limit (config_int_limit &&o)=default
	Move constructor (mirrors the movable base config_int).
config_int_limit &	operator= (const config_int &ci)
	Copy a config_int object into the config_int_limit.
config_int_limit &	operator= (const config_int_limit &cil)
	Copy one config_int_limit object to another.
Public Member Functions inherited from config_int
virtual void	GetTextValue (NBString &s) override
	Copy the object value to the specified NBString object.
	config_int (config_obj &owner, int def_val, const char *name, const char *desc=NULL)
	Object constructor with the parent/owner leaf parameter.
	config_int (int def_val, const char *name, const char *desc=NULL)
	Object constructor.
	operator int () const
	Return the object value as an int.
config_int &	operator= (const int i)
	Assign the config_int object value to the specified int value.
config_int &	operator= (const config_int &ci)
	Copy one config_int object to another.
virtual void	GetTypeValue (NBString &s) override
	Copy the object type value in the specified NBString object.

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_int 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_int_limit() [1/3]

config_int_limit::config_int_limit ( config_obj & owner, int def_val, int minv = INT_MIN, int maxv = INT_MAX, 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
name	Field name assigned to the value
desc	Description used for info/tool tip

config_int_limit() [2/3]

config_int_limit::config_int_limit ( int def_val, int minv = INT_MIN, int maxv = INT_MAX, const char * name = NULL, const char * desc = NULL )

inline

Object constructor with limits.

Parameters

def_val	Default value
minv	Minimum value
maxv	Maximum value
name	Field name assigned to the value
desc	Description used for info/tool tip

config_int_limit() [3/3]

config_int_limit::config_int_limit ( config_int_limit && o )

default

Move constructor (mirrors the movable base config_int).

Without this the user-declared operator= overloads suppress the implicit move constructor, leaving the class neither movable nor copyable.

Member Function Documentation

operator=() [1/2]

config_int_limit & config_int_limit::operator= ( const config_int & ci )

inline

Copy a config_int object into the config_int_limit.

Parameters

ci	Reference to a config_int object

operator=() [2/2]

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

inline

Copy one config_int_limit object to another.

Parameters

cil	Reference to a config_int_limit object

---

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

• config_obj.h