ExcludeResults: Exclude results class

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

Exclude results class

Description

Exclude results class

Exclude results class

Details

Definition for the ExcludeResults class.

Public fields

id

character value.

exclude

Exclude object.

status

logical value.

held

numeric value.

Methods

Public methods

• ExcludeResults$new()

• ExcludeResults$print()

• ExcludeResults$repr()

• ExcludeResults$get_results_data()

• ExcludeResults$get_widget_data()

• ExcludeResults$clone()

---

Method new()

Create a new ExcludeResults object.

Usage

ExcludeResults$new(id, exclude, held)

Arguments

id

character value.

exclude

Exclude object.

held

numeric value.

Returns

A new ExcludeResults object.

---

Method print()

Print the object.

Usage

ExcludeResults$print(...)

Arguments

...

not used.

---

Method repr()

Generate a character summarizing the representation of the object.

Usage

ExcludeResults$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

ExcludeResults$get_results_data()

Returns

tibble::tibble() object.

---

Method get_widget_data()

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

Usage

ExcludeResults$get_widget_data()

Returns

list with widget data.

---

Method clone()

The objects of this class are cloneable with this method.

Usage

ExcludeResults$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

See Also

new_exclude_results().

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