ProductInstanceConfigurationsManager#

class ansys.saf.product_configuration.manager.configurations_manager.ProductInstanceConfigurationsManager#

Manage the default and custom product instance configurations.

Overview#

load_configurations

Load the product instance configurations found in the specified directory.

list_versions

List all versions configured for the given product name.

list_configurations

List all available product instance configurations.

get_version_configuration

Get the product instance configuration for the specified product and version.

get_products

List all available products.

Import detail#

from ansys.saf.product_configuration.manager.configurations_manager import ProductInstanceConfigurationsManager

Method detail#

ProductInstanceConfigurationsManager.load_configurations(product_instance_configs_dir: pathlib.Path | None)#

Load the product instance configurations found in the specified directory.

ProductInstanceConfigurationsManager.list_versions(product_name: str) → list[str]#

List all versions configured for the given product name.

Parameters:
product_namestr

The name of the product.

ProductInstanceConfigurationsManager.list_configurations() → list[ansys.saf.product_configuration.interfaces.IProductInstanceConfiguration]#

List all available product instance configurations.

ProductInstanceConfigurationsManager.get_version_configuration(product_name: str, product_version: str | None = None) → tuple[str, ansys.saf.product_configuration.interfaces.IProductInstanceVersionConfiguration]#

Get the product instance configuration for the specified product and version.

Note: if product_version is None, returns the latest version configuration.

ProductInstanceConfigurationsManager.get_products() → list[str]#

List all available products.