Skip to content

DiGi.Analytical.Building.HVAC

github-actions[bot] edited this page Jul 15, 2026 · 2 revisions

DiGi.Analytical.Building.HVAC Namespace

Classes

Create Class

public static class Create

Inheritance System.Object → Create

Methods

Create.RegulatedHeatTransferCoefficientsManager() Method

Creates and initializes a new instance of the RegulatedHeatTransferCoefficientsManager() class populated with predefined regulatory heat transfer coefficients.

public static DiGi.Analytical.Building.HVAC.Classes.RegulatedHeatTransferCoefficientsManager RegulatedHeatTransferCoefficientsManager();

Returns

RegulatedHeatTransferCoefficientsManager
A configured instance of RegulatedHeatTransferCoefficientsManager().

Modify Class

public static class Modify

Inheritance System.Object → Modify

Methods

Modify.Assign(this BuildingModel, ISpace, IInternalCondition, string) Method

Assigns a specified internal condition to a space within the building model.

public static bool Assign(this DiGi.Analytical.Building.Classes.BuildingModel? buildingModel, DiGi.Analytical.Building.Interfaces.ISpace? space, DiGi.Analytical.Building.Interfaces.IInternalCondition? internalCondition, string? id=null);

Parameters

buildingModel DiGi.Analytical.Building.Classes.BuildingModel

The DiGi.Analytical.Building.Classes.BuildingModel instance that manages the assignment.

space DiGi.Analytical.Building.Interfaces.ISpace

The DiGi.Analytical.Building.Interfaces.ISpace to which the internal condition is assigned.

internalCondition DiGi.Analytical.Building.Interfaces.IInternalCondition

The DiGi.Analytical.Building.Interfaces.IInternalCondition to be applied to the space.

id System.String

An optional unique identifier for the assignment.

Returns

System.Boolean
True if the internal condition was successfully assigned; otherwise, false.

Modify.SetHeatingEmitter(this InternalCondition, CoolingEmitter) Method

Sets the cooling emitter for the specified internal condition.

public static bool SetHeatingEmitter(this DiGi.Analytical.Building.Classes.InternalCondition? internalCondition, DiGi.Analytical.Building.HVAC.Classes.CoolingEmitter? coolingEmitter);

Parameters

internalCondition DiGi.Analytical.Building.Classes.InternalCondition

The internal condition instance to modify.

coolingEmitter CoolingEmitter

The cooling emitter to assign to the internal condition.

Returns

System.Boolean
True if the cooling emitter was successfully set; otherwise, false.

Modify.SetHeatingEmitter(this InternalCondition, HeatingEmitter) Method

Sets the heating emitter for the specified internal condition.

public static bool SetHeatingEmitter(this DiGi.Analytical.Building.Classes.InternalCondition? internalCondition, DiGi.Analytical.Building.HVAC.Classes.HeatingEmitter? heatingEmitter);

Parameters

internalCondition DiGi.Analytical.Building.Classes.InternalCondition

The internal condition to modify.

heatingEmitter HeatingEmitter

The heating emitter to assign.

Returns

System.Boolean
true if the value was successfully set; otherwise, false.

Modify.SetInternalGain(this InternalCondition, InternalGain) Method

Sets the internal gain for the specified internal condition.

public static bool SetInternalGain(this DiGi.Analytical.Building.Classes.InternalCondition? internalCondition, DiGi.Analytical.Building.HVAC.Classes.InternalGain? internalGain);

Parameters

internalCondition DiGi.Analytical.Building.Classes.InternalCondition

The internal condition instance to modify.

internalGain InternalGain

The internal gain value to be set.

Returns

System.Boolean
True if the internal gain was successfully set; otherwise, false.

Modify.SetProfile(this InternalCondition, InternalGainProfileType, IProfile) Method

Sets a specific internal gain profile for the provided internal condition.

public static bool SetProfile(this DiGi.Analytical.Building.Classes.InternalCondition? internalCondition, DiGi.Analytical.Building.HVAC.Enums.InternalGainProfileType internalGainProfileType, DiGi.Analytical.Building.Interfaces.IProfile? profile);

Parameters

internalCondition DiGi.Analytical.Building.Classes.InternalCondition

The internal condition instance to modify.

internalGainProfileType InternalGainProfileType

The type of internal gain profile to be assigned.

profile DiGi.Analytical.Building.Interfaces.IProfile

The profile implementation to assign to the specified internal gain profile type.

