DB.Api.HvacOperationRange Class Reference

Class to handle HVAC loop operating scheme ranges. Plant and condenser loop operating schemes are a mechanism for controlling the operation of the loop and for specifying which items of equipment are available under what conditions. More than one operation scheme may be defined for a loop to enable different items of equipment to be switched on/off under different operating conditions. Each operation scheme has the type of operation scheme, its identifying name, and the schedule that defines its availability. Each scheme also contains a number of ranges which allows only specific items from the scheme equipment list to operate within specific load ranges. 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	Dispose ()

Properties
IEnumerable< string >	Equipment [get, set]
	Sets or retrives a string list where each string contains the handle of an item of loop equipment to which the range applies.

Detailed Description

Class to handle HVAC loop operating scheme ranges. Plant and condenser loop operating schemes are a mechanism for controlling the operation of the loop and for specifying which items of equipment are available under what conditions. More than one operation scheme may be defined for a loop to enable different items of equipment to be switched on/off under different operating conditions. Each operation scheme has the type of operation scheme, its identifying name, and the schedule that defines its availability. Each scheme also contains a number of ranges which allows only specific items from the scheme equipment list to operate within specific load ranges.

Member Function Documentation

GetAttribute()

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