Skip to contents

Scope

Scope.Rd

Class representing a PetroVisor scope object.

Public fields

name

The name of the scope.

start

The scope's start date.

end

The scope's end date.

time_increment

The scope's time increment. Allowed values are: "EveryMinute", "EveryFiveMinutes", "EveryFifteenMinutes", "Hourly", "Daily", "Monthly", "Quarterly", "Yearly"

depth_increment

The scope's depth increment. Allowed values are: "Meter", "HalfMeter", "EighthMeter", "TenthMeter", "Foot", "HalfFoot"

start_depth

The scope's start depth.

end_depth

The scope's end depth.

formula

The scope's definition as string (P# syntax).

description

The description of the item.

labels

A list of strings holding the labels of the scope.

Methods

Public methods

Method new()

Create a new Scope instance.

Usage

Scope$new(
  name = NULL,
  start = NULL,
  end = NULL,
  time_increment = c("", "EveryMinute", "EveryFiveMinutes", "EveryFifteenMinutes",
    "Hourly", "Daily", "Monthly", "Quarterly", "Yearly"),
  depth_increment = c("", "Meter", "HalfMeter", "EighthMeter", "TenthMeter", "Foot",
    "HalfFoot"),
  start_depth = NULL,
  end_depth = NULL,
  formula = NULL,
  description = NULL,
  labels = list()
)

Arguments

name

The name of the scope.

start

The scope's start date.

end

The scope's end date.

time_increment

The scope's time increment. Allowed values are: "EveryMinute", "EveryFiveMinutes", "EveryFifteenMinutes", "Hourly", "Daily", "Monthly", "Quarterly", "Yearly"

depth_increment

The scope's depth increment. Allowed values are: "Meter", "HalfMeter", "EighthMeter", "TenthMeter", "Foot", "HalfFoot"

start_depth

The scope's start depth.

end_depth

The scope's end depth.

formula

The scope's definition as string (P# syntax).

description

The description of the item.

labels

A list of strings holding the labels of the scope.

Method toList()

Usage

Scope$toList()

Details

Convert the object to a list. This function is mainly used by the RepositoryService to convert the objects to lists and then call the web API.

Method clone()

The objects of this class are cloneable with this method.

Usage

Scope$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

Examples

if (FALSE) { # \dontrun{
Scope$new(name = "MyScope",
          start = "2020-01-01T00:00:00.000Z",
          end = "2020-03-01T00:00:00.000Z",
          time_increment = "Daily")
} # }