Skip to contents

Function to set by reference the "when" attribute of an existing generic_spct or an object of a class derived from generic_spct.

Usage

setWhenMeasured(x, when.measured, ...)

when_measured(x) <- value

# S3 method for default
setWhenMeasured(x, when.measured, ...)

# S3 method for generic_spct
setWhenMeasured(x, when.measured = lubridate::now(tzone = "UTC"), ...)

# S3 method for summary_generic_spct
setWhenMeasured(x, when.measured = lubridate::now(tzone = "UTC"), ...)

# S3 method for generic_mspct
setWhenMeasured(x, when.measured = lubridate::now(tzone = "UTC"), ...)

Arguments

x

a generic_spct object

when.measured, value

POSIXct to add as attribute, or a list of POSIXct.

...

Allows use of additional arguments in methods for other classes.

Value

x

Methods (by class)

  • setWhenMeasured(default): default

  • setWhenMeasured(generic_spct): generic_spct

  • setWhenMeasured(summary_generic_spct): summary_generic_spct

  • setWhenMeasured(generic_mspct): generic_mspct

Note

This method alters x itself by reference and in addition returns x invisibly. If x is not a generic_spct or an object of a class derived from generic_spct, x is not modified. If when is not a POSIXct object or NULL an error is triggered. A POSIXct describes an instant in time (date plus time-of-day plus time zone).

Examples

my.spct <- sun.spct
when_measured(my.spct)
#> [1] "2010-06-22 09:51:00 UTC"
when_measured(my.spct) <- lubridate::ymd_hms("2020-01-01 08:00:00")
when_measured(my.spct)
#> [1] "2020-01-01 08:00:00 UTC"