Interface ConfContextInterface

The ConfContextInterface interface is used to get the available part instances inside the "Configurations" of a DMU. It may be used to filter out a group of part instances depending on their presence in these "Configurations", or to display or hide them.

The ConfContextInterface interfaces are created through the createConfContext method, and there may be any number of different configurations inside the ConfContextInterface.

The list of available configurations is accessible through the getConfigurationList method.

/** 
 * Sample to illustrate the change of configuration in the ConfContextInterface.
 */
import { ConfContextInterface, DataSessionInterface,	ConfigurationInterface } from 'generated/documentation/appinfiniteapi';

// the DataSessionInterface has been created previously and is connected
let lDataSession : DataSessionInterface;
// create a ConfContextInterface
const lConfContext : ConfContextInterface = lDataSession.createConfContext();
// retrieve the list of available configurations
const lActiveConfs : Array<ConfigurationInterface> = lDataSession.getConfigurationList();
// we will take the first ConfigurationInterface for this context
const lConfs : Array<string> = new Array<string>(1);
lConfs[0] = lActiveConfs[0].getConfigurationId();
console.log('Using the configuration ' + lActiveConfs[0].getName() + ' : ' + lActiveConfs[0].getDescription())
// set the active confs
lConfContext.setActiveConfs(lConfs);
// and ask to compute all changes requested since the last call to the DataSessionInterface
lDataSession.update();

The user may include any number of [ConfigurationInterface](ConfigurationInterface.html) inside the ConfContextInterface (by their id), the resulting set will be the union of all the requested [ConfigurationInterface](ConfigurationInterface.html) : any `part instance` included in at least one [ConfigurationInterface](ConfigurationInterface.html) will be available through the resulting ConfContextInterface.

The ConfContextInterface has two major uses :

• if included in a VisibilityContextInterface, the objects used with the given VisibilityContextInterface will be limited to the union of the ConfigurationInterface inside the given ConfContextInterface. Any part instance not inside the chosen ConfigurationInterface will be filtered out.
• If used as is, it may be used to compute the visibility of the DMU.

For example, the following code hides all the part instances except the ones in the ConfContextInterface :

/** 
 * Sample to illustrate the retrieval of the `geometric instance ids` in the ConfContextInterface, applying 
 * a "visibility" to the InfiniteEngineInterface.
 */
import {
    ConfContextInterface, InfiniteEngineInterface, VisualStates, ConfContextInterfaceSignal,
    tListenerCallback, InfiniteEvent,
} from 'generated/documentation/appinfiniteapi';

// the ConfContextInterface should have been created previously
let lConfContext : ConfContextInterface;
// the InfiniteEngineInterface should have been created previously
let lInfiniteEngine : InfiniteEngineInterface;
// the callback called when the ConfContextInterface is ready
let lConfContextReady : tListenerCallback;

// getting notified when the ConfContextInterface is ready
lConfContext.addEventListener(ConfContextInterfaceSignal.ConfContextReady, lConfContextReady);

lConfContextReady = (_pEvent: InfiniteEvent, _pCallbackData: Object | undefined) : void =>
{
    // get the geometries of this ConfContextInterface
    const lGeometries: Uint32Array | undefined = lConfContext.getGeometricInstanceIds();
    // make sure we are not updating the content (isRunning() is true)
    if (lGeometries)
    {
        // hide all geometries and set them as invisible and not ghosted
        lInfiniteEngine.updateGeometricStateForAll(VisualStates.S_Hidden | VisualStates.S_Ghost, (VisualStates.S_Hidden | ~VisualStates.S_Ghost));
        // set all the geometries of the ConfContextInterface as visible.
        lInfiniteEngine.updateGeometricState(lGeometries, VisualStates.S_Hidden, ~VisualStates.S_Hidden);
    }
}

The list of signals the ConfContextInterface may trigger is available in the [ConfContextInterfaceSignal](../enums/ConfContextInterfaceSignal.html) enumeration.

The active configurations are set through the setActiveConfs method. Each time the setActiveConfs method is called, the ConfContextChanged signal is sent. The setActiveConfs does not trigger a computation on the infinite servers, the user has to call the update method to trigger a computation (after the ConfContextInterface has been changed). The result is not available right away, but the event ConfContextReady is triggered when the result of the ConfContextInterface is available.

Warning : Creating a ConfContextInterface by createConfContext will fire a ConfContextReady with all the part instances of the DMU, this is equivalent to calling :

/** 
 * Sample to illustrate the change of configuration in the ConfContextInterface.
 */
import { ConfContextInterface, DataSessionInterface,	ConfigurationInterface } from 'generated/documentation/appinfiniteapi';

// the DataSessionInterface has been created previously and is connected
let lDataSession : DataSessionInterface;
// create a ConfContextInterface
const lConfContext : ConfContextInterface = lDataSession.createConfContext();
// retrieve the list of available configurations
const lActiveConfs : Array<ConfigurationInterface> = lDataSession.getConfigurationList();
// we will take the first ConfigurationInterface for this context
const lConfs : Array<string> = new Array<string>(1);
lConfs[0] = lActiveConfs[0].getConfigurationId();
console.log('Using the configuration ' + lActiveConfs[0].getName() + ' : ' + lActiveConfs[0].getDescription())
// set the active confs
lConfContext.setActiveConfs(lConfs);
// and ask to compute all changes requested since the last call to the DataSessionInterface
lDataSession.update();

Or with async calls :

/** 
 * Sample to illustrate the asynchronous change of configuration in the ConfContextInterface.
 */
import { ConfContextInterface, DataSessionInterface, ConfigurationInterface, AsyncResultReason, AsyncUInt32ArrayResult } from 'generated/documentation/appinfiniteapi';

// the DataSessionInterface has been created previously and is connected
let lDataSession : DataSessionInterface;
// create a ConfContextInterface
const lConfContext : ConfContextInterface = lDataSession.createConfContext();
// retrieve the list of available configurations
const lActiveConfs : Array<ConfigurationInterface> = lDataSession.getConfigurationList();
// we will take the first ConfigurationInterface for this context
const lConfs : Array<string> = new Array<string>(1);
lConfs[0] = lActiveConfs[0].getConfigurationId();
console.log('Using the configuration ' + lActiveConfs[0].getName() + ' : ' + lActiveConfs[0].getDescription())

const getResult = async (): Promise<AsyncUInt32ArrayResult> => {
    // set the active confs
    lConfContext.setActiveConfs(lConfs);
    const lContent : AsyncUInt32ArrayResult = await lConfContext.asyncGetGeometricInstanceIds();
    console.assert(lContent.reason === AsyncResultReason.ARR_Success);
    console.assert(lContent.value !== undefined);
    return lContent;
}

getResult();

Warning : there may be cases when the [getGeometricInstanceIds](ConfContextInterface.html#getGeometricInstanceIds) is not available such as when the ConfContextInterface is updating, i.e. when [isRunning](ConfContextInterface.html#isRunning) returns true, or when the ConfContextInterface has been cancelled, i.e. when [isCancelled](ConfContextInterface.html#isCancelled) returns true.

A ConfContextInterface may be interrupted (cancelled) when the ConfContextInterface is running and cancelUpdate is called. In such cases, the ConfContextCancelled signal is fired, and shortly after, ConfContextReady signal is fired, but getGeometricInstanceIds will return undefined. Just call update and the computation of the ConfContextInterface will resume.

If you call multiple times setActiveConfs before receiving the ConfContextReady, only one ConfContextReady will be sent with the content of the last call to setActiveConfs.

See

• DataSessionInterface
• ConfContextInterfaceSignal