CATMecModUseItf Interface CATIMmiPartInfrastructurePreferencesAtt

Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.

interface CATIMmiPartInfrastructurePreferencesAtt

Interface to retrieve application preferences related to Part Infrastructure.
Role: This interface describes all the application preferences related to Part infrastructure. Preferences are not displayed in Tools/Options and are not administered. They are stored in .CATPreferences files.
Here under is an example on how to retrieve a pointer to this interface: 

 #include "CATInstantiateComponent.h" //System
 #include "CATIMmiPartInfrastructurePreferencesAtt.h"  //MecModInterfaces
 { 
  ...
  CATIMmiPartInfrastructurePreferencesAtt *pIPreferencesController=NULL;
  CATCallbackEvent event;
  if(SUCCEEDED(::CATInstantiateComponent("CATMmuPartInfrastructurePreferencesCtrl", 
               IID_CATIMmiPartInfrastructurePreferencesAtt,(void**)&pIPreferencesController)))
    {
     //insert your code here
     pIPreferencesController->Release(); pIPreferencesController=NULL;
    }
  ...
  }

Values are saved into the PartInfrastructure.CATPreferences file at the end of the application session.

Method Index


o GetDatumMode(CATIMmiPartInfrastructurePreferencesAtt::PreferenceMode&)
Retrieves the Datum mode.
o GetDatumModeEvent(CATCallbackEvent&)
Retrieves the name of the event class dispatched when a change of value is made.
o GetGridFilterMode(CATIMmiPartInfrastructurePreferencesAtt::PreferenceMode&)
Retrieves the "GridFilter" mode.
o GetGridFilterModeEvent(CATCallbackEvent&)
Retrieves the name of the event class dispatched when a change of value is made.
o GetHistoricalGraphDisplayState(CATBoolean&)
Retrieves the visibility of the "Historical graph" panel.
o GetHistoricalGraphDisplayStateEvent(CATCallbackEvent&)
Retrieves the name of the event class dispatched when a change of value is made.
o GetImportRepRepMode(CATBoolean&)
Retrieves the "ImportRepRep" mode.
o GetImportRepRepModeEvent(CATCallbackEvent&)
Retrieves the name of the event class dispatched when a change of value is made.
o GetInsertMode(CATIMmiPartInfrastructurePreferencesAtt::PreferenceMode&)
Retrieves the Insert mode.
o GetInsertModeEvent(CATCallbackEvent&)
Retrieves the name of the event class dispatched when a change of value is made.
o GetIntersectionC1EdgeMode(CATIMmiPartInfrastructurePreferencesAtt::PreferenceMode&)
Retrieves the "Intersection C1Edge" mode.
o GetIntersectionC1EdgeModeEvent(CATCallbackEvent&)
Retrieves the name of the event class dispatched when a change of value is made.
o GetIntersectionEdgeMode(CATIMmiPartInfrastructurePreferencesAtt::PreferenceMode&)
Retrieves the "Intersection Edge" mode.
o GetIntersectionEdgeModeEvent(CATCallbackEvent&)
Retrieves the name of the event class dispatched when a change of value is made.
o GetScanGraphPanelMode(CATBoolean&)
Retrieves the visibility of the "Scan graph" panel.
o GetScanGraphPanelModeEvent(CATCallbackEvent&)
Retrieves the name of the event class dispatched when a change of value is made.
o GetSketchAnalysisDisplayState(CATBoolean&)
Retrieves the visibility of the "Parametrization Analysis" panel.
o GetSketchAnalysisDisplayStateEvent(CATCallbackEvent&)
Retrieves the name of the event class dispatched when a change of value is made.
o GetSocietyIdentifier(CATUnicodeString&)
Retrieves the society identifier related to a caa partner's startup.
o GetSocietyIdentifierEvent(CATCallbackEvent&)
Retrieves the name of the event class dispatched when a change of value is made.
o GetUnderAxisSystemsNodeMode(CATBoolean&)
Retrieves the "Under axis system" mode.
o GetUnderAxisSystemsNodeModeEvent(CATCallbackEvent&)
Retrieves the name of the event class dispatched when a change of value is made.
o SendHistoricalGraphDisplayStateEvent()
Sends the "Historical graph" event.
o SendSketchAnalysisDisplayStateEvent()
Sends the "SketchAnalysisDisplay" event.
o SetDatumMode(CATIMmiPartInfrastructurePreferencesAtt::PreferenceMode,CATBoolean)
Sets the Datum mode.
o SetGridFilterMode(CATIMmiPartInfrastructurePreferencesAtt::PreferenceMode,CATBoolean)
Sets the "Grid Filter" mode.
o SetHistoricalGraphDisplayState(CATBoolean,CATBoolean)
Sets the "Historical graph" display state.
o SetImportRepRepMode(CATBoolean,CATBoolean)
Sets the "ImportRepRep" mode.
o SetInsertMode(CATIMmiPartInfrastructurePreferencesAtt::PreferenceMode,CATBoolean)
Sets the Insert mode.
o SetIntersectionC1EdgeMode(CATIMmiPartInfrastructurePreferencesAtt::PreferenceMode,CATBoolean)
Sets the "Intersection C1Edge" mode.
o SetIntersectionEdgeMode(CATIMmiPartInfrastructurePreferencesAtt::PreferenceMode,CATBoolean)
Sets the "Intersection Edge" mode.
o SetScanGraphPanelMode(CATBoolean,CATBoolean)
Sets the visibility of the "Scan graph" panel.
o SetSketchAnalysisDisplayState(CATBoolean,CATBoolean)
Sets the "SketchAnalysisDisplay" state.
o SetSocietyIdentifier(CATUnicodeString&,CATBoolean)
Sets the society identifier.
o SetUnderAxisSystemsNodeMode(CATBoolean,CATBoolean)
Sets the "Under axis system" mode.
o ValidateDatumMode(CATBoolean)
Sets the mode to NoMode if it is set to TemporaryMode.
o ValidateGridFilterMode(CATBoolean)
Sets the mode to NoMode if it is set to TemporaryMode.
o ValidateInsertMode(CATBoolean)
Sets the mode to NoMode if it is set to TemporaryMode.
o ValidateIntersectionC1EdgeMode(CATBoolean)
Sets the mode to NoMode if it is set to TemporaryMode.
o ValidateIntersectionEdgeMode(CATBoolean)
Sets the mode to NoMode if it is set to TemporaryMode.

