DB.Api.HvacComponent Class Reference

Class to handle detailed HVAC component. The detailed HVAC component class is used to model the various components available in EnergyPlus.
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 component attributes. This method should be called after setting component attribute data.
bool	IsAttributeEditable (string attributeName)
	Returns a boolean value indicating whether or not a specific component attribute is able to be edited.
bool	SetFanCoilUnitAirSupply (bool isOutdoorAirSupply)
	Deprecated.
bool	ShowCoilController ()
	Returns a boolean value indicating whether or not coil controller settings should be made available on a dialog for the current coil.
bool	AddAhuPreHeatCoil (HvacHeatingCoilType type)
	Deprecated.
void	Dispose ()

Properties
Collections.HvacSubComponents	SubComponents [get]
	Returns a collection of component sub-components (refer to HvacSubComponents class). Certain components in EnergyPlus are composite components, consisting of a number of 'sub-components' (e.g. fan-coil components composed of heating coil, cooling coil and fan sub-components).
IEnumerable< string >	Zones [get, set]
	Certain HVAC components (e.g. domestic hot water equipment) reference a number of zones served by the component. This method returns a list of strings where each string contains the integer handle of the zone served.
IEnumerable< string >	AvailableZones [get]
	Certain HVAC components can be associated with building zones but not all zones are available to be associated with the component (e.g. some zones may already be referenced by another component). This method returns a list of strings where each string contains the integer handle of an available zone.
HvacComponentType	ComponentType [get, set]
	Returns HVAC component type (refer to HvacComponentType class for various component types).
int	HeatingPriority [get, set]
	Used to set or retrieve the component heating priority. This only applies to zone components where the priority is used by EnergyPlus during simulation to determine the order in which heating components should be activated.
int	CoolingPriority [get, set]
	Used to set or retrieve the component cooling priority. This only applies to zone components where the priority is used by EnergyPlus during simulation to determine the order in which cooling components should be activated.
HvacSubLoop	ParentSubLoop [get]
	Used to obtain the sub-loop in which the component is located. This only applies to loop components as distinct from zone components. The sub-loop is retuned as an HvacSubLoop object.
HvacComponent	ParentComponent [get]
	Used to obtain the parent HVAC component. This method only applies to sub-components that belong to a composite component (e.g. heating coil in a fan-coil unit).
HvacComponent	SelectedSubComponent [get]
	Used to obtain the currently selected sub-component at sub-component level (e.g. heating coil within a fan-coil unit).
HvacLoop	ConnectingPlantLoop [get]
	Used to obtain the HVAC plant loop to which the component is connected. If the component is disconnected, the method will return null.
HvacLoop	ConnectingAirLoop [get]
	Used to obtain the HVAC air loop to which the component is connected. If the component is disconnected, the method will return null.
int	PlenumZoneHandle [get, set]
	Returns the handle of the zone represented by the plenum. If the current component is neither a supply plenum or a return plenum, the method will return -1.
bool	ContainsWaterHeatingCoil [get]
	Returns a boolean value which indicates if the current composite component incorporates a water heating coil or not.
bool	IsAhuPreTreatmentComponent [get]
	Returns a boolean value which indicates whether or not the component is a pre-treatment component within an air handling unit.
HvacLoopType	LoopType [get]
	Returns the loop type to which the component can be connected (see HvacLoopType class for available loop types).
int	Handle [get]
	Returns the handle of the component.
HvacFanType	AhuFanType [get]
	Returns the fan type of a air handling unit. If the component is not an air handling unit, the method returns -1.

Detailed Description

Class to handle detailed HVAC component. The detailed HVAC component class is used to model the various components available in EnergyPlus.

Member Function Documentation

AddAhuPreHeatCoil()

bool DB.Api.HvacComponent.AddAhuPreHeatCoil

(

HvacHeatingCoilType

type

)

Deprecated.

Parameters

type

Returns

GetAttribute()

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

IsAttributeEditable()

bool DB.Api.HvacComponent.IsAttributeEditable

(

string

attributeName

)

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

Parameters

attributeName

Name of attribute.

Returns

TRUE if the attribute is editable otherwise FALSE.

SetAttribute()

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

SetFanCoilUnitAirSupply()

bool DB.Api.HvacComponent.SetFanCoilUnitAirSupply

(

bool

isOutdoorAirSupply

)

Deprecated.

Parameters

isOutdoorAirSupply

Returns

ShowCoilController()

bool DB.Api.HvacComponent.ShowCoilController

(

)

Returns a boolean value indicating whether or not coil controller settings should be made available on a dialog for the current coil.

Returns

TRUE if the current component is a coil and has a controller.

---

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

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