DB.Api.AssemblyInstance Class Reference

Class to handle model assembly 'instances'. An assembly is a collection of component blocks that form a re-usable model component. An assembly can be used to model building occupants, furnishings, staircases, etc. Once an assembly has been defined it can then be placed in the form of 'instances' within the model. 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)
double	GetAttributeAsDouble (string attributeName)
	Returns the double value of the attribute with the supplied name.
int	GetIntegerAttribute (string attributeName)
	Returns the integer value of the attribute with the supplied name (same as GetAttributeAsInt)
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 ()

Properties
string	AssemblyName [get]
	Returns name of assembly instance.
Collections.ComponentBlocks	ComponentBlocks [get]
	Instantiates a collection of component blocks from the parent Assembly object. The component block geometry is not transformed by the current assembly instance rotation, translation, etc.
Collections.Polygons	Polygons [get]
	Instantiates a collection of parent Assembly component polygons for on-processing by EnergyPlus. The geometry of the polygon set is transformed by the current assembly instance rotation, translation, etc. and then processed using the conventions required by EnergyPlus.
Collections.Polygons	PolygonsTriangulated [get]
	Instantiates a collection of triangulated parent Assembly component polygons for on-processing by EnergyPlus. The geometry of the polygon set is transformed by the current assembly instance rotation, translation, etc. triangulated and then processed using the conventions required by EnergyPlus.

Detailed Description

Class to handle model assembly 'instances'. An assembly is a collection of component blocks that form a re-usable model component. An assembly can be used to model building occupants, furnishings, staircases, etc. Once an assembly has been defined it can then be placed in the form of 'instances' within the model.

Member Function Documentation

GetAttribute()

string DB.Api.AssemblyInstance.GetAttribute

(

string

attributeName

)

Returns the string value of the attribute with the supplied name.

Parameters

attributeName

Attribute name

Returns

Value of attribute as string

GetAttributeAsDouble()

double DB.Api.AssemblyInstance.GetAttributeAsDouble

(

string

attributeName

)

Returns the double value of the attribute with the supplied name.

Parameters

attributeName

Name of attribute from which double value is to be retrieved

Returns

Double value of attribute

GetAttributeAsInt()

int DB.Api.AssemblyInstance.GetAttributeAsInt

(

string

attributeName

)

Returns the integer value of the attribute with the supplied name (same as GetIntegerAttribute)

Parameters

attributeName

Name of attribute from which integer value is to be retrieved

Returns

Integer value of attribute

GetAttributeDataObject()

DataObject DB.Api.AssemblyInstance.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.AssemblyInstance.GetIntegerAttribute

(

string

attributeName

)

Returns the integer value of the attribute with the supplied name (same as GetAttributeAsInt)

Parameters

attributeName

Name of attribute from which integer value is to be retrieved

Returns

Integer value of attribute

IsAttributeTrue()

bool DB.Api.AssemblyInstance.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

---

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

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