Skip to contents

Hierarchy

Hierarchy.Rd

Class representing a PetroVisor hierarchy object.

Public fields

name

The name of the hierarchy.

relationship

The child-parent relationships stored in the hierarchy. A single data frame with the columns child and parent if the hierarchy is static. For time-dependent hierarchies a list of data frames. The names of the list refer to the date of the relationship.

is_time_dependent

Whether the hierarchy is time dependent or static.

time_stamp

The (first) time stamp of the time dependent hierarchy.

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

Hierarchy$new(
  name = NULL,
  relationship = NULL,
  is_time_dependent = FALSE,
  time_stamp = NULL,
  description = NULL,
  labels = list()
)

Arguments

name

The name of the hierarchy.

relationship

The child-parent relationships stored in the hierarchy. A single data frame with the columns child and parent if the hierarchy is static. For time-dependent hierarchies a list of data frames. The names of the list refer to the date of the relationship.

is_time_dependent

Whether the hierarchy is time dependent or static.

time_stamp

The (first) time stamp of the time dependent hierarchy.

description

The description of the item.

labels

A list of strings holding the labels of the scope.

Method toList()

Usage

Hierarchy$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

Hierarchy$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

Examples

if (FALSE) { # \dontrun{
Hierarchy$new(name = "MyHierarchy",
              relationship = list(Well1 = "Parent1",
                                  Well2 = "Parent1",
                                  Parent1 = NA))
} # }