4.6. bdgroup Package

4.6.1. bdgroup Package

__init__.py Initialization file for the bdgroup package.

bdgroup Resources for managing Buildes groups.

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.

groupdata

---

The groupdata module provides objects that can be used to group other objects. This is particularly useful when you want a hierarchy where there will otherwise be none.

4.6.2. groupdata Module

GroupData

Resources for Buildes groups.

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

class bdgroup.groupdata.GroupData

Bases: buildesdata.BuildesData

Holds data for identifying groups of objects in Buildes.

4.6.3. groupmanager Module

GroupManager

Manages grouping of objects in Buildes.

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

class bdgroup.groupmanager.Group(app)

Bases: buildesmanager.BuildesManager

Coordinates the grouping of Buildes objects

check_group(name)

Check if named group exists in the active level.

Parameter:name – Returns:Whether named group exists. Return type:Boolean

end_active_status(name=None)

End a group object’s active status.

Group objects are created one at a time so it is safe to assume that there is only one prior active object making success to be true. This routine should work without any messages. If however this call is by mistake or with a mispelled name, a message will be emitted.

Parameter:name (String) – Name of object with active status to end.

make_common_data(data)

Set common attributes for all group data objects.

Parameter:data –

make_data(level_name, name)

Creates a new object for grouping marks in a buildes tree

Parameters:

• level_name (String) – Name of the level where this group is attached
• level_number (Integer) – Number of the level where this group is attached
• name (String) – Designates name for the new group object

Returns:

Reference to the created mark group object

Return type:

GroupData

make_message(data=None)

Compile basic information about data.

Parameter:data –

make_shape(data)

Make shape for pyOCC

If there is at least one space in the level, then attempt to make the shape otherwise just compile information about the site.

Parameter:data (BuildsData) – Data object for making shape

summary_outlook(obj)

Summarized outlook message.

Parameter:obj (BuildesData) – Object for which to create summary message.

summary_parts(obj)

Summarized parts message.

Parameter:obj (BuildesData) – Object for which to create summary message.

update_lineage(level_name, group_object)

Update bound-parent information for objects in groupList.

Parameters:

• level_name (String) – Name of level where group object is found
• group_object ([String, GroupData]) – Mark group object and its old level_name