Addons
Classes
- class keysight.ads.de.app.Addon
Used to extend the functionality of ADS by adding code that is loaded at startup.
- __init__(name: str, path: str, enabled: bool = True, location: AddonLocale = AddonLocale.USER) None
- property enabled: bool
- property location: AddonLocale
Specifies the location of the xml configuration file that references this Addon.
- module_name() str
Return the full name of the Python module for this Addon.
Will raise an exception if this Addon does not have a Python module.
- property name: str
- property raw_startup_file: str
The startup file for this Addon - possibly including environment variables.
- property root_directory: str
The directory containing the startup file.
- property startup_file: str
The startup file for this Addon.
- property sync_location: str
Enumerated Types
- class keysight.ads.de.app.AddonLocale
Bases:
EnumSpecifies the location of the xml configuration file.
- MEMORY = <AddonLocale.MEMORY: 0>
The Addon is not stored in any file.
- USER = <AddonLocale.USER: 1>
The Addon location in the HOME directory for Addon’s installed by the user.
- SITE = <AddonLocale.SITE: 2>
The Addon location for custom Addon’s installed at the user’s site.
- INSTALLATION = <AddonLocale.INSTALLATION: 3>
The Addon location in the product directory for Addon’s installed by ADS.
Functions
- keysight.ads.de.app.add_memory_addon(addon: Addon) None
Add addon to the set of memory Addons (load if enabled).
- keysight.ads.de.app.add_user_addon(addon: Addon) None
Add addon to the list of user Addons (load if enabled).
- keysight.ads.de.app.addon(addon_name: str) Addon
Search all the locations for an Addon with the given name.
Raises an exception if no enabled Addon was found.
- keysight.ads.de.app.enable_addon(addon: Addon, enable: bool) Addon
Enable or disable the addon.
If this is overriding the state of an installation or site addon, this will return a different Addon (either a new override or the original whose override we just removed).
- keysight.ads.de.app.find_addon(addon_name: str) Addon | None
Search all the locations for an Addon with the given name.
Returns None if no Addon was found.
- keysight.ads.de.app.get_addon_module(addon_name: str) module
get_addon_module is deprecated, and will be removed in the 2025 Update 2 release. Use: import_addon_as_module
- keysight.ads.de.app.import_addon_as_module(addon_name: str) module
Import the Python module for an ADS Addon.