config_int Class Reference

Signed 32-bit Integer Configuration Variable. More...

#include <config_obj.h>

Inherits config_value.

Inherited by version_obj.

Public Member Functions
virtual void	GetTextValue (NBString &s)
	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)
	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

Signed 32-bit Integer Configuration Variable.

Note

All modifications to configuration objects are marked as pending. A call to SaveConfigToStorage is required to save changes to flash memory.

Constructor & Destructor Documentation

config_int() [1/2]

config_int::config_int ( config_obj & owner, int def_val, const char * name, const char * desc = NULL )

inline

Object constructor with the parent/owner leaf parameter.

Parameters

owner	Reference to owner/parent leaf
def_val	Default value
name	Field name assigned to the value
desc	Description used for info/tool tip

config_int() [2/2]

config_int::config_int ( int def_val, const char * name, const char * desc = NULL )

inline

Object constructor.

Parameters

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

Member Function Documentation

GetTextValue()

virtual void config_int::GetTextValue ( NBString & s )

inlinevirtual

Copy the object value to the specified NBString object.

This is a virtual function that can be overridden in any derived class.

Parameters

s	Reference to a NBString object to store the result

Implements config_value.

GetTypeValue()

virtual void config_int::GetTypeValue ( NBString & s )

inlinevirtual

Copy the object type value in the specified NBString object.

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

Parameters

s	Reference to a NBString object

operator int()

config_int::operator int ( ) const

inline

Return the object value as an int.

Returns

The integer value of the object

Example: for a variable named configInt of type config_int:

int value = int(configInt);
iprintf("int = %d\r\n", value);

operator=() [1/2]

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

inline

Copy one config_int object to another.

Parameters

ci	Reference to a config_int object

operator=() [2/2]

config_int & config_int::operator= ( const int i )

inline

Assign the config_int object value to the specified int value.

Parameters

i	Integer value

---

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

• config_obj.h