format.IdfObject {eplusr}

Format an IdfObject

Description

Format an IddObject into a character vector in the same way as in IDF Editor.

Usage

## S3 method for class 'IdfObject'
format(x, comment = TRUE, leading = 4L, sep_at = 29L, all = FALSE, ...)

Arguments

x

An IdfObject object.

comment

If FALSE, all comments will not be included. Default: TRUE.

leading

Leading spaces added to each field. Default: 4L.

sep_at

The character width to separate value string and field string. Default: 29L which is the same as IDF Editor.

all

If TRUE, values of all possible fields in current class the IdfObject belongs to are returned. Default: FALSE

...

Further arguments passed to or from other methods.

Value

A character vector.

Examples

## Not run: 
idf <- read_idf(system.file("extdata/1ZoneUncontrolled.idf", package = "eplusr"),
    idd = use_idd("8.8", download = "auto"))

# get the IdfObject of material named "C5 - 4 IN HW CONCRETE"
mat <- idf$Material[["C5 - 4 IN HW CONCRETE"]]

cat(format(mat, leading = 0, sep_at = 10))

## End(Not run)