DB.Api.HvacLoop Class Reference

Class to handle detailed HVAC loops. Loops are a basic element of EnergyPlus HVAC systems. Components are linked together to form various loops within the simulation. Thus, the output node from one component also serves as the inlet node to the next component and so on. There are four basic loop types: air loops, plant lops, condenser loops and VRF loops (refer to the HvacLoopType class). More...

Public Member Functions
string	GetAttribute (string attributeName)
	Returns the string value of the attribute with the supplied name.
int	GetAttributeAsInt (string attributeName)
	Returns the integer value of the attribute with the supplied name (same as GetIntegerAttribute). If the value of the attribute is not an integer value, the return value is undefined. To use this method, foreknowledge is required that the value of the attribute is in fact an integer value.
double	GetAttributeAsDouble (string attributeName)
	Returns the double value of the attribute with the supplied name. If the value of the attribute is not a double value, the return value is undefined. To use this method, foreknowledge is required that the value of the attribute is in fact an double value.
void	SetAttribute (string attributeName, string value)
	Sets an attribute with the supplied name to the supplied value.
bool	IsAttributeEditable (string attributeName)
	Returns a boolean value indicating whether or not a specific loop attribute is able to be edited.
void	UpdateAttributeData ()
	Used to ensure that all associated HVAC network data is synchronised with changes made to the current loop attributes. This method should be called after setting loop attribute data.
bool	AutoConnectLoop (int handle)
	Automatically connects the current loop to the component with the supplied handle.
void	SetNumberOfOperationSchemes (int n)
	Used to set the number of operation schemes for the loop.
IEnumerable< string >	GetOperationSchemeEquipment (int schemeIdx, int rangeIdx)
	Returns a string list where each string contains the name of an item of equipment for the specified scheme index and scheme range index. If a value of -1 is entered for the range, the equipment list is returned for the scheme.
bool	SetOperationSchemeEquipment (int schemeIdx, int rangeIdx, IEnumerable< string > equipmentList)
	Used to set the equipment list for a loop operating scheme range. The scheme is specified by the supplied scheme index and the range by the supplied range index. If a value of -1 is entered for the range, the equipment list will be set for the scheme.
void	Dispose ()

Properties
Collections.HvacOperationSchemes	OperationSchemes [get]
	Returns a collection of loop operating schemes. Operation schemes provide a mechanism for controlling the operation of loops and which equipment is available under what conditions.
IEnumerable< string >	PlantOperationEquipment [get]
	Returns a list of strings where each string contains the name of an item of plant within the loop that a loop operation scheme can refer to.
HvacComponent	VfrAirConditioner [get]
	Returns a VRF air conditioning component for VRF loops. Note that this method only applies to VRF loops.
HvacSubLoop	DemandSubLoop [get]
	Returns the demand sub-loop of the current loop as an HvacSubLoop object.
HvacSubLoop	SupplySubLoop [get]
	Returns the supply sub-loop of the current loop as an HvacSubLoop object.
HvacLoopType	LoopType [get]
	Returns the loop type as an HvacLoopType object (refer to HvacLoopType class for available types).
HvacPlantLoopType	PlantLoopType [get]
	Returns current plant loop type as an HvacPlantLoopType object. Note that this method can only be used for loops that have a Plant loop type (refer to LoopType method).
HvacPlantLoopType	LoopTemperatureType [get]
	Deprecated. Use PlantLoopType.
bool	IsUnitarySystem [get]
	Returns a boolean value indicating whether or not the current loop incorporates a unitary air handling unit. Note that this method should only be called if the loop type is an Air loop type (refer to LoopType method).
bool	IsDualDuctAirLoop [get]
	Returns a boolean value indicating whether or not the current loop is a dual-duct air loop. Note that this method should only be called if the loop type is an Air loop type (refer to LoopType method).
int	Handle [get]
	Returns the handle of the current loop.

Detailed Description

