User manual

124
chapi_cfg_option_value_t
Basic functionality of option value is defined by the class chapi_cfg_option_value_t which
establishes wrappers for the all CHAPI protocol routines relative to the option value
processing. This class shouldn’t be used directly during the loadable components
development. See description of derived classes below. Here is the list of public members:
chapi_cfg_option_value_t(chapi_cfg_option_t *option, int opt_val_idx,
void *opt_buffer);
where
option - pointer to the chapi option our option value belongs to;
opt_val_idx - option value index among the option values;
opt_buffer - pouinter to the buffer where option value is stored.
This constructor is used to specify parent option for the value, its index among the all
option values and pointer to the buffer where option value will be stored.
virtual bool set(void *val);
where
val - pointer to the int, bool or character string, containing value to set.
This method is used to set the option value using supplied data. It wrappes routine
identified by the set_option_value entry of chapi_in communication context.
virtual bool set_and_disable(void *val);
where
val - pointer to the int, bool or character string, containing value to set.
This method is used to set the option value using supplied with further disabling of this
value during commit(). It wrappes routine identified by the set_and_disable_option_value entry
of chapi_in communication context.
virtual void undo();
This method is used in order to undo option value change if any. It wraps routine identified
by the undo_option_value entry of chapi_in communication context.
virtual void commit();