DB.Api.HvacZoneGroup Class Reference

Class to handle HVAC zone groups. A zone group is a DB construct that allows zones that contain similar configurations of HVAC components to be grouped together. While the number and types of items of equipment has to be the same for each constituent zone, the equipment can have different operating parameters (e.g. heating output, 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.
void	UpdateAttributeData ()
	Used to ensure that all associated HVAC network data is synchronised with changes made to the current HVAC zone group attributes. This method should be called after setting zone group attribute data.
void	Dispose ()

Properties
Collections.HvacZones	Zones [get]
	Returns a collection of HVAC zone group zones.
Collections.HvacHeatingCoolingUnits	HeatingCoolingUnits [get]
	Returns a collection of HVAC zone group heating and cooling units.
IEnumerable< string >	ZoneList [get, set]
	Returns a string list where each string contains the intger handle of a building zone.
IEnumerable< string >	AvailableZones [get]
	Returns a string list where each string contains the integer handle of an available building zone. A building zone is considered available if it is not being referenced by another zone group.
string	Name [get]
	Returns the name of the HVAC zone group.
int	Handle [get]
	Returns the handle of the HVAC zone group.
HvacZone	SelectedZone [get]
	Returns the currently selected HVAC zone in the zone group (refer to HvacZone class).

Detailed Description

Class to handle HVAC zone groups. A zone group is a DB construct that allows zones that contain similar configurations of HVAC components to be grouped together. While the number and types of items of equipment has to be the same for each constituent zone, the equipment can have different operating parameters (e.g. heating output, etc.).

Member Function Documentation

GetAttribute()

string DB.Api.HvacZoneGroup.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.HvacZoneGroup.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.HvacZoneGroup.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.HvacZoneGroup.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/HvacZoneGroup.cs