Class EsoReader

Namespace

EpNet.Results

Assembly

EpNet.dll

Reads and writes result files in eso format.

public class EsoReader

Inheritance

object

EsoReader

Extension Methods

ExtensionMethods.Deserialize<T>(T, string)

ExtensionMethods.Serialize<T>(T)

ExtensionMethods.Average(IEnumerable<ResultSet>)

ExtensionMethods.AverageAll(IEnumerable<ResultSet>)

ExtensionMethods.FirstAnnual(IEnumerable<ResultSet>, Func<string, bool>)

ExtensionMethods.FirstDaily(IEnumerable<ResultSet>, Func<string, bool>)

ExtensionMethods.FirstHourly(IEnumerable<ResultSet>, Func<string, bool>)

ExtensionMethods.FirstMonthly(IEnumerable<ResultSet>, Func<string, bool>)

ExtensionMethods.FirstRunPeriod(IEnumerable<ResultSet>, Func<string, bool>)

ExtensionMethods.FirstTimestep(IEnumerable<ResultSet>, Func<string, bool>)

ExtensionMethods.Get(IEnumerable<ResultSet>, string, string, Frequencies)

ExtensionMethods.GetAll(IEnumerable<ResultSet>, Func<string, bool>)

ExtensionMethods.GetAnnual(IEnumerable<ResultSet>, Func<string, bool>)

ExtensionMethods.GetDaily(IEnumerable<ResultSet>, Func<string, bool>)

ExtensionMethods.GetHourly(IEnumerable<ResultSet>, Func<string, bool>)

ExtensionMethods.GetMonthly(IEnumerable<ResultSet>, Func<string, bool>)

ExtensionMethods.GetRunPeriod(IEnumerable<ResultSet>, Func<string, bool>)

ExtensionMethods.GetTimestep(IEnumerable<ResultSet>, Func<string, bool>)

ExtensionMethods.GetZoneArea(IEnumerable<ResultSet>, IdfReader)

ExtensionMethods.GetZoneVolume(IEnumerable<ResultSet>, IdfReader)

ExtensionMethods.GetZones(IEnumerable<ResultSet>, IdfReader)

ExtensionMethods.GroupByBlock(IEnumerable<ResultSet>, IEnumerable<IdfObject>)

ExtensionMethods.GroupByComponent(IEnumerable<ResultSet>, IEnumerable<string>)

ExtensionMethods.GroupByZone(IEnumerable<ResultSet>, IEnumerable<IdfObject>)

ExtensionMethods.SetReportType(IEnumerable<ResultSet>, string)

ExtensionMethods.SetUnits(IEnumerable<ResultSet>, string)

ExtensionMethods.Sum(IEnumerable<ResultSet>)

ExtensionMethods.SumAll(IEnumerable<ResultSet>)

ExtensionMethods.ToAnnual(IEnumerable<ResultSet>)

ExtensionMethods.ToDaily(IEnumerable<ResultSet>)

ExtensionMethods.ToFrequency(IEnumerable<ResultSet>, Frequencies, bool)

ExtensionMethods.ToHourly(IEnumerable<ResultSet>)

ExtensionMethods.ToMonthly(IEnumerable<ResultSet>)

ExtensionMethods.ToRunPeriod(IEnumerable<ResultSet>)

Constructors

EsoReader()

Reads eplusout.eso from default DesignBuilder EnergyPlus folder.

public EsoReader()

EsoReader(string)

Reads an Eso file.

public EsoReader(string esoFilePath)

Parameters

esoFilePath string

Eso file absolute path.

EsoReader(params string[])

Reads more than one eso file as a joined set of results.

public EsoReader(params string[] esoFilePaths)

Parameters

esoFilePaths string[]

List of absolute paths.

Properties

Environments

public List<string> Environments { get; set; }

Property Value

List<string>

Id

Returns a unique Id for a resultset.

public static int Id { get; }

Property Value

int

Id integer number.

this[Func<string, bool>]

Retrieves all the ResultSets that meet the conditions specified by the filter function.

public IEnumerable<ResultSet> this[Func<string, bool> filter] { get; }

