Entity

Class representing a PetroVisor entity object.

Public fields

name

The name of the entity.

entity_type_name

The name of the entity's type.

alias

The alias of the entity.

is_opportunity

Whether the entity is an opportunity or not.

Methods

Public methods

• Entity$new()

• Entity$toList()

• Entity$clone()

---

Method new()

Create a new Entity instance.

Usage

Entity$new(
  name = NULL,
  entity_type_name = NULL,
  alias = NULL,
  is_opportunity = FALSE
)

Arguments

name

The name of entity.

entity_type_name

The name of the entity' type.

alias

The alias of the entity.

is_opportunity

Whether the entity is an opportunity or not.

---

Method toList()

Usage

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

Entity$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

Examples

if (FALSE) { # \dontrun{
Entity$new(
  name = "NewWell",
  entity_type_name = "Well",
  alias = "NewWellAlias",
  is_opportunity = FALSE)
} # }