DB.Api.SimpleHvacComponent Class Reference

Class to handle simple HVAC components. Simple HVAC components as distinct from detailed HVAC components are not included within a network but are basic components to which attributes can be assigned in order to model HVAC components such as boilers, chillers and AHUs. More...

Public Member Functions
bool	SetAttribute (string attributeName, string value)
	Sets an attribute with the supplied name to the supplied value.
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.
int	GetIntegerAttribute (string attributeName)
	Returns the integer value of the attribute with the supplied name (same as GetAttributeAsInt). 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.
DataObject	GetAttributeDataObject (string attributeName)
	Returns a DataObject object associated with the attribute of the supplied name.
bool	IsAttributeTrue (string attributeName)
	Returns boolean value (TRUE/FALSE) of the attribute with the supplied name.
void	Dispose ()

Detailed Description

Class to handle simple HVAC components. Simple HVAC components as distinct from detailed HVAC components are not included within a network but are basic components to which attributes can be assigned in order to model HVAC components such as boilers, chillers and AHUs.

Member Function Documentation

GetAttribute()

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

GetAttributeDataObject()

DataObject DB.Api.SimpleHvacComponent.GetAttributeDataObject

(

string

attributeName

)

Returns a DataObject object associated with the attribute of the supplied name.

Parameters

attributeName

Name of attribute from which DataObject object is to be retrieved.

Returns

DataObject object.

GetIntegerAttribute()

int DB.Api.SimpleHvacComponent.GetIntegerAttribute

(

string

attributeName

)

Returns the integer value of the attribute with the supplied name (same as GetAttributeAsInt). 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.

IsAttributeTrue()

bool DB.Api.SimpleHvacComponent.IsAttributeTrue

(

string

attributeName

)

Returns boolean value (TRUE/FALSE) of the attribute with the supplied name.

Parameters

attributeName

Attribute name.

Returns

TRUE if boolean value of attribute is true otherwise FALSE.

SetAttribute()

bool DB.Api.SimpleHvacComponent.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/SimpleHvacComponent.cs