Enumerated Type Index


o PreferenceMode
List of types for modes.

Methods


o GetDatumMode
public virtual GetDatumMode( oMode)
Retrieves the Datum mode.
Role: The datum mode determines if created components do not remain associative. This means that there are no links to the other entities that were used to create that component.
This mode is displayed and changeable through the "Create Datum" command (GSD/Part/FreeStyle/...).
Parameters:
oMode
The possible values are:
  • NoMode, when created components are procedural (or associative). This is the classic instantiation mode.
  • PermanentMode, for components to keep being created in a datum mode (i.e. non associative),
  • TemporaryMode, for a component to be created in a datum mode. A call to
will set the mode to NoMode.
Returns:
S_OK if the parameter is correctly retrieved, E_FAIL otherwise.
o GetDatumModeEvent
public virtual GetDatumModeEvent( oEvent)
Retrieves the name of the event class dispatched when a change of value is made.
Role: This method enables an application to be warned whenever a change of value occurs.
Refer to comments in for a code sample.
Parameters:
oEvent
The event class.
Returns:
S_OK if the parameter is correctly retrieved, E_FAIL otherwise.
o GetGridFilterMode
public virtual GetGridFilterMode( oMode)
Retrieves the "GridFilter" mode.
Role: This mode enables to select sub-elements from the grid (3D-support).
This mode is displayed and changeable through the "Work on Support" command located in the "User Selection Filter" toolbar.
Parameters:
oMode
The possible values are:
  • NoMode, when the mode is not active,
  • PermanentMode, when the mode is permanently active,
  • TemporaryMode, when the mode is temporarily active. A call to
