del_idf_object: Delete existing objects
In eplusr: A Toolkit for Using Whole Building Simulation Program 'EnergyPlus'

del_idf_object

R Documentation

Delete existing objects

Description

Delete existing objects

Usage

del_idf_object(
  idd_env,
  idf_env,
  dt_object,
  ref_to = FALSE,
  ref_by = FALSE,
  recursive = FALSE,
  force = FALSE,
  level = eplusr_option("validate_level")
)

Arguments

`idd_env`	An environment or list contains IDD tables including class, field, and reference.
`idf_env`	An environment or list contains IDF tables including object, value, and reference.
`dt_object`	A `data.table::data.table()` that contains object data.
`ref_to`	If `TRUE`, objects whose fields are referred by input objects will also be deleted. Default: `FALSE`.
`ref_by`	If `TRUE`, objects whose fields refer to input objects will also be deleted. Default: `FALSE`.
`recursive`	If `TRUE`, relation searching is performed recursively, in case that objects whose fields refer to target object are also referred by another object, and also objects whose fields are referred by target object are also referred by another object. Default: `FALSE`.
`force`	If `TRUE`, objects are deleted even if they are referred by other objects.
`level`	Validate level. Default: `eplusr_option("validate_level")`.

Value

The modified Idf data in a named list of 5 elements, i.e. object, value, reference, changed and updated. First 3 elements are data.table::data.table()s containing the actual updated Idf data while changed and updated are integer vectors containing IDs of objects that have been directly changed and indirectly updated due to references, respectively.