6.1.42.1 Methods Defined Here
air_exchanges() -> list
Returns a list of all defined air exchanges as AirExchange objects.
Creates AirExchange object, adds to template database and returns the object to be modified.
apache_systems() -> list
Returns a list of all defined Apache Systems as VEApacheSystem objects.
archive_project(destination, full) -> 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
Returns a list of all defined casual gains as CasualGain objects.
construction_templates(assigned = True) -> dictionary
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.
Creates CasualGain object. Adds to template database and returns the object to be modified.
create_profile(type, reference, modulating, units) -> profile
Creates a new (empty / default) profile of the specified type.
Arguments:
|
modulating
|
(bool, optional [default = True]) True for a modulating profile, False otherwise
|
|
reference
|
(string, optional) name for profile
|
|
type
|
(string) one of the following values:
'daily', 'weekly', 'yearly', 'compact', 'freeform'
|
|
units
|
(int, optional [default = -1 (none)]) 0 for metric, 1 for IP or -1 for none
|
create_apache_system(from_id, system_name) -> VEApacheSystem
Creates a new Apache system to the project, returns corresponding VEApacheSystem object.
Arguments:
|
from_id
|
(string, optional) Creates a copy of the system using the provided ID
|
|
system_name
|
(string, optional) Name for system
|
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.
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(profileID) -> profile
Takes a profile ID string, and returns the corresponding daily profile as DailyProfile object, or None if ID was invalid.
daily_profiles([profileIDs]) -> dictionary
Takes a list of profile ID strings and returns a dictionary of corresponding DailyProfile objects, keyed by profile ID.
register_content(path, category, displayString, notification)
Register a file with Content Manager using category and display strings. Pass True for notification to have a notification displayed, False to add silently.
deregister_content(path)
Remove a file from Content Manager. No effect if the file does not exist in the Content Manager database.
get_display_units() -> 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(...)
get_macro_flo_opening_by_id(openingID) -> opening type
Takes an opening ID and returns the corresponding Macroflo opening type.
get_macro_flo_opening_types(...)
get_macro_flo_opening_types() -> [opening types]
Returns a list of all defined Macroflo opening types.
get_scenario_base_project_path() -> string
If a scenario is currently active, returns the project path for the parent (non-scenario) model.
get_version() -> string
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(profileID) -> profile
Takes a profile ID string, and returns the corresponding group profile as a VEProfile object.
group_profiles([profileIDs]) -> dictionary
Takes a list of profile ID strings and returns a dictionary of corresponding VEProfile objects, keyed by profile ID.
profiles() -> ({daily},{group})
Returns a tuple containing dictionaries of daily and group profiles.
Each tuple entry is a dictionary of key=profile ID, value=VEProfile object.
save_profiles() -> Bool
If profiles have been altered using VEProfile set_data method, the result won’t be commited 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 = True, allow_ncm = False) -> dictionary
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.
