dot-getEntity: Retrieve a single entity by path in the given container

In Open-Systems-Pharmacology/OSPSuite-R: R package to manipulate OSPSuite Models

Retrieve a single entity by path in the given container

Description

Retrieve a single entity by path in the given container

Usage

.getEntity(path, container, entityType, stopIfNotFound = TRUE)

Arguments

path	A string representing the path relative to the container
container	A Container or Simulation used to find the entities
entityType	Class of the type that should be returned. Supported types are Container, Quantity, and Parameter.
stopIfNotFound	Boolean. If TRUE (default) and no entity exists for the given path, an error is thrown. If FALSE, NULL is returned.

Value

The Entity with the given path coerced to the entityType. If the entity for the path does not exist, an error is thrown in case of stopIfNotFound is TRUE (default), otherwise NULL

See Also

loadSimulation(), getContainer() and getAllContainersMatching() to create objects of type Container or Simulation

Open-Systems-Pharmacology/OSPSuite-R documentation built on April 28, 2024, 2:24 a.m.