will set the mode to NoMode.
Returns:
S_OK if the parameter is correctly retrieved, E_FAIL otherwise.
o GetGridFilterModeEvent
public virtual GetGridFilterModeEvent( oEvent)
Retrieves the name of the event class dispatched when a change of value is made.
Role: This method enables an application to be warned whenever a change of value occurs.
Refer to comments in for a code sample.
Parameters:
oEvent
The event class.
Returns:
S_OK if the parameter is correctly retrieved, E_FAIL otherwise.
o GetHistoricalGraphDisplayState
public virtual GetHistoricalGraphDisplayState( oOffOrOn)
Retrieves the visibility of the "Historical graph" panel.
Role: The Part Editor is a special viewer launched in GSD through Tools/Historical graph.
Parameters:
oOffOrOn
Current "Historical graph" panel visibility
  • TRUEif the viewer is visible,
  • FALSE if the viewer is invisible.
Returns:
S_OK if the parameter is correctly retrieved, E_FAIL otherwise.
o GetHistoricalGraphDisplayStateEvent
public virtual GetHistoricalGraphDisplayStateEvent( oEvent)
Retrieves the name of the event class dispatched when a change of value is made.
Role: This method enables an application to be warned whenever a change of value occurs.
Refer to comments in for a code sample.
Parameters:
oEvent
The event class.
Returns:
S_OK if the parameter is correctly retrieved, E_FAIL otherwise.
o GetImportRepRepMode
public virtual GetImportRepRepMode( oMode)
Retrieves the "ImportRepRep" mode.
Role: This mode enables to copy an element from a 3D Shape into an other one without using the ProductStructure context.
Parameters:
oMode
Current "ImportRepRep" mode
  • TRUE if the mode is active,
  • FALSE otherwise.
Returns:
S_OK if the parameter is correctly retrieved, E_FAIL otherwise.
o GetImportRepRepModeEvent
public virtual GetImportRepRepModeEvent( oEvent)
Retrieves the name of the event class dispatched when a change of value is made.
Role: This method enables an application to be warned whenever a change of value occurs.
Here is a coding sample for the use of this event:
  #include "CATInstantiateComponent.h" //System
  #include "CATIMmiPartInfrastructurePreferencesAtt.h" //MecModInterfaces
  { //Subscription
   CATIMmiPartInfrastructurePreferencesAtt *pIPreferencesCtrl=NULL;
   CATCallbackEvent eventName=""; //CATCallbackEvent = const char*
   if(SUCCEEDED(::CATInstantiateComponent("CATMmuPartInfrastructurePreferencesCtrl", 
                IID_CATIMmiPartInfrastructurePreferencesAtt,(void**)&pIPreferencesCtrl)))
    {
     if(SUCCEEDED(pIPreferencesCtrl->GetPreferenceNameEvent(eventName)))
         _callbackId=AddCallback(this, pIPreferencesCtrl, eventName,
                                 (CATSubscriberMethod)&MyClass::OnPreferenceChange,NULL);
 
     pIPreferencesCtrl->Release(); pIPreferencesCtrl=NULL;
    }
  }
  
  { //Unsubscription
  CATIMmiPartInfrastructurePreferencesAtt *pIPreferencesCtrl=NULL;
  if(_callbackId && 
     SUCCEEDED(::CATInstantiateComponent("CATMmuPartInfrastructurePreferencesCtrl", IID_CATIMmiPartInfrastructurePreferencesAtt, (void**)&pIPreferencesCtrl)))
    {
     RemoveCallback(this, pIPreferencesCtrl, _callback);
     pIPreferencesCtrl->Release(); pIPreferencesCtrl=NULL;
    }
  }