Parameters

filter Func<string, bool>

A function that takes a string (component name) and returns a boolean indicating whether the ResultSet should be included.

Property Value

IEnumerable<ResultSet>

An IEnumerable of ResultSet that meet the conditions specified by the filter function.

this[string]

Retrieves all the ResultSets that match the specified report type.

public IEnumerable<ResultSet> this[string reportType] { get; }

Parameters

reportType string

The report type to filter the ResultSets.

Property Value

IEnumerable<ResultSet>

An IEnumerable of ResultSet that match the specified report type.

OldResults

Retrieves the list of existent resultsets

public List<ResultSet> OldResults { get; set; }

Property Value

List<ResultSet>

ResultSet list.

Results

Retrieves the list of existent + newly created resultsets

public IEnumerable<ResultSet> Results { get; }

Property Value

IEnumerable<ResultSet>

ResultSet list.

SingleEnvironment

public bool SingleEnvironment { get; set; }

Property Value

bool

Methods

Add(ResultSet)

Add a resultset.

public void Add(ResultSet result)

Parameters

result ResultSet

ResultSet.

Add(params ResultSet[])

Add a param array of resultset.

public void Add(params ResultSet[] results)

Parameters

results ResultSet[]

Param array of ResultSets.

Add(IEnumerable<ResultSet>)

Adds a list of resultsets.

public void Add(IEnumerable<ResultSet> results)

Parameters

results IEnumerable<ResultSet>

List of resultsets.

AddEsoFile(string)

Reads another eso file and combines it with current results.

public void AddEsoFile(string esoFilePath)

Parameters

esoFilePath string

Absolute eso file path.

First(string, string, Frequencies)

Returns the first ResultSet that meets the conditions. Null if not found.

public ResultSet First(string component, string reportType, Frequencies frequency)

Parameters

component string

reportType string

frequency Frequencies

Returns

ResultSet

Get(Func<ResultSet, bool>)

Retrieves all the ResultSets that meet the conditions.

public IEnumerable<ResultSet> Get(Func<ResultSet, bool> conditions)

Parameters

conditions Func<ResultSet, bool>

Returns

IEnumerable<ResultSet>

Get(string)

Retrieves all the ResultSets that meet the conditions.

public IEnumerable<ResultSet> Get(string componentOrreportType)

Parameters

componentOrreportType string

Returns

IEnumerable<ResultSet>

Get(string, Frequencies)

Retrieves all the ResultSets that meet the conditions.

public IEnumerable<ResultSet> Get(string componentOrreportType, Frequencies frequency)

Parameters

componentOrreportType string

frequency Frequencies

Returns

IEnumerable<ResultSet>

Save(bool)

Saves the eso file overwriting current eso file.

public void Save(bool newResultsOnly = false)

Parameters

newResultsOnly bool

Only save newly created results.

Save(string, bool, bool)

Saves the eso file in an new file.

public void Save(string esoFilePath, bool newResultsOnly = false, bool sortNew = true)

Parameters

esoFilePath string

Absolute path for the new eso file.

newResultsOnly bool

Only save newly created results.

sortNew bool

Adds a first blank character to new results so they appear first in Results Viewer

TryGet(Func<ResultSet, bool>, out ResultSet)

Finds the first ResultSet that meets the conditions. A return value indicates whether the result is found or not.

public bool TryGet(Func<ResultSet, bool> conditions, out ResultSet result)

Parameters

conditions Func<ResultSet, bool>

result ResultSet

Returns

bool

TryGet(string, string, Frequencies, out ResultSet)

Finds the ResultSet that meets the conditions. A return value indicates whether the result is found or not.

public bool TryGet(string component, string reportType, Frequencies frequency, out ResultSet result)

Parameters

component string

reportType string

frequency Frequencies

result ResultSet

Returns

bool

TryGet(string, string, out ResultSet)

Finds the first ResultSet that meets the conditions. A return value indicates whether the result is found or not.

public bool TryGet(string component, string reportType, out ResultSet result)

Parameters

component string

reportType string

result ResultSet

Returns

bool