Skip to content

Latest commit

 

History

History
170 lines (124 loc) · 3.83 KB

element.rst.txt

File metadata and controls

170 lines (124 loc) · 3.83 KB

Element Wrappers

Element

rpw.db.element

rpw.db.Element

Instance

rpw.db.Instance

Symbol

rpw.db.Symbol

Family

rpw.db.Family

Category

rpw.db.Category


Walls

Wall Element Tree Wrappers

Note

These classes inherit from the classes listed above, but make some adjustments to compensate for disimilarties in in Wall Families.

When retrieving the FamilySymbol from an instance, and the Family from a Symbol, one might uses instance.Symbol and symbol.Family.

Unfortunately, this would not be the case with Wall Elements. A Wall Instance is actually a DB.Wall; the Family Type of a wall is not a DB.FamilySymbol type, but a DB.WallType; and instead of .Family, walls use .Kind.

These wrappers create a more consistent navigation by allowing to retrieve the "symbol" and "family" of a wall using: wall.symbol, and wall.family

>>> wall = rpw.db.WallInstance(SomeWallInstance) >>> wall.symbol < RPW_WallType: Wall 1> >>> wall.family < RPW_WallKind: Basic Wall>

rpw.db.WallInstance

rpw.db.WallSymbol

rpw.db.WallFamily

rpw.db.WallCategory


Spatial Elements

Room Wrapper

rpw.db.Room

Area Wrapper

rpw.db.Area

Area Scheme Wrapper

rpw.db.AreaScheme


Parameter and Parameter Set

ParameterSet

Note

These are used internally by all Classes that inherit from rpw.db.element, but can be used on their own.

rpw.db.ParameterSet

Parameter

rpw.db.Parameter


Implementation

../rpw/db/element.py

../rpw/db/parameter.py

../rpw/db/wall.py

../rpw/db/spatial_element.py