Parameters:
oEvent
The event class.
Returns:
S_OK if the parameter is correctly retrieved, E_FAIL otherwise.
o GetInsertMode
public virtual GetInsertMode( oMode)
Retrieves the Insert mode.
Role: The Insert mode determines if a created element will be inserted within the specification tree, at its logical positioning (mode on) and not its chronological positioning (mode off).
The logical position within the specification tree is next to its main parents.
This mode is displayed and changeable through the "Insert Mode" command (GSD/Part/FreeStyle/...).
Parameters:
oMode
The possible values are:
  • NoMode, when created components are inserted chronologically,
  • PermanentMode, when created components are inserted logically,
  • TemporaryMode, when created components are inserted logically. A call to
will set the mode to NoMode.
Returns:
S_OK if the parameter is correctly retrieved, E_FAIL otherwise.
o GetInsertModeEvent
public virtual GetInsertModeEvent( oEvent)
Retrieves the name of the event class dispatched when a change of value is made.
Role: This method enables an application to be warned whenever a change of value occurs.
Refer to comments in for a code sample.
Parameters:
oEvent
The event class.
Returns:
S_OK if the parameter is correctly retrieved, E_FAIL otherwise.
o GetIntersectionC1EdgeMode
public virtual GetIntersectionC1EdgeMode( oMode)
Retrieves the "Intersection C1Edge" mode.
Role: The role of this mode is extensively described in .
This mode is displayed and changeable through the dedicated command located in the "User Selection Filter" toolbar.
Parameters:
oMode
The possible values are:
  • NoMode, when the mode is not active,
  • PermanentMode, when the mode is permanently active,
  • TemporaryMode, when the mode is temporarily active. A call to
will set the mode to NoMode.
Returns:
S_OK if the parameter is correctly retrieved, E_FAIL otherwise.
o GetIntersectionC1EdgeModeEvent
public virtual GetIntersectionC1EdgeModeEvent( oEvent)
Retrieves the name of the event class dispatched when a change of value is made.
Role: This method enables an application to be warned whenever a change of value occurs.
Refer to comments in for a code sample.
Parameters:
oEvent
The event class.
Returns:
S_OK if the parameter is correctly retrieved, E_FAIL otherwise.
o GetIntersectionEdgeMode
public virtual GetIntersectionEdgeMode( oMode)
Retrieves the "Intersection Edge" mode.
Role: The role of this mode is extensively described in .
This mode is displayed and changeable through the dedicated command located in the "User Selection Filter" toolbar.
Parameters:
oMode
The possible values are:
  • NoMode, when the mode is not active,
  • PermanentMode, when the mode is permanently active,
  • TemporaryMode, when the mode is temporarily active. A call to
will set the mode to NoMode.
Returns:
S_OK if the parameter is correctly retrieved, E_FAIL otherwise.
o GetIntersectionEdgeModeEvent
public virtual GetIntersectionEdgeModeEvent( oEvent)
Retrieves the name of the event class dispatched when a change of value is made.
Role: This method enables an application to be warned whenever a change of value occurs.
Refer to comments in for a code sample.
Parameters:
oEvent
The event class.
Returns:
S_OK if the parameter is correctly retrieved, E_FAIL otherwise.
o GetScanGraphPanelMode
public virtual GetScanGraphPanelMode( oVisible)
Retrieves the visibility of the "Scan graph" panel.
Role: The Scan graph is a special viewer linked to the Scan command.
There is a possibility for the user to display or not this dedicated viewer in addition to the Scan command.
Parameters:
oVisible
Current "Scan graph" panel visibility
  • TRUEif the viewer is visible when launching the Scan command,
  • FALSE if the viewer is not visible.
Returns:
S_OK if the parameter is correctly retrieved, E_FAIL otherwise.
o GetScanGraphPanelModeEvent
public virtual GetScanGraphPanelModeEvent( oEvent)
Retrieves the name of the event class dispatched when a change of value is made.
Role: This method enables an application to be warned whenever a change of value occurs.
Refer to comments in for a code sample.
Parameters:
oEvent
The event class.
Returns:
S_OK if the parameter is correctly retrieved, E_FAIL otherwise.
o GetSketchAnalysisDisplayState
public virtual GetSketchAnalysisDisplayState( oOffOrOn)
Retrieves the visibility of the "Parametrization Analysis" panel.
Role: The Parametrization Analysis panel is launched in Part/GSD/... through the Tools/Parametrization Analysis command.
Parameters:
oOffOrOn
Current "Parametrization Analysis" panel visibility
  • TRUEif the viewer is visible,
  • FALSE if the viewer is invisible.
