Interface ConfigurationInterface

The ConfigurationInterface is a configuration.

The DMU may feature a list of configurations. A configuration is created by the project maintainer and made available to all users. In order to ease the possible dynamic creation of configurations in the future versions of the API, the ConfigurationInterface object shows the same attributes (some are still stripped) as the configuration object created by the project maintainer.

The configuration system is explained in the configurations.

A configuration elects always the root part instance. Then each child instance is included in the configuration if :

• it has no link documents attached to the parent/child relationship
• or the link document satisfies the requirements in the getNeededEffectivities AND does not satisfy the requirements in getExcludedEffectivities.

This algorithm is then recursively applied to all part instances to select a subset of all the part instances.

/** 
 * Sample to illustrate the change of configuration in the WorkingSetInterface.
 */
import { WorkingSetInterface, DataSessionInterface,	ConfigurationInterface, WorkingSetDataRetrieval, WorkingSetBehavior } from 'generated_files/documentation/appinfiniteapi';

// the DataSessionInterface has been created previously and is connected
let lDataSession : DataSessionInterface;
// create a WorkingSetInterface
// we want to get geometric instances result
// if nothing is set, this working set should include all parts ('unconfigured')
const lConfContext : WorkingSetInterface = lDataSession.createWorkingSet(
    WorkingSetDataRetrieval.R_OnlyGeometricInstances,
    WorkingSetBehavior.B_DiscardConfigurationsIfEmptyBit | WorkingSetBehavior.B_DiscardFiltersIfEmptyBit | WorkingSetBehavior.B_DiscardDependenciesIfEmptyBit
);
// retrieve the list of available configurations
const lActiveConfigurations : Array<ConfigurationInterface> = lDataSession.getConfigurationList();
// we will take the first ConfigurationInterface for this context
const lActualConfigurations : Array<string> = new Array<string>(1);
lActualConfigurations[0] = lActiveConfigurations[0].getConfigurationId();
console.log('Using the configuration ' + lActiveConfigurations[0].getName() + ' : ' + lActiveConfigurations[0].getDescription());
// set the active configurations
lConfContext.setActiveConfs(lActualConfigurations);
// and ask to compute all changes requested since the last call to the DataSessionInterface
lDataSession.update();

Copy

Please refer to the Configuration System.