/
gettersSetters.R
186 lines (177 loc) · 4.29 KB
/
gettersSetters.R
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
#' @include aaa.R
NULL
#### getLayer ####
#' @export
setGeneric(
"getLayer",
function(x, ...) standardGeneric("getLayer")
)
#' Get layer
#'
#' Obtains a project raster layer for further analysis.
#'
#' @inheritParams erosionPrerequisites,RPhosFate-method
#' @param i A character string specifying a layer name. Substance related layers
#' whose names start with _xx_ are treated differently. They have to be
#' queried by their name (not filename), for example, `"xxc"` in combination
#' with `"PP"` in argument `j` queries the particulate phosphorus
#' concentrations in top soils. See subdirectory sections for further
#' information.
#' @param j A character string specifying a substance if applicable.
#'
#' @inheritSection catchment _Input_ subdirectory
#'
#' @inheritSection catchment _Intermediate_ subdirectory
#'
#' @inheritSection catchment _Result_ subdirectory
#'
#' @return A [`terra::SpatRaster-class`] object.
#'
#' @examples
#' \donttest{
#' # temporary demonstration project copy
#' cv_dir <- demoProject()
#' # load temporary demonstration project
#' x <- RPhosFate(
#' cv_dir = cv_dir,
#' ls_ini = TRUE
#' )
#' # presupposed method call
#' x <- firstRun(x, "SS")
#'
#' getLayer(x, "dir")
#' getLayer(x, "xxt", "SS")
#' getLayer(x, "xxe", "PP")}
#'
#' @aliases getLayer
#'
#' @export
setMethod(
"getLayer",
"RPhosFate",
function(x, i, j = NULL) {
qassert(i, "S1")
if (!is.null(j)) {
assertChoice(j, slotNames(x@substances))
assertSubset(i, sub("^rl_", "", slotNames(slot(x@substances, j))))
return(slot(slot(x@substances, j), sprintf("rl_%s", i)))
} else {
for (object in c("topo", "erosion", "transport")) {
if (i %in% sub("^rl_", "", slotNames(slot(x, object)))) {
return(slot(slot(x, object), sprintf("rl_%s", i)))
}
}
}
stop(sprintf("Layer %s was not found.", deparse(i)), call. = FALSE)
}
)
#' @rdname getLayer-RPhosFate-method
#' @export
setMethod(
"[",
"RPhosFate",
function(x, i, j) {
if (missing(j)) {
j <- NULL
}
getLayer(x, i, j)
}
)
#### getParameter ####
#' @export
setGeneric(
"getParameter",
function(x, ...) standardGeneric("getParameter")
)
#' Get parameter(s)
#'
#' Obtains a single model parameter or all model parameters at once.
#'
#' @inheritParams erosionPrerequisites,RPhosFate-method
#' @param parameter A character string specifying a parameter name or `NULL` for
#' a [`list`] of all parameters. See model parameter arguments section for
#' further information.
#'
#' @inheritSection catchment Model parameter arguments
#'
#' @return Depends on the queried parameter or a [`list`] in case of all
#' parameters. See model parameter arguments section for further information.
#'
#' @seealso [`setParameter`]
#'
#' @examples
#'
#' # temporary demonstration project copy
#' cv_dir <- demoProject()
#' # load temporary demonstration project
#' x <- RPhosFate(
#' cv_dir = cv_dir,
#' ls_ini = TRUE
#' )
#'
#' getParameter(x)
#' getParameter(x, "ns_dep_ovl")
#'
#' @aliases getParameter
#'
#' @export
setMethod(
"getParameter",
"RPhosFate",
function(x, parameter = NULL) {
if (!is.null(parameter)) {
assertChoice(parameter, slotNames(x@parameters))
slot(x@parameters, parameter)
} else {
slots2list(x@parameters)
}
}
)
#### setParameter ####
#' @export
setGeneric(
"setParameter",
function(x, ...) standardGeneric("setParameter")
)
#' Set parameter(s)
#'
#' Sets one or more model parameters or substance parameter values.
#'
#' @inheritParams erosionPrerequisites,RPhosFate-method
#' @param \dots Names and values of the parameters to set. See model parameter
#' arguments section for further information.
#'
#' @inheritSection catchment Model parameter arguments
#'
#' @inherit catchment return
#'
#' @seealso [`getParameter`]
#'
#' @examples
#'
#' # temporary demonstration project copy
#' cv_dir <- demoProject()
#' # load temporary demonstration project
#' x <- RPhosFate(
#' cv_dir = cv_dir,
#' ls_ini = TRUE
#' )
#'
#' x <- setParameter(x, ns_dep_ovl = 15e-4)
#' x <- setParameter(
#' x,
#' nv_tfc_inl = c(SS = 0.6, PP = 0.6),
#' nv_enr_rto = c(PP = 1.4)
#' )
#'
#' @aliases setParameter
#'
#' @export
setMethod(
"setParameter",
"RPhosFate",
function(x, ...) {
x@parameters <- populateParameterSlots(x@parameters, list(...))
x
}
)