DB.Api.HvacSubLoop Class Reference

Class to handle detailed HVAC sub-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). Each HVAC loop comprises a demand side sub-loop (typically containing zone HVAC equipment such as radiators, air distrubution units, etc.) and a supply sub-loop that incorporates the equipment required to supply the deamnd side (e.g. boilers, chillers, etc.). 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	DeleteComponent (int handle)
	Used to delete a component from the sub-loop using the supplied component handle.
void	DeleteDisconnectedComponents ()
	Used to delete all disconnected components from sub-loop.
void	Dispose ()

Properties
Collections.HvacComponents	Components [get]
	Returns a collection of sub-loop HVAC components.
HvacComponent	SelectedComponent [get]
	Returns the currently selected HVAC component as an HvacComponent (refer to HvacComponent class).
HvacLoop	ParentLoop [get]
	Returns the HVAC loop component to which the current sub-loop belongs (refer to HvacLoop class).
HvacLoopType	LoopType [get]
	Returns the type of loop to which the current sub-loop belongs (refer to HvacLoopType class).

Detailed Description

Class to handle detailed HVAC sub-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). Each HVAC loop comprises a demand side sub-loop (typically containing zone HVAC equipment such as radiators, air distrubution units, etc.) and a supply sub-loop that incorporates the equipment required to supply the deamnd side (e.g. boilers, chillers, etc.).

Member Function Documentation

DeleteComponent()

bool DB.Api.HvacSubLoop.DeleteComponent

(

int

handle

)

Used to delete a component from the sub-loop using the supplied component handle.

Parameters

handle

Handle of component to be deleted.

Returns

TRUE if component deleted successfully otherwise FALSE.

GetAttribute()

string DB.Api.HvacSubLoop.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.HvacSubLoop.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.HvacSubLoop.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.

SetAttribute()

void DB.Api.HvacSubLoop.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.

---

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

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