Bexel Manager API Documentation
Bexel.Api.Building Class Reference

Represents a single building within a Bexel.Api.Project. More...

Inheritance diagram for Bexel.Api.Building:
Bexel.Api.ApiObject IEquatable

Public Member Functions

bool Equals (Building other)
 
override bool Equals (object obj)
 
override int GetHashCode ()
 

Static Public Member Functions

static bool operator== (Building left, Building right)
 
static bool operator!= (Building left, Building right)
 

Properties

override bool IsValid [get]
 
Project Project [get]
 Returns the project in which the building resides. More...
 
BuildingID ID [get]
 Returns a unique identifier for the building within a single project. More...
 
string Name [get]
 Returns the name of the building. More...
 
BuildingStoreys Storeys [get]
 Returns a collection of all storeys that are contained within the building. More...
 
BuildingElements Elements [get]
 Returns a collection of all elements that are contained within the building. More...
 
BuildingProperties Properties [get]
 Returns a collection of all properties that are contained within the building. More...
 
- Properties inherited from Bexel.Api.ApiObject
abstract bool IsValid [get]
 Indicates if the API object is valid or not. More...
 

Additional Inherited Members

- Protected Member Functions inherited from Bexel.Api.ApiObject
virtual void CheckValidity ()
 

Detailed Description

Represents a single building within a Bexel.Api.Project.

A building may contain Bexel.Api.Elements from multiple Bexel.Api.ElementSources.

Property Documentation

◆ Elements

BuildingElements Bexel.Api.Building.Elements
get

Returns a collection of all elements that are contained within the building.

◆ ID

BuildingID Bexel.Api.Building.ID
get

Returns a unique identifier for the building within a single project.

◆ Name

string Bexel.Api.Building.Name
get

Returns the name of the building.

◆ Project

Project Bexel.Api.Building.Project
get

Returns the project in which the building resides.

◆ Properties

BuildingProperties Bexel.Api.Building.Properties
get

Returns a collection of all properties that are contained within the building.

◆ Storeys

BuildingStoreys Bexel.Api.Building.Storeys
get

Returns a collection of all storeys that are contained within the building.