DB.Api.ComponentBlock Class Reference

Class to handle model component blocks. Component blocks may be used to model various components such as occupants, furnishings, shading devices, etc. Component blocks are also used to compose model assemblies. 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	Update ()
	Assigns the component block type from the previously set 'ComponentBlockType' attribute and updates all associated model adjacencies where appropriate (e.g. ground component block adjacent to building block). NOTE - this method should always be called after setting the component 'ComponentBlockType' attribute.
bool	SelectSurface (int surfaceIndex)
	Selects the component block surface using the supplied index.
void	Dispose ()

Properties
Collections.ComponentBlockSurfaces	Surfaces [get]
	Instantiates a collection of component block surfaces.
Collections.Polygons	ShadingPolygons [get]
	Instantiates a collection of polygons from the component block surfaces which are to be used for external shading in EnergyPlus. Only component blocks at the building level can be used for this purpose. All polygons are automatically processed to comply with EnergyPlus constraints.
Collections.Polygons	ShadingPolygonsTriangulated [get]
	Instantiates a collection of triangulated polygons from the component block surfaces which are to be used for external shading in EnergyPlus. Only component blocks at the building level can be used for this purpose. All polygons are automatically processed to comply with EnergyPlus constraints.
bool	IsCfdFan [get]
	Returns TRUE if the component block is a CFD fan object otherwise FALSE.
bool	IsSelected [get]
	Returns TRUE if the component block has been selected otherwise FALSE.
int	ParentZoneHandle [get]
	Returns the handle of the zone object in which this component block is located. NOTE - this method only applies to component blocks located at the building block level and not to building level component blocks.
ComponentBlockType	Type [get]
	Returns the type of the component block (normal, ground, adiabatic, specified condition, solar collector, CFD ACRE breathing region)

Detailed Description

Class to handle model component blocks. Component blocks may be used to model various components such as occupants, furnishings, shading devices, etc. Component blocks are also used to compose model assemblies.

Member Function Documentation

GetAttribute()

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

SelectSurface()

bool DB.Api.ComponentBlock.SelectSurface

(

int

surfaceIndex

)

Selects the component block surface using the supplied index.

Parameters

surfaceIndex

Index of surface to be selected

Returns

TRUE if a valid index is supplied otherwise FALSE

SetAttribute()

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