antaresEditObject (version 0.6.4)

mockSimulationAPI: Mock API usage

Description

Use this to generate command without an active API connection, it allow to use function to edit a study to later on get API commands.

Usage

mockSimulationAPI(force = FALSE, antares_version = "8.2.0")

Value

An updated list containing various information about the simulation.

Arguments

force

Logical, force mocking simulation even if antaresRead::setSimulationPathAPI has already been called.

antares_version

Antares version number.

Examples

if (FALSE) {
# Mock simulation API
mockSimulationAPI()
# Create an area
createArea("new area")
# Get commands
getVariantCommands()
}