add_idf_object: Add new objects
In eplusr: A Toolkit for Using Whole Building Simulation Program 'EnergyPlus'

add_idf_object

R Documentation

Add new objects

Description

Add new objects

Usage

add_idf_object(
  idd_env,
  idf_env,
  dt_object,
  dt_value,
  default = TRUE,
  unique = FALSE,
  empty = 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.
`dt_value`	A `data.table::data.table()` that contains value data.
`default`	If `TRUE`, default values are used for those blank fields if possible. If `FALSE`, empty fields are kept blank. Default: `TRUE`.
`unique`	If `TRUE`, there are same objects in current Idf as input, duplications in input are removed. Default: `FALSE`.
`empty`	If `TRUE`, trailing empty fields are kept. Default: `FALSE`.
`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.