DB.Api.Adjacency Class Reference

Class to handle zone surface adjacencies. A zone surface is composed of one or a number of adjacencies where each adjacency is an area of the surface which is either adjacent to another zone or the exterior of the building. More...

Public Member Functions
string	GetAttribute (string name)
	Returns string value associated with specified attribute.
bool	CreateNcmOpenings (double cillHeight, double windowHeight, double glazingPct, double gridSpacingX, double gridSpacingY, bool isReferenceBuilding, bool isRoofSurface)
	Creates adjacency openings for NCM calculations.
void	Dispose ()

Properties
Collections.Openings	Openings [get]
	Instantiates a collection of openings (windows, doors, etc) that lie within the perimeter of an adjacency.
Collections.Polygons	PolygonsIncludingFrames [get]
	Instantiates a collection of adjacency polygons including openings and processes the polygon set using the required conventions for on-processing by Energy Plus. Polygon set includes any user-specified window frames.
Collections.Polygons	PolygonsExcludingFrames [get]
	Instantiates a collection of adjacency polygons including openings and processes the polygon set using the required conventions for on-processing by Energy Plus. Polygon set excludes any user-specified window frames.
Collections.Polygons	SimplePolygons [get]
	Instantiates a collection of raw (unprocessed) adjacency polygons including openings.
double	Area [get]
	Returns adjacency area without accounting for inner volume.
double	GrossArea [get]
	Returns adjacency area accounting for inner volume where appropriate (using geometry calculation method).
double	NettArea [get]
	Returns adajcency area less the area occupied by openings (windows,doors, etc.) accounting for inner volume where appropriate (using geometry calculation method).
int	ZoneHandle [get]
	Returns the handle of the adjacent zone. If the adjacent zone handle is -1 (i.e. the method returns -1), this indicates that the adjacency is to the exterior of the building rather than another internal building zone.
bool	IsExternal [get]
	Returns TRUE if adjacent to the outside of the building and FALSE if adjacent to internal zone.
int	SurfaceIndex [get]
	Returns the index of the adjacent zone surface.
int	ConstructionId [get]
	Returns the ID of the "Constructions" table entry for the construction of the parent surface.
AdjacencyCondition	AdjacencyCondition [get]
	Returns the ennumerated type indicating the type of adjacency (not adjacent to ground, adjacent to ground, partially adjacent to ground, adiabatic, adjacent to specified condition).
double	ExposedWallGroundFloorLength [get]
	Returns the length of wall-ground floor edges exposed to the air.

Detailed Description

Class to handle zone surface adjacencies. A zone surface is composed of one or a number of adjacencies where each adjacency is an area of the surface which is either adjacent to another zone or the exterior of the building.

Member Function Documentation

CreateNcmOpenings()

bool DB.Api.Adjacency.CreateNcmOpenings	(	double	cillHeight,
		double	windowHeight,
		double	glazingPct,
		double	gridSpacingX,
		double	gridSpacingY,
		bool	isReferenceBuilding,
		bool	isRoofSurface
	)

Creates adjacency openings for NCM calculations.

Parameters

cillHeight	Height of cill from base of adjacency.
windowHeight	Height of window.
glazingPct	Percentage of adjacency occupied by glazing.
gridSpacingX	Not used.
gridSpacingY	Not used.
isReferenceBuilding	If TRUE method generates generic type windows otherwise wall type windows.
isRoofSurface	If TRUE method generates generic type windows otherwise wall type windows.

Returns

TRUE if openings created successfully otherwise FALSE.

GetAttribute()

string DB.Api.Adjacency.GetAttribute

(

string

name

)

Returns string value associated with specified attribute.

Parameters

name	Attribute name.

Returns

Value of attribute as string.

---

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

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