ncdfCF (version 0.4.0)

CFAxisTime: Time axis object

Description

This class represents a time axis. The functionality is provided by the CFTime class in the CFtime package.

Super classes

ncdfCF::CFObject -> ncdfCF::CFAxis -> CFAxisTime

Public fields

values

The CFTime instance to manage CF time.

Active bindings

friendlyClassName

(read-only) A nice description of the class.

dimnames

(read-only) The coordinates of the axis as a character vector.

Methods

Public methods

• CFAxisTime$new()

• CFAxisTime$print()

• CFAxisTime$brief()

• CFAxisTime$time()

• CFAxisTime$indexOf()

• CFAxisTime$slice()

• CFAxisTime$sub_axis()

• CFAxisTime$clone()

Inherited methods

• ncdfCF::CFObject$append_attribute()
• ncdfCF::CFObject$attribute()
• ncdfCF::CFObject$delete_attribute()
• ncdfCF::CFObject$print_attributes()
• ncdfCF::CFObject$set_attribute()
• ncdfCF::CFObject$write_attributes()
• ncdfCF::CFAxis$label_set()
• ncdfCF::CFAxis$peek()
• ncdfCF::CFAxis$shard()
• ncdfCF::CFAxis$write()

---

Method new()

Create a new instance of this class.

Usage

CFAxisTime$new(grp, nc_var, nc_dim, values)

Arguments

grp

The group that contains the netCDF variable.

nc_var

The netCDF variable that describes this instance.

nc_dim

The netCDF dimension that describes the dimensionality.

values

The CFTime instance that manages this axis.

---

Method print()

Summary of the time axis printed to the console.

Usage

CFAxisTime$print(...)

Arguments

...

Arguments passed on to other functions. Of particular interest is width = to indicate a maximum width of attribute columns.

Returns

self, invisibly.

---

Method brief()

Some details of the axis.

Usage

CFAxisTime$brief()

Returns

A 1-row data.frame with some details of the axis.

---

Method time()

Retrieve the CFTime instance that manages the values of this axis.

Usage

CFAxisTime$time()

Returns

An instance of CFTime.

---

Method indexOf()

Retrieve the indices of supplied values on the time axis.

Usage

CFAxisTime$indexOf(x, method = "constant", rightmost.closed = FALSE)

Arguments

x

A vector of timestamps whose indices into the time axis to extract.

method

Extract index values without ("constant", the default) or with ("linear") fractional parts.

rightmost.closed

Whether or not to include the upper limit. Default is FALSE.

Returns

An integer vector giving the indices in the time axis of valid values in x, or integer(0) if none of the values are valid.

---

Method slice()

Retrieve the indices of the time axis falling between two extreme values.

Usage

CFAxisTime$slice(x, rightmost.closed = FALSE)

Arguments

x

A vector of two timestamps in between of which all indices into the time axis to extract.

rightmost.closed

Whether or not to include the upper limit. Default is FALSE.

Returns

An integer vector giving the indices in the time axis between values in x, or integer(0) if none of the values are valid.

---

Method sub_axis()

Return an axis spanning a smaller dimension range. This method returns an axis which spans the range of indices given by the rng argument.

Usage

CFAxisTime$sub_axis(group, rng = NULL)

Arguments

group

The group to create the new axis in.

rng

The range of values from this axis to include in the returned axis.

Returns

A CFAxisTime instance covering the indicated range of indices. If the rng argument includes only a single value, an CFAxisScalar instance is returned with its value being the character timestamp of the value in this axis. If the value of the argument is NULL, return the entire axis (possibly as a scalar axis).

---

Method clone()

The objects of this class are cloneable with this method.

Usage

CFAxisTime$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.