Returns

System.Boolean
True if the profile was successfully set; otherwise, false.

Modify.SetProfile(this InternalCondition, ThermostatProfileType, IProfile) Method

Sets the specified profile for a thermostat of the given profile type within the internal condition.

public static bool SetProfile(this DiGi.Analytical.Building.Classes.InternalCondition? internalCondition, DiGi.Analytical.Building.HVAC.Enums.ThermostatProfileType thermostatProfileType, DiGi.Analytical.Building.Interfaces.IProfile? profile);

Parameters

internalCondition DiGi.Analytical.Building.Classes.InternalCondition

The internal condition instance to modify.

thermostatProfileType ThermostatProfileType

The type of thermostat profile to set.

profile DiGi.Analytical.Building.Interfaces.IProfile

The profile to assign to the specified thermostat profile type.

Returns

System.Boolean
True if the profile was successfully set or updated; otherwise, false.

Modify.SetSystemProperties(this InternalCondition, SystemProperties) Method

Sets the system properties for the specified internal condition.

public static bool SetSystemProperties(this DiGi.Analytical.Building.Classes.InternalCondition? internalCondition, DiGi.Analytical.Building.HVAC.Classes.SystemProperties? systemProperties);

Parameters

internalCondition DiGi.Analytical.Building.Classes.InternalCondition

The internal condition instance to modify.

systemProperties SystemProperties

The system properties to be assigned.

Returns

System.Boolean
true if the system properties were successfully set; otherwise, false.

Modify.SetThermostat(this InternalCondition, Thermostat) Method

Sets the thermostat parameter for the specified internal condition.

public static bool SetThermostat(this DiGi.Analytical.Building.Classes.InternalCondition? internalCondition, DiGi.Analytical.Building.HVAC.Classes.Thermostat? thermostat);

Parameters

internalCondition DiGi.Analytical.Building.Classes.InternalCondition

The internal condition instance to be modified.

thermostat Thermostat

The thermostat object to assign to the internal condition.

Returns

System.Boolean
True if the thermostat was successfully set; otherwise, false.

Query Class

public static class Query

Inheritance System.Object → Query

Methods

Query.CoolingEmitter(this IInternalCondition) Method

Retrieves the cooling emitter associated with the specified internal condition.

public static DiGi.Analytical.Building.HVAC.Classes.CoolingEmitter? CoolingEmitter(this DiGi.Analytical.Building.Interfaces.IInternalCondition? internalCondition);

Parameters

internalCondition DiGi.Analytical.Building.Interfaces.IInternalCondition

The internal condition from which to retrieve the cooling emitter.

Returns

CoolingEmitter
The CoolingEmitter(this IInternalCondition) if found; otherwise, null.

Query.HeatingEmitter(this IInternalCondition) Method

Retrieves the heating emitter associated with the specified internal condition.

public static DiGi.Analytical.Building.HVAC.Classes.HeatingEmitter? HeatingEmitter(this DiGi.Analytical.Building.Interfaces.IInternalCondition? internalCondition);

Parameters

internalCondition DiGi.Analytical.Building.Interfaces.IInternalCondition

The internal condition from which to retrieve the heating emitter.

Returns

HeatingEmitter
The HeatingEmitter(this IInternalCondition) if found; otherwise, null.

Query.IndexedDoubles(this BuildingModel, ISpace, Range<int>, InternalGainProfileType, string) Method

Retrieves a collection of double-precision floating-point values for the specified internal gain profile within a given space and index range.

public static DiGi.Core.Classes.IndexedDoubles? IndexedDoubles(this DiGi.Analytical.Building.Classes.BuildingModel? buildingModel, DiGi.Analytical.Building.Interfaces.ISpace? space, DiGi.Core.Classes.Range<int>? range, DiGi.Analytical.Building.HVAC.Enums.InternalGainProfileType internalGainProfileType, string? id=null);

Parameters

buildingModel DiGi.Analytical.Building.Classes.BuildingModel

The building model to query.

space DiGi.Analytical.Building.Interfaces.ISpace

The space from which to retrieve the data.

range DiGi.Core.Classes.Range<System.Int32>

The range of indices for the values to be retrieved.

internalGainProfileType InternalGainProfileType

The type of internal gain profile to query.

id System.String

An optional identifier used to filter or specify the data source.

Returns

