EntitySet — EntitySet • Myrconn.PetroVisor.Client

Class representing a PetroVisor entity set object.

Public fields

name: The name of the entity set.
entities: list of entity objects.
formula: The entity set's definition as string (P# syntax).
description: The description of the item.
labels: A list of strings holding the labels of the entity set.

Methods

Public methods

EntitySet$new()
EntitySet$toList()
EntitySet$clone()

Method `new()`

Create a new EntitySet instance.

Usage

EntitySet$new(
  name = NULL,
  entities = NULL,
  formula = NULL,
  description = NULL,
  labels = list()
)

Arguments

name: The name of the entity set.
entities: list of entity objects.
formula: The entity set's definition as string (P# syntax).
description: The description of the item.
labels: A list of strings holding the labels of the entity set.

Method `toList()`

Usage

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

EntitySet$clone(deep = FALSE)

Arguments

deep: Whether to make a deep clone.

Examples