IProductInstanceConfiguration#

class ansys.saf.product_configuration.interfaces.IProductInstanceConfiguration#

Bases: Protocol

Interface to configure a product instance.

All products managed by the product instance system (HPS or PIM) must implement this interface.

Overview#

get_version_configuration

Return the configuration of a product for a specific version.

product_name

This is the product name that is exposed by the product instance management system.

versions

The set of versions that are supported.

Import detail#

from ansys.saf.product_configuration.interfaces import IProductInstanceConfiguration

Property detail#

property IProductInstanceConfiguration.product_name: str#

This is the product name that is exposed by the product instance management system.

It should be consistent with the name used in the PIM light and HPS configurations.

property IProductInstanceConfiguration.versions: list[str]#

The set of versions that are supported.

The last version is the default if no version is specified when an instance is created.

Method detail#

IProductInstanceConfiguration.get_version_configuration(version: str) → IProductInstanceVersionConfiguration#

Return the configuration of a product for a specific version.