Enumeration WorkingSetInterfaceSignal

The WorkingSetInterfaceSignal lists all the signals that may be sent by the WorkingSetInterface.

These signals are emitted by the WorkingSetInterface when it is modified and more importantly ready.

A WorkingSetInterface is ready when it has computed the result of its set of FilterItemInterfaces, configurations and dependency list, such a result being a list of geometric instance ids and part instance ids.

The WorkingSetInterface may fire the following signals :

• WorkingSetReady : the WorkingSetInterface result can be retrieved.
• WorkingSetCancelled : the WorkingSetInterface computation has been cancelled (usually after a DataSessionInterface.cancelUpdate).
• WorkingSetChanged : any FilterItemInterface inside the WorkingSetInterface has changed, a FilterItemInterface has been added or removed, the dependencies inside the WorkingSetInterface have changed, or the list of configurations has changed.
• WorkingSetFilterAdded : a FilterItemInterface has been added in the WorkingSetInterface.
• WorkingSetFilterRemoved : a FilterItemInterface has been removed from the WorkingSetInterface.
• WorkingSetFilterMoved : a FilterItemInterface has been moved inside the WorkingSetInterface.
• WorkingSetDependencyAdded : a new dependency has been added inside the WorkingSetInterface.
• WorkingSetDependencyRemoved : a dependency has been removed from the WorkingSetInterface.
• WorkingSetDependencyMoved : a dependency has been moved inside from the WorkingSetInterface.
• WorkingSetDependencyOperatorChanged : a dependency has changed its operator inside from the WorkingSetInterface.
• WorkingSetConfChanged : the list of configurations inside the WorkingSetInterface has changed. WorkingSetParentChanged
• WorkingSetFilterBulkChanged : multiple changes have been done at once inside the filters of the WorkingSetInterface.
• WorkingSetIdChanged : the WorkingSetInterface has changed its id.

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

// the DataSessionInterface has been created previously and is connected
let lDataSession : DataSessionInterface;

// the callback called when the conf context has changed
let myCallback : tListenerCallback;
// create a configuration Context
// we want to get geometric instances result
// if nothing is set, this working set should include all parts ('unconfigured')
const lConfContextInterface : WorkingSetInterface = lDataSession.createWorkingSet(
    WorkingSetDataRetrieval.R_OnlyGeometricInstances,
    WorkingSetBehavior.B_DiscardConfigurationsIfEmptyBit | WorkingSetBehavior.B_DiscardFiltersIfEmptyBit | WorkingSetBehavior.B_DiscardDependenciesIfEmptyBit
);

// gets all the configuration ids
const lConfigurations: Array<ConfigurationInterface> = lDataSession.getConfigurationList();

// add all the configurations in the conf context 
const lActiveConfigurations = new Array<string>(0);
let i : number;
for (i = 0; i < lConfigurations.length; i += 1)
{
    lActiveConfigurations.push(lConfigurations[i].getConfigurationId());
}
// we want to be signaled when the confContext changes
lConfContextInterface.addEventListener(WorkingSetInterfaceSignal.WorkingSetConfChanged, myCallback);
// and set the configurations
lConfContextInterface.setActiveConfs(lActiveConfigurations);
// myCallback is called right away

Copy

Please refer to the WorkingSetInterface for more information.

See

• WorkingSetInterface
• FilterItemInterface