get_idf_node_relation: Extract node relations
In eplusr: A Toolkit for Using Whole Building Simulation Program 'EnergyPlus'

get_idf_node_relation

R Documentation

Extract node relations

Description

Extract node relations

Usage

get_idf_node_relation(
  idd_env,
  idf_env,
  object_id = NULL,
  value_id = NULL,
  object = NULL,
  class = NULL,
  group = NULL,
  name = FALSE,
  keep_all = FALSE,
  depth = 0L
)

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.
`object_id`	An integer vector of valid object IDs. If `NULL`, all object IDs in current IDF will be used.
`value_id`	An integer vector of valid value IDs. If `NULL`, all value IDs in current IDF will be used.
`object`	An integer vector of valid object IDs or a character vector of valid object names to specify the targeting relation objects. Default: `NULL`.
`class`	An integer vector of valid class indexes or a character vector of valid class names to specify the targeting relation classes. Default: `NULL`.
`group`	A character vector of valid group names to specify the targeting relation groups. Default: `NULL`.
`name`	If `TRUE`, all class, object, field value ID and name columns will be added and a `IdfRelationTo` or `IdfRelationBy` object is returned with customized printing method. Default: `FALSE`.
`keep_all`	If `TRUE`, all input ID are kept. Otherwise, only input IDs that have relations are kept. Default: `FALSE`.
`depth`	Recursive reference relation depth. `NULL` means infinite. Default: `0L`.