DiGi.Core.Classes.IndexedDoubles
An DiGi.Core.Classes.IndexedDoubles instance containing the retrieved values, or null if any required parameters are null or invalid.

Query.IndexedDoubles(this BuildingModel, ISpace, Range<int>, ThermostatProfileType, string) Method

Retrieves a collection of double-precision floating-point values mapped to integer indices for a specified thermostat profile within a building space.

public static DiGi.Core.Classes.IndexedDoubles? IndexedDoubles(this DiGi.Analytical.Building.Classes.BuildingModel? buildingModel, DiGi.Analytical.Building.Interfaces.ISpace? space, DiGi.Core.Classes.Range<int>? range, DiGi.Analytical.Building.HVAC.Enums.ThermostatProfileType thermostatProfileType, string? id=null);

Parameters

buildingModel DiGi.Analytical.Building.Classes.BuildingModel

The building model containing the data.

space DiGi.Analytical.Building.Interfaces.ISpace

The space associated with the thermostat profile.

range DiGi.Core.Classes.Range<System.Int32>

The range of indices to retrieve.

thermostatProfileType ThermostatProfileType

The type of thermostat profile to query.

id System.String

An optional identifier for the specific profile or data source.

Returns

DiGi.Core.Classes.IndexedDoubles
An DiGi.Core.Classes.IndexedDoubles instance containing the retrieved values, or null if the building model, space, range, or profile type is invalid or undefined.

Query.IndexedDoubles(this BuildingModel, ISpace, Range<int>, Enum, string) Method

Retrieves a collection of indexed double-precision floating-point values for a specific space and profile type within the building model.

public static DiGi.Core.Classes.IndexedDoubles? IndexedDoubles(this DiGi.Analytical.Building.Classes.BuildingModel? buildingModel, DiGi.Analytical.Building.Interfaces.ISpace? space, DiGi.Core.Classes.Range<int>? range, System.Enum? @enum, string? id=null);

Parameters

buildingModel DiGi.Analytical.Building.Classes.BuildingModel

The DiGi.Analytical.Building.Classes.BuildingModel instance to query.

space DiGi.Analytical.Building.Interfaces.ISpace

The DiGi.Analytical.Building.Interfaces.ISpace associated with the data retrieval.

range DiGi.Core.Classes.Range<System.Int32>

The DiGi.Core.Classes.Range<> of integers defining the index range.

enum System.Enum

The enumeration value specifying the profile type, such as ThermostatProfileType or InternalGainProfileType.

id System.String

An optional unique identifier for the internal condition.

Returns

DiGi.Core.Classes.IndexedDoubles
An DiGi.Core.Classes.IndexedDoubles instance if matching data is found; otherwise, null.

Query.IndexedDoubles(this BuildingModel, ISpace, int, int, InternalGainProfileType, string) Method

Retrieves a collection of double-precision floating-point values mapped to integer indices for a specific internal gain profile within a specified range.

public static DiGi.Core.Classes.IndexedDoubles? IndexedDoubles(this DiGi.Analytical.Building.Classes.BuildingModel? buildingModel, DiGi.Analytical.Building.Interfaces.ISpace? space, int start, int end, DiGi.Analytical.Building.HVAC.Enums.InternalGainProfileType internalGainProfileType, string? id=null);

Parameters

buildingModel DiGi.Analytical.Building.Classes.BuildingModel

The building model containing the data.

space DiGi.Analytical.Building.Interfaces.ISpace

The space associated with the internal gain profile.

start System.Int32

The starting index of the value range to retrieve.

end System.Int32

The ending index of the value range to retrieve.

internalGainProfileType InternalGainProfileType

The type of internal gain profile to be retrieved.

id System.String

An optional identifier for the specific internal gain profile.

Returns

DiGi.Core.Classes.IndexedDoubles
An DiGi.Core.Classes.IndexedDoubles instance containing the values if successful; otherwise, null.

Query.IndexedDoubles(this BuildingModel, ISpace, int, int, ThermostatProfileType, string) Method

Retrieves a collection of double-precision floating-point values mapped to integer indices for a specified thermostat profile within a given space and range.

public static DiGi.Core.Classes.IndexedDoubles? IndexedDoubles(this DiGi.Analytical.Building.Classes.BuildingModel? buildingModel, DiGi.Analytical.Building.Interfaces.ISpace? space, int start, int end, DiGi.Analytical.Building.HVAC.Enums.ThermostatProfileType thermostatProfileType, string? id=null);

Parameters