Returns:
S_OK if the parameter is correctly retrieved, E_FAIL otherwise.
o GetSketchAnalysisDisplayStateEvent
public virtual GetSketchAnalysisDisplayStateEvent( oEvent)
Retrieves the name of the event class dispatched when a change of value is made.
Role: This method enables an application to be warned whenever a change of value occurs.
Refer to comments in for a code sample.
Parameters:
oEvent
The event class.
Returns:
S_OK if the parameter is correctly retrieved, E_FAIL otherwise.
o GetSocietyIdentifier
public virtual GetSocietyIdentifier( oSocietyId)
Retrieves the society identifier related to a caa partner's startup.
Role: This preference is only to be used for UserFeatures type.
Parameters:
oSocietyId
The society identifier.
Returns:
S_OK if the parameter is correctly retrieved, E_FAIL otherwise.
o GetSocietyIdentifierEvent
public virtual GetSocietyIdentifierEvent( oEvent)
Retrieves the name of the event class dispatched when a change of value is made.
Role: This method enables an application to be warned whenever a change of value occurs.
Refer to comments in for a code sample.
Parameters:
oEvent
The event class.
Returns:
S_OK if the parameter is correctly retrieved, E_FAIL otherwise.
o GetUnderAxisSystemsNodeMode
public virtual GetUnderAxisSystemsNodeMode( oMode)
Retrieves the "Under axis system" mode.
Role: This mode determines whether the axis systems are to be created under the "Axis System" tree node or under the node of the current CATIGSMTool.
Parameters:
oMode
TRUE if axis systems are created under the "Axis System" tree node. FALSE if axis systems are created under the node of the current CATIGSMTool.
Returns:
S_OK if the parameter is correctly retrieved, E_FAIL otherwise.
o GetUnderAxisSystemsNodeModeEvent
public virtual GetUnderAxisSystemsNodeModeEvent( oEvent)
Retrieves the name of the event class dispatched when a change of value is made.
Role: This method enables an application to be warned whenever a change of value occurs.
Refer to comments in for a code sample.
Parameters:
oEvent
The event class.
Returns:
S_OK if the parameter is correctly retrieved, E_FAIL otherwise.
o SendHistoricalGraphDisplayStateEvent
public virtual SendHistoricalGraphDisplayStateEvent()
Sends the "Historical graph" event.
Role: Sends the event retrieved through ..
Returns:
Always S_OK.
o SendSketchAnalysisDisplayStateEvent
public virtual SendSketchAnalysisDisplayStateEvent()
Sends the "SketchAnalysisDisplay" event.
Role: Sends the event retrieved through .
Returns:
Always S_OK.
o SetDatumMode
public virtual SetDatumMode( iMode,
iSendEvent=TRUE)
Sets the Datum mode.
Parameters:
iMode
The possible values are NoMode, PermanentMode, and TemporaryMode.
If TemporaryMode mode is set, a call to
will set the mode to NoMode.
iSendEvent
  • TRUE so that the event defined in
