Interface EffectivitiesInterface

The EffectivitiesInterface is a list of requirements used for the configuration system.

The configuration system is explained in the configurations.

The EffectivitiesInterface is included in the ConfigurationInterface, and tells the requirements that must or must not be satisfied in order for a part instance to be included in a configuration.

Such a requirement is expressed as a EffectivityItemInterface that tells the attribute name and the accepted/rejected values that a document must feature in order to be accepted/rejected.

/** 
 * 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.

See

• EffectivityItemInterface
• ConfigurationInterface