WeightResults: Weight results class

In NCC-CNC/wheretowork: Interactive Systematic Conservation Planning Application

Weight results class

Description

Weight results class

Weight results class

Details

Definition for the WeightResults class.

Public fields

id

character value.

weight

Weight object.

status

logical value.

factor

numeric value.

current

numeric value.

held

numeric value.

Methods

Public methods

• WeightResults$new()

• WeightResults$print()

• WeightResults$repr()

• WeightResults$get_results_data()

• WeightResults$get_widget_data()

• WeightResults$clone()

---

Method new()

Create a new WeightResults object.

Usage

WeightResults$new(id, weight, held)

Arguments

id

character value.

weight

Weight object.

held

numeric value.

Returns

A new WeightResults object.

---

Method print()

Print the object.

Usage

WeightResults$print(...)

Arguments

...

not used.

---

Method repr()

Generate a character summarizing the representation of the object.

Usage

WeightResults$repr(start = "[", end = "]")

Arguments

start

character symbol used to start the setting list. Defaults to "[".

end

character symbol used to start the setting list. Defaults to "]".

Returns

character value.

---

Method get_results_data()

Get results.

Usage

WeightResults$get_results_data()

Returns

tibble::tibble() object.

---

Method get_widget_data()

Get data for displaying the object in a solutionResults() widget.

Usage

WeightResults$get_widget_data()

Returns

list with widget data.

---

Method clone()

The objects of this class are cloneable with this method.

Usage

WeightResults$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

See Also

new_weight_results().

NCC-CNC/wheretowork documentation built on Feb. 27, 2025, 6:11 p.m.