is sent.
This happens only if the value is different from the one stored in the preference.
  • FALSE for no event to be sent.
    • Returns:
    S_OK if the parameter is correctly set, E_FAIL otherwise.
    o SetGridFilterMode
    public virtual SetGridFilterMode( iMode,
    iSendEvent=TRUE)
    Sets the "Grid Filter" mode.
    Parameters:
    iMode
    The possible values are NoMode, PermanentMode, and TemporaryMode.
    If TemporaryMode mode is set, a call to
    will set the mode to NoMode.
    iSendEvent
    • TRUE so that the event defined in
    is sent.
    This happens only if the value is different from the one stored in the preference.
  • FALSE for no event to be sent.
    • Returns:
    S_OK if the parameter is correctly set, E_FAIL otherwise.
    o SetHistoricalGraphDisplayState
    public virtual SetHistoricalGraphDisplayState( iOffOrOn,
    iSendEvent=TRUE)
    Sets the "Historical graph" display state.
    Parameters:
    iOffOrOn
    • FALSE to hide it,
    • TRUE to display it.
    iSendEvent
    • TRUE so that the event defined in
    is sent.
    This happens only if the value is different from the one stored in the preference.
  • FALSE for no event to be sent.
    • Returns:
    S_OK if the parameter is correctly set, E_FAIL otherwise.
    o SetImportRepRepMode
    public virtual SetImportRepRepMode( iMode,
    iSendEvent=TRUE)
    Sets the "ImportRepRep" mode.
    Parameters:
    iMode
    "ImportRepRep" mode
    • TRUE to activate it,
    • FALSE to deactivate it.
    iSendEvent
    • TRUE so that the event defined in
    is sent.
    This happens only if the value is different from the one stored in the preference.
  • FALSE for no event to be sent.
    • Returns:
    S_OK if the parameter is correctly set, E_FAIL otherwise.
    o SetInsertMode
    public virtual SetInsertMode( iMode,
    iSendEvent=TRUE)
    Sets the Insert mode.
    Parameters:
    iMode
    The possible values are NoMode, PermanentMode, and TemporaryMode.
    If TemporaryMode mode is set, a call to
    will set the mode to NoMode.
    iSendEvent
    • TRUE so that the event defined in
    is sent.
    This happens only if the value is different from the one stored in the preference.
  • FALSE for no event to be sent.
    • Returns:
    S_OK if the parameter is correctly set, E_FAIL otherwise.
    o SetIntersectionC1EdgeMode
    public virtual SetIntersectionC1EdgeMode( iMode,
    iSendEvent=TRUE)
    Sets the "Intersection C1Edge" mode.
    Parameters:
    iMode
    The possible values are NoMode, PermanentMode, and TemporaryMode.
    If TemporaryMode mode is set, a call to
    will set the mode to NoMode.
    iSendEvent
    • TRUE so that the event defined in
    is sent.
    This happens only if the value is different from the one stored in the preference.
  • FALSE for no event to be sent.
    • Returns:
    S_OK if the parameter is correctly set, E_FAIL otherwise.
    o SetIntersectionEdgeMode
    public virtual SetIntersectionEdgeMode( iMode,
    iSendEvent=TRUE)
    Sets the "Intersection Edge" mode.
    Parameters:
    iMode
    The possible values are NoMode, PermanentMode, and TemporaryMode.
    If TemporaryMode mode is set, a call to
    will set the mode to NoMode.
    iSendEvent
    • TRUE so that the event defined in
    is sent.
    This happens only if the value is different from the one stored in the preference.
  • FALSE for no event to be sent.
    • Returns:
    S_OK if the parameter is correctly set, E_FAIL otherwise.
    o SetScanGraphPanelMode
    public virtual SetScanGraphPanelMode( iVisible,
    iSendEvent=TRUE)
    Sets the visibility of the "Scan graph" panel.
    Parameters:
    iVisible
    • TRUEif the viewer is to be visible when launching the Scan command,
    • FALSE if the viewer is to not be displayed.
    iSendEvent
    • TRUE so that the event defined in
    is sent.
    This happens only if the value is different from the one stored in the preference.
  • FALSE for no event to be sent.
    • Returns:
    S_OK if the parameter is correctly set, E_FAIL otherwise.
    o SetSketchAnalysisDisplayState
    public virtual SetSketchAnalysisDisplayState( iOffOrOn,
    iSendEvent=TRUE)
    Sets the "SketchAnalysisDisplay" state.
    Parameters:
    iOffOrOn
    • FALSE to hide it,
    • TRUE to display it.
    iSendEvent
    • TRUE so that the event defined in
    is sent.
    This happens only if the value is different from the one stored in the preference.
  • FALSE for no event to be sent.
    • Returns:
    S_OK if the parameter is correctly set, E_FAIL otherwise.
    o SetSocietyIdentifier
    public virtual SetSocietyIdentifier( const iSocietyId,
    iSendEvent=TRUE)
    Sets the society identifier.
    Role: This preference is only to be used for UserFeatures type.
    Parameters:
    iSocietyId
    The society identifier.
    iSendEvent
    Code to manage events.
    Returns:
    S_OK if the parameter is correctly retrieved, E_FAIL otherwise.
    o SetUnderAxisSystemsNodeMode
    public virtual SetUnderAxisSystemsNodeMode( iMode,
    iSendEvent=TRUE)
    Sets the "Under axis system" mode.
    Parameters:
    iMode
    • TRUE if axis systems are created under the "Axis System" tree node.
        • FALSE if axis systems are created under the node of the current CATIGSMTool.
    iSendEvent
    • TRUE so that the event defined in
    is sent.
    This happens only if the value is different from the one stored in the preference.
  • FALSE for no event to be sent.
    • Returns:
    S_OK if the parameter is correctly set, E_FAIL otherwise.
    o ValidateDatumMode
    public virtual ValidateDatumMode( iSendEvent=TRUE)
    Sets the mode to NoMode if it is set to TemporaryMode.
    Role: If the mode is set to TemporaryMode, a call to this function will set it to NoMode, and send the event if asked to.
    Parameters:
    iSendEvent
    To send an event if the mode is reverted to NoMode.
    Returns:
    S_OK if the call to the method was processed without errors.
    o ValidateGridFilterMode
    public virtual ValidateGridFilterMode( iSendEvent=TRUE)
    Sets the mode to NoMode if it is set to TemporaryMode.
    Role: If the mode is set to TemporaryMode, a call to this function will set it to NoMode, and send the event if asked to.
    Parameters:
    iSendEvent
    To send an event if the mode is reverted to NoMode.
    Returns:
    S_OK if the call to the method was processed without errors.
    o ValidateInsertMode
    public virtual ValidateInsertMode( iSendEvent=TRUE)
    Sets the mode to NoMode if it is set to TemporaryMode.
    Role: If the mode is set to TemporaryMode, a call to this function will set it to NoMode, and send the event if asked to.
    Parameters:
    iSendEvent
    To send an event if the mode is reverted to NoMode.
    Returns:
    S_OK if the call to the method was processed without errors.
    o ValidateIntersectionC1EdgeMode
    public virtual ValidateIntersectionC1EdgeMode( iSendEvent=TRUE)
    Sets the mode to NoMode if it is set to TemporaryMode.
    Role: If the mode is set to TemporaryMode, a call to this function will set it to NoMode, and send the event if asked to.
    Parameters:
    iSendEvent
    To send an event if the mode is reverted to NoMode.
    Returns:
    S_OK if the call to the method was processed without errors.
    o ValidateIntersectionEdgeMode
    public virtual ValidateIntersectionEdgeMode( iSendEvent=TRUE)
    Sets the mode to NoMode if it is set to TemporaryMode.
    Role: If the mode is set to TemporaryMode, a call to this function will set it to NoMode, and send the event if asked to.
    Parameters:
    iSendEvent
    To send an event if the mode is reverted to NoMode.
    Returns:
    S_OK if the call to the method was processed without errors.

    Enumerated Types


    o PreferenceMode 
    enum PreferenceMode {
  NoMode,
  PermanentMode,
  TemporaryMode
}
    List of types for modes.
    Role: The modes are used in the following values of the preferences.
    Parameters:
    NoMode
    The preference is not set.
    PermanentMode
    The preference is set and stays set unless unset.
    Note: This state corresponds to a double click on the linked command button.
    TemporaryMode
    The preference is set for one use, and then resetted to NoMode as soon as the ValidateXxMode method is called.
    Note: This state corresponds to a single click on the linked command button.
    This object is included in the file: CATIMmiPartInfrastructurePreferencesAtt.h
    If needed, your Imakefile.mk should include the module: CATMecModUseItf

    Copyright © 1999-2014, Dassault Systèmes. All rights reserved.