Class to handle surface openings (windows, doors, vents, holes and CFD surface boundary conditions). 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	UpdateTileAttributes ()
	In the case of partition openings, this method ensures that the corresponding opening in the adjacent surface is updated to be consistent with the opening for which this method is being called (e.g. if the free aperture of a window is set to say 50% at the left side of the window, the adjacent partition opening free aperture will be automatically set to be 50% at the right side of the window). The method also regenerates all model graphical components that are affected by Opening attribute data (e.g. local shading graphics, CFD+ refinement region graphics, etc.).

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

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

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

void	RemoveAllTables ()
	Removes all Opening tables.

bool	UpdateCfdBoundary ()
	Regnenerates a CFD boundary using updated attribute data (applies to CFD boundaries only).

void	Dispose ()

Properties
double	Area `[get]`
	Returns the area of the opening.

bool	IsDefaultOpening `[get]`
	Returns a boolean value indicating whether or not the opening is generated automatically using the various user supplied surface opening settings or has been drawn manually (this only applies to windows and doors).

bool	IsRectangular `[get]`
	Returns a boolean value indicating whether or not the opening is rectangular.

bool	IsOrthogonal `[get]`
	Returns a boolean value indicating whether or not a rectangular opening is aligned with the major model axes.

double	Tilt `[get]`
	Returns the tilt of an opening in degrees. Horizontal opening pointing upwards has 0 degrees tilt and a horizontal opening pointing downwards has 180 degrees tilt.

double	ShadingFraction `[get]`
	Returns the fraction of an opening in shade subsequent to shading calculations.

OpeningType	Type `[get]`
	Returns the type of opening in the form of an enumerayed OpeningType (Window, Door, etc.).

Polygon	Polygon `[get]`
	Returns the geometry of the opening in the form of a Polygon object (refer to Polygon class).

Opening	AdjacentOpening `[get]`
	This method will return the adjacent opening in the case of internal partition openings.

int	IndexInSurface `[get]`
	Returns the sequential index of the opening in the parent surface.

Adjacency	ParentAdjacency `[get]`
	Returns the surface adjacency (as an Adjacency object) within which the opening is located (refer to Adjacency class).

int	ConstructionId `[get]`
	Returns the ID of the construction associated with the opening. In the case of windows, the construction ID points to a record in the 'Glazing' table whereas for sub-surfaces and doors, the construction ID points to a record in the 'Constructions' table (refer to Table class).

double	Width `[get]`
	Returns the width of the opening in metres. In the case of polygonal openings, the maximum local X dimension is returned.

double	Height `[get]`
	Returns the height of the opening in metres. In the case of polygonal openings, the maximum local Y dimension is returned.

Detailed Description

Class to handle surface openings (windows, doors, vents, holes and CFD surface boundary conditions).

Member Function Documentation

◆ AddTable()

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

Adds an empty table with specified name and number of fields to the Opening 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.Opening.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.Opening.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.Opening.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.Opening.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.Opening.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.Opening.GetTable ( string tableName )

Returns an Opening table with the supplied name as a Table object.

Parameters

tableName Name of table to be retrieved

Returns: Building table as Table object

◆ IsAttributeTrue()

bool DB.Api.Opening.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.Opening.RemoveTable ( string tableName )

Removes an existing Opening table with specified name.

Parameters

tableName Name of table to be removed

◆ SetAttribute()

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

◆ UpdateCfdBoundary()

bool DB.Api.Opening.UpdateCfdBoundary ( )

Regnenerates a CFD boundary using updated attribute data (applies to CFD boundaries only).

Returns: TRUE if boundary update successfully otherwise FALSE

Property Documentation

◆ Height

double DB.Api.Opening.Height

get

Returns the height of the opening in metres. In the case of polygonal openings, the maximum local Y dimension is returned.

Returns: Height of opening in metres.

◆ Width

double DB.Api.Opening.Width

get

Returns the width of the opening in metres. In the case of polygonal openings, the maximum local X dimension is returned.

Returns: Width of opening in metres.

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

C:/DesignBuilder/Components Source/DB.Api/DB.Api/Opening.cs

Public Member Functions

Properties

Detailed Description

Member Function Documentation

◆ AddTable()

◆ GetAttribute()

◆ GetAttributeAsDouble()

◆ GetAttributeAsInt()

◆ GetAttributeDataObject()

◆ GetIntegerAttribute()

◆ GetTable()

◆ IsAttributeTrue()

◆ RemoveTable()

◆ SetAttribute()

◆ UpdateCfdBoundary()

Property Documentation

◆ Height

◆ Width