formula_cell

Defined in header: <ixion/cell.hpp>

class formula_cell

Public Functions

formula_cell(const formula_cell&) = delete

formula_cell &operator=(formula_cell) = delete

formula_cell()

formula_cell(const formula_tokens_store_ptr_t &tokens)

formula_cell(row_t group_row, col_t group_col, const calc_status_ptr_t &cs, const formula_tokens_store_ptr_t &tokens)

~formula_cell()

const formula_tokens_store_ptr_t &get_tokens() const

void set_tokens(const formula_tokens_store_ptr_t &tokens)

double get_value(formula_result_wait_policy_t policy) const

std::string_view get_string(formula_result_wait_policy_t policy) const

void interpret(model_context &context, const abs_address_t &pos)

void check_circular(const model_context &cxt, const abs_address_t &pos)

Determine if this cell contains circular reference by walking through all its reference tokens.

void reset()

Reset cell’s internal state.

std::vector<const formula_token*> get_ref_tokens(const model_context &cxt, const abs_address_t &pos) const

Get a series of all reference tokens included in the formula expression stored in this cell.

Parameters:

• cxt – model context instance.

• pos – position of the cell.

Returns:

an array of reference formula tokens. Each element is a pointer to the actual token instance stored in the cell object. Be aware that the pointer is valid only as long as the actual token instance is alive.

const formula_result &get_raw_result_cache(formula_result_wait_policy_t policy) const

Get the cached result without post-processing in case of a grouped formula cell.

Parameters:

policy – action to take in case the result is not yet available.

Returns:

formula result.

formula_result get_result_cache(formula_result_wait_policy_t policy) const

Get the cached result as a single cell. For a non-grouped formula cell, it should be identical to the value from the get_raw_result_cache() call. For a grouped formula cell, you’ll get a single value assigned to the position of the cell in case the original result is a matrix value.

Parameters:

policy – action to take in case the result is not yet available.

Returns:

formula result.

void set_result_cache(formula_result result)

Set a cached result to this formula cell instance.

Parameters:

result – cached result.

formula_group_t get_group_properties() const

abs_address_t get_parent_position(const abs_address_t &pos) const

Get the absolute parent position of a grouped formula cell. If the cell is not grouped, it simply returns the original position passed to this method.

Parameters:

pos – original position from which to calculate the parent position.

Returns:

parent position of the grouped formula cell.