buildingModel DiGi.Analytical.Building.Classes.BuildingModel

The building model containing the data.

space DiGi.Analytical.Building.Interfaces.ISpace

The space associated with the thermostat profile.

start System.Int32

The starting index of the requested range.

end System.Int32

The ending index of the requested range.

thermostatProfileType ThermostatProfileType

The type of thermostat profile to be retrieved.

id System.String

An optional identifier for the specific profile instance.

Returns

DiGi.Core.Classes.IndexedDoubles
An DiGi.Core.Classes.IndexedDoubles instance containing the values if successful; otherwise, null.

Query.InternalGain(this IInternalCondition) Method

Retrieves the internal gain from the specified internal condition.

public static DiGi.Analytical.Building.HVAC.Classes.InternalGain? InternalGain(this DiGi.Analytical.Building.Interfaces.IInternalCondition? internalCondition);

Parameters

internalCondition DiGi.Analytical.Building.Interfaces.IInternalCondition

The internal condition to retrieve the internal gain from.

Returns

InternalGain
The InternalGain(this IInternalCondition) if successfully retrieved; otherwise, null.

Query.Profile(this IInternalCondition, InternalGainProfileType) Method

Retrieves the internal gain profile for the specified profile type from the given internal condition.

public static DiGi.Analytical.Building.Interfaces.IProfile? Profile(this DiGi.Analytical.Building.Interfaces.IInternalCondition? internalCondition, DiGi.Analytical.Building.HVAC.Enums.InternalGainProfileType internalGainProfileType);

Parameters

internalCondition DiGi.Analytical.Building.Interfaces.IInternalCondition

The internal condition instance to query.

internalGainProfileType InternalGainProfileType

The specific internal gain profile type to retrieve.

Returns

DiGi.Analytical.Building.Interfaces.IProfile
The matching DiGi.Analytical.Building.Interfaces.IProfile if found; otherwise, null.

Query.Profile(this IInternalCondition, ThermostatProfileType) Method

Retrieves the specified thermostat profile for the given internal condition.

public static DiGi.Analytical.Building.Interfaces.IProfile? Profile(this DiGi.Analytical.Building.Interfaces.IInternalCondition? internalCondition, DiGi.Analytical.Building.HVAC.Enums.ThermostatProfileType thermostatProfileType);

Parameters

internalCondition DiGi.Analytical.Building.Interfaces.IInternalCondition

The internal condition instance to query.

thermostatProfileType ThermostatProfileType

The specific type of thermostat profile to retrieve.

Returns

DiGi.Analytical.Building.Interfaces.IProfile
The matching DiGi.Analytical.Building.Interfaces.IProfile if found; otherwise, null.

Query.Profiles(this IInternalCondition) Method

Retrieves a list of all profiles associated with the specified internal condition.

public static System.Collections.Generic.List<DiGi.Analytical.Building.Interfaces.IProfile>? Profiles(this DiGi.Analytical.Building.Interfaces.IInternalCondition? internalCondition);

Parameters

internalCondition DiGi.Analytical.Building.Interfaces.IInternalCondition

The internal condition to retrieve profiles from.

Returns

System.Collections.Generic.List<DiGi.Analytical.Building.Interfaces.IProfile>
A list of DiGi.Analytical.Building.Interfaces.IProfile instances if the internal condition is not null; otherwise, null.

Query.SystemProperties(this IInternalCondition) Method

Retrieves the system properties associated with the specified internal condition.

public static DiGi.Analytical.Building.HVAC.Classes.SystemProperties? SystemProperties(this DiGi.Analytical.Building.Interfaces.IInternalCondition? internalCondition);

Parameters

internalCondition DiGi.Analytical.Building.Interfaces.IInternalCondition

The internal condition instance to query for system properties.

Returns

SystemProperties
The SystemProperties(this IInternalCondition) if found; otherwise, null.

Query.Thermostat(this IInternalCondition) Method

Retrieves the thermostat associated with the specified internal condition.

public static DiGi.Analytical.Building.HVAC.Classes.Thermostat? Thermostat(this DiGi.Analytical.Building.Interfaces.IInternalCondition? internalCondition);

Parameters

internalCondition DiGi.Analytical.Building.Interfaces.IInternalCondition

The internal condition to query for the thermostat parameter.

Returns

Thermostat
The Thermostat(this IInternalCondition) instance if it exists; otherwise, null.

Clone this wiki locally