VEProject

class iesve.VEProject

Bases: object

static get_current_project() → VEProject

Returns the project currently loaded in the VE

air_exchanges() → list[AirExchange]

Returns a list of all defined air exchanges as AirExchange objects.

apache_systems() → list[VEApacheSystem]

Returns a list of all defined Apache Systems as VEApacheSystem objects

archive_project(dest: str, full: bool) → bool

Archive the current project. Destination parameter (string) gives path + filename of the resulting Zip file archive. Pass True for full to include result files, False to exclude these large files.

casual_gains() → list[CasualGain]

Returns a list of all defined casual gains as CasualGain objects.

construction_templates(assigned: bool = True) → dict[int, VEConstructionTemplate]

Returns a dictionary of VEConstructionTemplate objects, keyed by template handle. Pass assigned = False to return all, or True (default) to only get the templates in use

create_air_exchange(type: AirExchange_type) → AirExchange

Creates AirExchange object, adds to template database and returns the object to be modified.

create_apache_system(from_id: str = '', system_name: str = '') → VEApacheSystem

Creates a new Apache system to the project, returns corresponding VEApacheSystem object

Parameters:

• from_id (str, Optional) – Creates a copy of the system using the provided ID. Defaults to “”.

• system_name (str, Optional) – Name for system. Defaults to “”.

Returns:

new apache system object

Return type:

VEApacheSystem

create_casual_gain(type: CasualGain_type) → CasualGain

Creates CasualGain object. Adds to template database and returns the object to be modified.

create_construction_template(template_name: str) → VEConstructionTemplate

Creates a VEConstructionTemplate with given name, returning the newly created construction template object. Note if the given name is already taken a number will be appended

create_profile(type: str, reference: str = '', modulating: bool = True, units: ProfileUnits = ProfileUnits.none) → VEProfile

Creates a new (empty / default) profile of the specified type.

Parameters:

• type (str) – one of the following values: ‘daily’, ‘weekly’, ‘yearly’, ‘compact’, ‘freeform’

• reference (str, Optional) – name for profile. Defaults to “”.

• modulating (bool, Optional) – True for a modulating profile, False otherwise. Defaults to True.

• units (ProfileUnits, Optional) – 0 for metric, 1 for IP or -1 for none. Defaults to ProfileUnits.none.

Returns:

newly created profile of specified type

Return type:

VEProfile

create_thermal_template(template_name: str) → VEThermalTemplate

Creates a VEThermalTemplate with given name, returning the newly created thermal template object. Note if the given name is already taken a number will be appended.

daily_profile(profile_id: str) → DailyProfile

Takes a profile ID string, and returns the corresponding daily profile as DailyProfile object, or None if ID was invalid.

daily_profiles(profile_ids: list[str]) → dict[str, DailyProfile]

Takes a list of profile ID strings and returns a dictionary of corresponding DailyProfile objects, keyed by profile ID.

deregister_content(content_path: str) → None

Remove a file from Content Manager. No effect if the file does not exist in the Content Manager database.

get_display_unit_system() → DisplayUnits

Get the current VE unit display settings.

get_language_code() → tuple[str, str]

Get the language code of the system the VE is being run on.

get_macro_flo_opening_by_id(opening_id: str) → VEMacroFlo

Takes an opening ID and returns the corresponding Macroflo opening type

get_macro_flo_opening_types() → list[VEMacroFlo]

Returns a list of all defined Macroflo opening types

get_scenario_base_project_path() → str

If a scenario is currently active, returns the project path for the parent (non-scenario) model.

get_version() → str

Returns the version of the VE in the form of major.minor.revision.yy. The major version will indicate the primary release cycle, the minor version which feature pack level. The revision number indicates hotfix number.

group_profile(profile_id: str) → GroupProfile

Takes a profile ID string, and returns the corresponding group profile as a VEProfile object.

group_profiles(profile_ids: list[str]) → dict[str, GroupProfile]

Takes a list of profile ID strings and returns a dictionary of corresponding VEProfile objects, keyed by profile ID

profiles() → tuple[dict[str, DailyProfile], dict[str, GroupProfile]]

Returns a tuple containing dictionaries of daily and group profiles. Each tuple entry is a dictionary of key=profile ID, value=VEProfile object

register_content(content_path: str, category: str, display_str: str, show_notification: bool) → None

Register a file with Content Manager using category and display strings. Pass True for notification to have a notification displayed, False to add silently.

save_profiles() → bool

If profiles have been altered using VEProfile set_data method, the result won’t be committed to the project until this method is called. The exception is saving a free form profile, which takes effect immediately and is irrevocable.

thermal_templates(assigned: bool = True, allow_ncm: bool = False) → dict[int, VEThermalTemplate]

Returns a dictionary of VEThermalTemplate objects, keyed by template handle. Pass assigned = False to return all, or True (default) to only get the templates in use. Pass allow_ncm = True to include NCM profiles, False (default) to allow all profile types.

content_folder: str

Project content folder path

models: list[VEModel]

List of VEModel objects for active model variants. The first entry is always the ‘real’ model.

name: str

Project name (title)

path: str

Project folder path