VEBody

class iesve.VEBody

Bases: object

Interface for a VE Body object.

Basic usage:

project = iesve.VEProject.get_current_project()
realmodel = project.models[0]
bodies = realmodel.get_bodies(False)
for body in bodies:
    area = body.get_areas()
    windowArea = area['ext_wall_glazed'] + area['int_wall_glazed']
    print('Body: {}.  Glazing area: {}.'.format(body.id, windowArea))

Notes on VE Body Objects

A model can consist of bodies of various types. The VEBody object has a type attribute to discover the object type of that particular space. Object types can be categorised as follows:

• 3D bodies: rooms, local or topographical shades, adjacent buildings

• 2D bodies: masterplanning surfaces, boundaries

• 1D bodies: annotations

Each body has a unique ID. The ID is unique only within the model that contains the room. In a variant model, the same room will have the same ID - this allows you to find the same room across models and compare them.

assign_construction(construction: VECdbConstruction, surface: VESurface) → None

Assign construction to surface. If the model has inner volumes and newly-assigned constructions have differing thicknesses to the previous ones, rebuild_adjacencies must be called on the VEModel.

assign_construction_to_opening(construction: VECdbConstruction, surface: VESurface, opening_id: str) → None

Assign construction to an opening with the specified id.

assign_opening_type_by_id(surface_index: int, macroflo_id: str, opening_id: str) → None

Assign macroflo opening type to opening.

deselect() → None

deselects this body. Perform operations on the selected body using the iesve.VEGeometry API..

get_areas() → dict

The following areas are returned (All areas are returned in m² units. Room volume is returned in m³):

• int_floor_area

• ext_floor_area

• int_floor_opening

• ext_floor_opening

• int_floor_glazed

• ext_floor_glazed

• int_ceiling_area

• ext_ceiling_area

• int_ceiling_opening

• ext_ceiling_opening

• int_ceiling_glazed

• ext_ceiling_glazed

• int_ceiling_door

• ext_ceiling_door

• int_wall_area

• ext_wall_area

• int_wall_opening

• ext_wall_opening

• int_wall_glazed

• ext_wall_glazed

• int_wall_door

• ext_wall_door

• volume

Note: space total floor / ceiling etc. area comprises both internal and external areas.

get_assigned_constructions() → list[tuple[str, str]]

Returns a list of tuples containing construction IDs assigned to this space. The second element in the tuple is currently unused.

get_assigned_profiles() → list[tuple[str, str]]

Returns a list of tuples containing profile IDs in use by this space. The second element in the tuple is currently unused.

get_index() → int

Get the index of the body

get_processes() → list[VEComponentProcess]

Returns a list of VEComponentProcess objects representing the component processes in the body.

get_properties() → dict

Returns a dictionary with the following properties:

• min_height

• max_height

• floor_height_above_ground

get_room_data(type: attribute_type = attribute_type.active_attributes) → VERoomData

Returns a VERoomData object for closer inspection of data assigned to this room. The returned data depends on the input type: the default type of ‘real_attributes’ gives the default data for the room, but NCM, PRM and Title 24 specific data can be requested (but only for their respective building variants).

get_surfaces() → list[VESurface]

Returns a list of VESurface objects that bound this space

is_3d_shade() → bool

Checks whether the body is a 3d shade. Returns True for a topographical or local shade but False for a vegetated shade.

select() → None

Selects this body. Perform operations on the selected body using the iesve.VEGeometry API.

bim_id: str

cad_object_id: str

hvac_methodology: hvac_methodology

(iesve.hvac_methodology) Body HVAC methodology

id: str

in_active_layer: bool

name: str

Body name. Modifiable

selected: bool

subtype: VEBody_subtype

type: VEBody_type