modelCycle: Get the cycle of a periodic object

In GeoBosh/pcts: Periodically Correlated and Periodically Integrated Time Series

Get the cycle of a periodic object

Description

Get the cycle of a periodic object, a generic function.

Usage

modelCycle(object)

modelCycle(object, ... ) <- value

Arguments

object	an object.
value	the new value for the cycle, an object inheriting from "BasicCycle".
...	not used.

Details

modelCycle is essentially internal, for programming. The user level function to get the cycle of an object is pcCycle.

modelCycle returns the Cycle object (in the sense of package pcts), associated with object. modelCycle is a generic function which makes it possible to associate a cycle with objects from a class, without inheriting from the cycle classes.

By definition, NULL represents the model cycle of objects from classes with no (inherited) method for modelCycle.

The default method of modelCycle returns NULL. The default method for its replacement version throws error.

Value

for modelCycle, an object inheriting from class "BasicCycle" or NULL;

"modelCycle<-" is used for the side effect of changing the cycle of object.

Methods

signature(object = "ANY")

signature(object = "ModelCycleSpec")

GeoBosh/pcts documentation built on Dec. 8, 2023, 9:57 p.m.