Class to handle detailed HVAC loops. Loops are a basic element of EnergyPlus HVAC systems. Components are linked together to form various loops within the simulation. Thus, the output node from one component also serves as the inlet node to the next component and so on. There are four basic loop types: air loops, plant lops, condenser loops and VRF loops (refer to the HvacLoopType class).

Member Function Documentation

AutoConnectLoop()

bool DB.Api.HvacLoop.AutoConnectLoop

(

int

handle

)

Automatically connects the current loop to the component with the supplied handle.

Parameters

handle

Handle of object to be connected to loop.

Returns

TRUE if loop connected to object successfully otherwise FALSE

GetAttribute()

string DB.Api.HvacLoop.GetAttribute

(

string

attributeName

)

Returns the string value of the attribute with the supplied name.

Parameters

attributeName

Name of attribute from which value is to be retrieved.

Returns

TRUE if attribute is retrieved successfully otherwise FALSE.

GetAttributeAsDouble()

double DB.Api.HvacLoop.GetAttributeAsDouble

(

string

attributeName

)

Returns the double value of the attribute with the supplied name. If the value of the attribute is not a double value, the return value is undefined. To use this method, foreknowledge is required that the value of the attribute is in fact an double value.

Parameters

attributeName

Name of attribute from which double value is to be retrieved.

Returns

Double value of attribute.

GetAttributeAsInt()

int DB.Api.HvacLoop.GetAttributeAsInt

(

string

attributeName

)

Returns the integer value of the attribute with the supplied name (same as GetIntegerAttribute). If the value of the attribute is not an integer value, the return value is undefined. To use this method, foreknowledge is required that the value of the attribute is in fact an integer value.

Parameters

attributeName

Name of attribute from which integer value is to be retrieved.

Returns

Integer value of attribute.

GetOperationSchemeEquipment()

IEnumerable< string > DB.Api.HvacLoop.GetOperationSchemeEquipment	(	int	schemeIdx,
		int	rangeIdx
	)

Returns a string list where each string contains the name of an item of equipment for the specified scheme index and scheme range index. If a value of -1 is entered for the range, the equipment list is returned for the scheme.

Parameters

schemeIdx	Index of loop operating scheme.
rangeIdx	Index of loop operating scheme range.

Returns

Operation scheme equipment string list.

IsAttributeEditable()

bool DB.Api.HvacLoop.IsAttributeEditable

(

string

attributeName

)

Returns a boolean value indicating whether or not a specific loop attribute is able to be edited.

Parameters

attributeName

Name of attribute.

Returns

TRUE if the attribute is editable otherwise FALSE.

SetAttribute()

void DB.Api.HvacLoop.SetAttribute	(	string	attributeName,
		string	value
	)

Sets an attribute with the supplied name to the supplied value.

Parameters

attributeName	Name of attribute to be set.
value	Value to which attribute is to be set.

Returns

TRUE if attribute is set successfully otherwise FALSE.

SetNumberOfOperationSchemes()

void DB.Api.HvacLoop.SetNumberOfOperationSchemes

(

int

n

)

Used to set the number of operation schemes for the loop.

Parameters

n	Number of operation schemes.

SetOperationSchemeEquipment()

bool DB.Api.HvacLoop.SetOperationSchemeEquipment	(	int	schemeIdx,
		int	rangeIdx,
		IEnumerable< string >	equipmentList
	)

Used to set the equipment list for a loop operating scheme range. The scheme is specified by the supplied scheme index and the range by the supplied range index. If a value of -1 is entered for the range, the equipment list will be set for the scheme.

Parameters

schemeIdx	Index of loop operating scheme.
rangeIdx	Index of loop operating scheme range.
equipmentList	Operation scheme equipment string list.

Returns

TRUE if loop operating scheme equipment list successfully set otherwise FALSE.

---

The documentation for this class was generated from the following file:

• C:/DesignBuilder/Components Source/DB.Api/DB.Api/HvacLoop.cs