Class to handle a DB model building block object. The building block object is the main geometric component of a DB model and together with other building blocks forms a model building object. A building block may be partitioned into a number of zones and may contain other model components including voids, component blocks, assembly instances, etc. More...

Public Member Functions
Table	AddTable (string tableName, int fieldCount)
	Adds an empty table with specified name and number of fields to the BuildingBlock object.

Table	GetTable (string tableName)
	Returns a BuildingBlock table with the supplied name as a Table object.

void	RemoveTable (string tableName)
	Removes an existing BuildingBlock table with specified name.

void	RemoveAllTables ()
	Removes all BuildingBlock tables.

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.

void	SetAttribute (string attributeName, string value)
	Sets an attribute with the supplied name to the supplied value.

bool	IsAttributeTrue (string attributeName)
	Returns boolean value (TRUE/FALSE) of the attribute with the supplied name.

void	UpdateGeometry ()
	Regenerates all zone inner surface gemoetries and default openings to account for changes in construction, etc. Only affects the zones contained within the current BuildingBlock object and any child zones of merged zones.

void	UpdateTileAttributes ()
	Regenerates all model graphical components that are affected by BuildingBlock attribute data (default openings, textures, etc.) Only affects the zones contained within the current BuildingBlock object and any child zones of merged zones.

void	UpdateTopology ()
	If the BuildingBlock type is changed (say from General to Roof), this method must be called to update the geometry of the BuildingBlock and associated elements (zones, partitions, etc.)

bool	SelectComponentBlock (int index)
	Selects a component block by index into the component block collection list.

bool	SelectZone (int index)
	Selects a BuildingBlock zone by index into the zone collection list.

void	CreateFlatRoofs ()
	Deprecated.

void	ResetDefaultOpenings ()
	Removes all custom openings from all zone surfaces and resets default openings for surfaces.

Zone	GetZoneFromPerimeter (IEnumerable< Point3d > perimeter)
	Returns a zone whose plan projection perimeter overlaps the supplied perimeter by at least 50%.

void	Dispose ()

Properties
Collections.AssemblyInstances	AssemblyInstances `[get]`
	Instantiates a collection of assembly instances from the Sketch SketchDPerimeterBlock object.

Collections.ComponentBlocks	ComponentBlocks `[get]`
	Instantiates a collection of component blocks from the Sketch SketchDPerimeterBlock object.

Collections.Zones	Zones `[get]`
	Instantiates a collection of zones from the Sketch SketchDPerimeterBlock object.

Collections.HardAttributes	HardAttributes `[get]`
	Instantiate a collection of 'hard' attributes from the Sketch SketchDPerimeterBlock object. Hard attributes are attributes set at a specific model decomposition level (building block level in this case) and don't inherit from level above.

double	Height `[get]`
	Returns the height of the BuildingBlock object.

double	ExternalWallThickness `[get]`
	Deprecated (returns zero)

int	Handle `[get]`
	Returns handle of BuildingBlock object.

bool	IsSelected `[get]`
	Determines whether or not the BuildingBlock has been selected.

bool	IsOpenManifold `[get]`
	Determines whether or not the geometry of the BuildingBlock is open manifold or not. Closed manifold block geometry consists of surfaces where each edge is shared with one and only one other surface edge. Open manifold BuildingBlock objects can only arise when importing geometry from external files (gbXML). While open manifold building blocks can be included in EnergyPlus simulations, they cannot be included in CFD simulations which require closed manifold geometries.

bool	HasConstructionLines `[get]`
	Deprecated (returns FALSE)

BuildingBlockType	Type `[get]`
	Returns the type of BuildingBlock object (PlanExtrusion, Roof, SlopingWalls, Dome, General)

Detailed Description

Class to handle a DB model building block object. The building block object is the main geometric component of a DB model and together with other building blocks forms a model building object. A building block may be partitioned into a number of zones and may contain other model components including voids, component blocks, assembly instances, etc.

Member Function Documentation

◆ AddTable()

Table DB.Api.BuildingBlock.AddTable	(	string	tableName,
		int	fieldCount
	)

Adds an empty table with specified name and number of fields to the BuildingBlock object.

Parameters

tableName	Name of table
fieldCount	Number of fields (columns) in table

Returns: TRUE if table added successfully otherwise FALSE

◆ GetAttribute()

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

◆ GetTable()

Table DB.Api.BuildingBlock.GetTable ( string tableName )

Returns a BuildingBlock table with the supplied name as a Table object.

Parameters

tableName Name of table to be retrieved

Returns: Building table as Table object

◆ GetZoneFromPerimeter()

Zone DB.Api.BuildingBlock.GetZoneFromPerimeter ( IEnumerable< Point3d > perimeter )

Returns a zone whose plan projection perimeter overlaps the supplied perimeter by at least 50%.

Parameters

perimeter Perimeter as a list of 3D points from which the zone is to be retrieved

Returns: TRUE if a zone is found within the BuildingBlock whose plan perimeter overlaps the supplied perimeter otherwise FALSE

◆ IsAttributeTrue()

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

◆ RemoveTable()

void DB.Api.BuildingBlock.RemoveTable ( string tableName )

Removes an existing BuildingBlock table with specified name.

Parameters

tableName Name of table to be removed

◆ SelectComponentBlock()

bool DB.Api.BuildingBlock.SelectComponentBlock ( int index )

Selects a component block by index into the component block collection list.

Parameters

index Index of component block to be selected

Returns: TRUE if a valid index is supplied otherwise FALSE

◆ SelectZone()

bool DB.Api.BuildingBlock.SelectZone ( int index )

Selects a BuildingBlock zone by index into the zone collection list.

Parameters

index Index of zone to be selected

Returns: TRUE if a valid index is supplied otherwise FALSE

◆ SetAttribute()

void DB.Api.BuildingBlock.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/BuildingBlock.cs

Public Member Functions

Properties

Detailed Description

Member Function Documentation

◆ AddTable()

◆ GetAttribute()

◆ GetAttributeAsDouble()

◆ GetAttributeAsInt()

◆ GetAttributeDataObject()

◆ GetIntegerAttribute()

◆ GetTable()

◆ GetZoneFromPerimeter()

◆ IsAttributeTrue()

◆ RemoveTable()

◆ SelectComponentBlock()

◆ SelectZone()

◆ SetAttribute()