4.2. bdsite Package

4.2.1. bdsite Package

BDSite package

Provides objects that manage information about the site for Buildes program.

moduleauthor:Kene Meniru <Kene.Meniru@illom.org>

This is a description of what the following modules do. This information is important to understand the structure and relationship between the various parts of buildes.

• sitemanager
• sitedata
• setbackdata

---

The sitemanager module provides objects used in the buildes abd buildesapp modules to create the building site object.

4.2.2. sitemanager Module

Site

Provides objects to manage the creation of the site information in Buildes.

moduleauthor:Kene Meniru <Kene.Meniru@illom.org>

class bdsite.sitemanager.Site(app)

Bases: buildesmanager.BuildesManager

Coordinates the creation of site data.

is_default()

Check if provided site is the initial default site created.

Parameter:obj – Returns:True or False. Return type:Boolean

make_data(parent, name=None)

Make a new data object.

Parameters:

• parent (String) – Name of object that owns this data.
• name (String) – Name of data object.

Returns:

A new data object.

Return type:

SiteData

make_message(data=None)

Prepares template for providing summary messages about site in ui.

Parameter:data –

make_shape(data)

Make PythonOCC shape object for site data object.

Parameter:data –

summary_outlook(obj)

Summarized outlook message.

Parameter:obj (BuildesData) – Object for which to create summary message. Returns:Formatted text for predetermined cells in the spreadsheet Return type:SpreadSheet

summary_parts(obj)

Summarized parts message

Parameter:obj – Returns: Return type:

4.2.3. sitedata Module

SiteData

Makes it possible to manage site information for Buildes program.

moduleauthor:Kene Meniru <Kene.Meniru@illom.org>

class bdsite.sitedata.SiteData

Bases: buildesdata.BuildesData

Entity class that manages data about a building site.

addy1()

Get the first address line for project location.

Returns:Address line 1 for site location. Return type:String

addy2()

Get the second address line for project location.

Returns:Address line 2 for site location. Return type:String

city()

Get the city where site is located.

Returns:City name where site is located. Return type:String

country()

Get the country where site is located.

Returns:Country name where site is located. Return type:String

designer_email(name)

Get the email address for named designer

Parameter:name (String) – name of designer

designer_office(name)

Get the office information for named designer

Parameter:name (String) – name of designer

designer_phone(name)

Get the phone number for named designer

Parameter:name (String) – name of designer

designer_role(name)

Get the role of named designer

Parameter:name (String) – name of designer

get_north()

Get north direction

north

Get north direction

region()

Get the region/state/province where site is located.

Returns:Region/State/Province where site is located. Return type:String

set_north(value)

Set north direction

update_addy(data)

Update project site location information.

Parameter:data (List) – List of data for location of project.

update_designer(data)

Update designer’s information.

List is organized with: Name, phone, email, role, office, date. Role designates the part the applicable person played in the design process. Office is the business of the named person.

Parameter:data (List) – List of data for each designer.

4.2.4. setbackdata Module

Setback Object

Provides setback data objects for the site.

class bdsite.setbackdata.ArcSetbackData

Bases: bdsite.setbackdata.SetbackData

Provides objects to store information about the site setbacks.

class bdsite.setbackdata.LineSetbackData

Bases: bdsite.setbackdata.SetbackData

Provides objects to store information about the site setbacks.

class bdsite.setbackdata.SetbackData

Bases: buildesdata.BuildesData

Provides objects to store information about the site setbacks.