All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

MecModInterfaces Interface CATIMmiPartInfrastructureSettingAtt

System.IUnknown
  |
  +---System.IDispatch
    |
    +---System.CATBaseUnknown
      |
      +---CATIMmiPartInfrastructureSettingAtt
 

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


interface CATIMmiPartInfrastructureSettingAtt

Interface to retrieve application parameters related to Part Infrastructure.
Role:This interface describes all the application parameters related to Part infrastructure, as displayed in Tools/Options.
Here under is an example on how to retrieve a pointer to this interface:

 #include "CATInstantiateComponent.h" //System
 #include "CATIMmiPartInfrastructureSettingAtt.h"  //MecModInterfaces
 { 
  ...
   CATIMmiPartInfrastructureSettingAtt *pIGetController=NULL;
   if(SUCCEEDED(::CATInstantiateComponent("CATMmuPartInfrastructureSettingCtrl", IID_CATIMmiPartInfrastructureSettingAtt,(void**)&pIGetController)))
     {
      //insert your code here
      pIGetController->Release(); pIGetController=NULL;
     }
   ...
 }
 


Method Index


o GetAlsoDeleteExclusiveParents(CATBoolean&)
Retrieves the "AlsoDeleteExclusiveParents" parameter's value.
o GetAlsoDeleteExclusiveParentsInfo(CATSettingInfo*)
Retrieves the state of the "AlsoDeleteExclusiveParents" parameter.
o GetAxisSystemSize(unsigned int&)
Retrieves the "AxisSystemSize" parameter's value.
o GetAxisSystemSizeInfo(CATSettingInfo*)
Retrieves the state of the "AxisSystemSize" parameter.
o GetBodiesUnderOperationsInTree(CATBoolean&)
Retrieves the "BodiesUnderOperationsInTree" parameter's value.
o GetBodiesUnderOperationsInTreeInfo(CATSettingInfo*)
Retrieves the state of the "BodiesUnderOperationsInTree" parameter.
o GetChangeInBufferizedParametersEvent(CATCallbackEvent&)
Retrieves the name of the event class dispatched when a change of value is effective for at least one of the parameters run by this settings controller.
o GetColorSynchronizationMode(CATBoolean&)
Retrieves the "ColorSynchronizationMode" parameter's value.
o GetColorSynchronizationModeInfo(CATSettingInfo*)
Retrieves the state of the "SynchronizationMode" parameter.
o GetConstraintsInGeometry(CATBoolean&)
Retrieves the "ConstraintsInGeometry" parameter's value.
o GetConstraintsInGeometryInfo(CATSettingInfo*)
Retrieves the state of the "ConstraintsInGeometry" parameter.
o GetConstraintsNodeInTree(CATBoolean&)
Retrieves the "ConstraintsNodeInTree" parameter's value.
o GetConstraintsNodeInTreeInfo(CATSettingInfo*)
Retrieves the state of the "ConstraintsNodeInTree" parameter.
o GetContextualFeaturesSelectableAtCreation(CATBoolean&)
Retrieves the "ContextualFeaturesSelectableAtCreation" parameter's value.
o GetContextualFeaturesSelectableAtCreationInfo(CATSettingInfo*)
Retrieves the state of the "ContextualFeaturesSelectableAtCreation" parameter.
o GetDeleteWarningBox(CATBoolean&)
Retrieves the "DeleteWarningBox" parameter's value.
o GetDeleteWarningBoxInfo(CATSettingInfo*)
Retrieves the state of the "DeleteWarningBox" parameter.
o GetDisplayGeometryAfterCurrent(CATBoolean&)
Retrieves the "DisplayGeometryAfterCurrent" parameter's value.
o GetDisplayGeometryAfterCurrentInfo(CATSettingInfo*)
Retrieves the state of the "DisplayGeometryAfterCurrent" parameter.
o GetExpandSketchBasedFeaturesNodeAtCreation(CATBoolean&)
Retrieves the "ExpandSketchBasedFeaturesNodeAtCreation" parameter's value.
o GetExpandSketchBasedFeaturesNodeAtCreationInfo(CATSettingInfo*)
Retrieves the state of the "ExpandSketchBasedFeaturesNodeAtCreation" parameter.
o GetExternalReferencesAsVisible(CATBoolean&)
Retrieves the "ExternalReferencesAsVisible" parameter's value.
o GetExternalReferencesAsVisibleInfo(CATSettingInfo*)
Retrieves the state of the "ExternalReferencesAsVisible" parameter.
o GetExternalReferencesAssemblyRootContext(CATBoolean&)
Retrieves the "ExternalReferencesAssemblyRootContext" parameter's value.
o GetExternalReferencesAssemblyRootContextInfo(CATSettingInfo*)
Retrieves the state of the "ExternalReferencesAssemblyRootContext" parameter.
o GetExternalReferencesNodeInTree(CATBoolean&)
Retrieves the "ExternalReferencesNodeInTree" parameter's value.
o GetExternalReferencesNodeInTreeInfo(CATSettingInfo*)
Retrieves the state of the "ExternalReferencesNodeInTree" parameter.
o GetHybridDesignMode(CATBoolean&)
Retrieves the "HybridDesignMode" parameter's value.
o GetHybridDesignModeInfo(CATSettingInfo*)
Retrieves the state of the "HybridDesignMode" parameter.
o GetKnowledgeInHybridDesignMode(CATBoolean&)
Retrieves the "KnowledgeInHybridDesignMode" parameter's value.
o GetKnowledgeInHybridDesignModeInfo(CATSettingInfo*)
Retrieves the state of the "KnowledgeInHybridDesignMode" parameter.
o GetLinkedExternalReferences(CATBoolean&)
Retrieves the "LinkedExternalReferences" parameter's value.
o GetLinkedExternalReferencesInfo(CATSettingInfo*)
Retrieves the state of the "LinkedExternalReferences" parameter.
o GetLinkedExternalReferencesOnlyOnPublication(CATBoolean&)
Retrieves the "LinkedExternalReferencesOnlyOnPublication" parameter's value.
o GetLinkedExternalReferencesOnlyOnPublicationInfo(CATSettingInfo*)
Retrieves the state of the "LinkedExternalReferencesOnlyOnPublication" parameter.
o GetLinkedExternalReferencesWarningAtCreation(CATBoolean&)
Retrieves the "LinkedExternalReferencesWarningAtCreation" parameter's value.
o GetLinkedExternalReferencesWarningAtCreationInfo(CATSettingInfo*)
Retrieves the state of the "LinkedExternalReferencesWarningAtCreation" parameter.
o GetNamingMode(CatPartElementsNamingMode&)
Retrieves the "NamingMode" parameter's value.
o GetNamingModeInfo(CATSettingInfo*)
Retrieves the state of the "NamingMode" parameter.
o GetNewWith3DSupport(CATBoolean&)
Retrieves the "NewWith3DSupport" parameter's value.
o GetNewWith3DSupportInfo(CATSettingInfo*)
Retrieves the state of the "NewWith3DSupport" parameter.
o GetNewWithAxisSystem(CATBoolean&)
Retrieves the "NewWithAxisSystem" parameter's value.
o GetNewWithAxisSystemInfo(CATSettingInfo*)
Retrieves the information object for the "NewWithAxisSystem" parameter.
o GetNewWithGS(CATBoolean&)
Retrieves the "NewWithGS" parameter's value.
o GetNewWithGSInfo(CATSettingInfo*)
Retrieves the information object for the "NewWithGS" parameter.
o GetNewWithOGS(CATBoolean&)
Retrieves the "NewWithOGS" parameter's value.
o GetNewWithOGSInfo(CATSettingInfo*)
Retrieves the state of the "NewWithOGS" parameter.
o GetNewWithPanel(CATBoolean&)
Retrieves the "NewWithPanel" parameter's value.
o GetNewWithPanelInfo(CATSettingInfo*)
Retrieves the state of the "NewWithPanel" parameter.
o GetOnlyCurrentOperatedSolidSetInGeometry(CATBoolean&)
Retrieves the "OnlyCurrentOperatedSolidSetInGeometry" parameter's value.
o GetOnlyCurrentOperatedSolidSetInGeometryInfo(CATSettingInfo*)
Retrieves the state of the "OnlyCurrentOperatedSolidSetInGeometry" parameter.
o GetOnlyCurrentSolidSetInGeometry(CATBoolean&)
Retrieves the "OnlyCurrentSolidSetInGeometry" parameter's value.
o GetOnlyCurrentSolidSetInGeometryInfo(CATSettingInfo*)
Retrieves the state of the "OnlyCurrentSolidSetInGeometry" parameter.
o GetParametersNodeInTree(CATBoolean&)
Retrieves the "ParametersNodeInTree" parameter's value.
o GetParametersNodeInTreeInfo(CATSettingInfo*)
Retrieves the state of the "ParametersNodeInTree" parameter.
o GetPublishTopologicalElements(CATBoolean&)
Retrieves the "PublishTopologicalElements" parameter's value.
o GetPublishTopologicalElementsInfo(CATSettingInfo*)
Retrieves the state of the "PublishTopologicalElements" parameter.
o GetRelationsNodeInTree(CATBoolean&)
Retrieves the "RelationsNodeInTree" parameter's value.
o GetRelationsNodeInTreeInfo(CATSettingInfo*)
Retrieves the state of the "RelationsNodeInTree" parameter.
o GetReplaceOnlyAfterCurrent(CATBoolean&)
Retrieves the "ReplaceOnlyAfterCurrent" parameter's value.
o GetReplaceOnlyAfterCurrentInfo(CATSettingInfo*)
Retrieves the state of the "ReplaceOnlyAfterCurrent" parameter.
o GetSurfaceElementsLocation(CatPartSurfaceElementsLocation&)
Retrieves the "SurfaceElementsLocation" parameter's value.
o GetSurfaceElementsLocationInfo(CATSettingInfo*)
Retrieves the state of the "SurfaceElementsLocation" parameter.
o GetTrueColorMode(CATBoolean&)
Retrieves the "ColorInheritanceMode" parameter's value.
o GetTrueColorModeInfo(CATSettingInfo*)
Retrieves the state of the "ColorInheritanceMode" parameter.
o GetUpdateElementsRefreshed(CATBoolean&)
Retrieves the "UpdateElementsRefreshed" parameter's value.
o GetUpdateElementsRefreshedInfo(CATSettingInfo*)
Retrieves the state of the "UpdateElementsRefreshed" parameter.
o GetUpdateLinkedExternalReferences(CATBoolean&)
Retrieves the "UpdateLinkedExternalReferences" parameter's value.
o GetUpdateLinkedExternalReferencesInfo(CATSettingInfo*)
Retrieves the state of the "UpdateLinkedExternalReferences" parameter.
o GetUpdateMode(CatPartUpdateMode&)
Retrieves the "UpdateMode" parameter's value.
o GetUpdateModeInfo(CATSettingInfo*)
Retrieves the state of the "UpdateMode" parameter.
o GetUpdateStoppedOnError(CATBoolean&)
Retrieves the "UpdateStoppedOnError" parameter's value.
o GetUpdateStoppedOnErrorInfo(CATSettingInfo*)
Retrieves the state of the "UpdateStoppedOnError" parameter.

Methods


o GetAlsoDeleteExclusiveParents
public virtual HRESULT GetAlsoDeleteExclusiveParents(CATBoolean& oDeleted) = 0
Retrieves the "AlsoDeleteExclusiveParents" parameter's value.
Role: This parameter defines if a exclusive parents of an object will also be deleted when the object is deleted.
This option is effective only when the "Deletion warning box" is displayed.
Parameters:
oDeleted
Current "AlsoDeleteExclusiveParents" parameter's value:
  • TRUE or 1 if exclusive parents are also deleted,
  • FALSE or 0 otherwise.
Returns:
S_OK if the parameter is correctly retrieved, E_FAIL otherwise.
o GetAlsoDeleteExclusiveParentsInfo
public virtual HRESULT GetAlsoDeleteExclusiveParentsInfo(CATSettingInfo* oInfo)= 0
Retrieves the state of the "AlsoDeleteExclusiveParents" parameter.
Parameters:
oInfo
Address of an object CATSettingInfo.
Returns:
Legal values:
S_OK : on success
E_FAIL: on failure
o GetAxisSystemSize
public virtual HRESULT GetAxisSystemSize(unsigned int& oSize) = 0
Retrieves the "AxisSystemSize" parameter's value.
Role: This parameter determines the size of axis systems.
Parameters:
oSize
Current size of axis systems
Returns:
S_OK if the parameter is correctly retrieved, E_FAIL otherwise.
o GetAxisSystemSizeInfo
public virtual HRESULT GetAxisSystemSizeInfo(CATSettingInfo* oInfo)= 0
Retrieves the state of the "AxisSystemSize" parameter.
Parameters:
oInfo
Address of an object CATSettingInfo.
Returns:
Legal values:
S_OK : on success
E_FAIL: on failure
o GetBodiesUnderOperationsInTree
public virtual HRESULT GetBodiesUnderOperationsInTree(CATBoolean& oNodeDisplayed) = 0
Retrieves the "BodiesUnderOperationsInTree" parameter's value.
Role: This parameter determines if a Body node is displayed when it is being aggregated under a boolean operation (Add, Assemble, Remove, Intersect, Union Trim).
Its value can be changed even after a boolean operation has been created. Simply collapse and expand the federating boolean operation node for the specification tree to be refreshed.
Parameters:
oNodeDisplayed
Current "BodiesUnderOperationsInTree" parameter's value:
  • TRUE or 1 if such a node is displayed,
  • FALSE or 0 otherwise.
Returns:
S_OK if the parameter is correctly retrieved, E_FAIL otherwise.
o GetBodiesUnderOperationsInTreeInfo
public virtual HRESULT GetBodiesUnderOperationsInTreeInfo(CATSettingInfo* oInfo)= 0
Retrieves the state of the "BodiesUnderOperationsInTree" parameter.
Parameters:
oInfo
Address of an object CATSettingInfo.
Returns:
Legal values:
S_OK : on success
E_FAIL: on failure
o GetChangeInBufferizedParametersEvent
public virtual HRESULT GetChangeInBufferizedParametersEvent(CATCallbackEvent& oEvent) = 0
Retrieves the name of the event class dispatched when a change of value is effective for at least one of the parameters run by this settings controller.
Role: This event is complementary to the events sent by the CATSysSettingController class:
The event defined here warns its users that at least one of the parameters' value is changed AND that this change is somewhat made permanent. This means:
In addition, the notification sent ( CATMmiPartInfrastructureNotification ) contains data regarding which parameter(s) is (are) affected. Parameters' names are detailed in the different methods of this interface.

Here is a coding sample for the use of this event:
 #include "CATSysMacros.h"            //System
 #include "CATInstantiateComponent.h" //System
 #include "CATMmiPartInfrastructureNotification.h" //MecModInterfaces
 #include "CATIMmiPartInfrastructureSettingAtt.h"  //MecModInterfaces
 { //Subscription
  CATIMmiPartInfrastructureSettingAtt *pIGetController=NULL;
  CATCallbackEvent event;
  if(SUCCEEDED(::CATInstantiateComponent("CATMmuPartInfrastructureSettingCtrl", IID_CATIMmiPartInfrastructureSettingAtt,(void**)&pIGetController)) &&
     SUCCEEDED(pIGetController->GetChangeInBufferizedParametersEvent(event)))
     _callbackId=AddCallback(this, pIGetController, event, CATSubscriberMethod)&MyClass::ValuesChangedCB, NULL);
    CATSysReleasePtr(pIGetController);
 }
 
 { //Unsubscription
  CATIMmiPartInfrastructureSettingAtt *pISettingCtrl=NULL;
  if(_callbackId && 
     SUCCEEDED(::CATInstantiateComponent("CATMmuPartInfrastructureSettingCtrl", IID_CATIMmiPartInfrastructureSettingAtt,(void**)&pISettingCtrl)))
    {
     RemoveCallback(this, pISettingCtrl, _callbackId);
     pISettingCtrl->Release(); pISettingCtrl=NULL;
    }
 }
 
 void MyClass::ValuesChangedCB(CATCallbackEvent iEvt,void * iSrv,
                               CATNotification * iNotif, 
                               CATSubscriberData iData,CATCallback iCB)
 {
   if(!iNotif || !iNotif->IsAKindOf(CATMmiPartInfrastructureNotification::ClassName()))
     return;
     
   //Let us find out which is the impacted parameter.
   CATListOfCATString parametersList=((CATMmiPartInfrastructureNotification*)iNotif)->_parametersList;
   if(parametersList.Locate("Parameter_Name_1") ||
      parametersList.Locate("Parameter_Name_2") ||
      ...                                       ||
      parametersList.Locate("Parameter_Name_N")           )
    {
     //Insert the dedicated code here.
    }
  }
 
 
Now here is a coding sample concerning synchroneous event sent whenever a parameter's value is changed.
 #include "CATInstantiateComponent.h" //System
 #include "CATSettingInfo.h"          //System
 #include "CATSysSettingController.h" //System
 #include "CATSysSettingCtrlNotif.h"  //System
 #include "CATIMmiPartInfrastructureSettingAtt.h" //MecModInterfaces
 { //Subscription
  CATIMmiPartInfrastructureSettingAtt *pISettingCtrl=NULL;
  if(SUCCEEDED(::CATInstantiateComponent("CATMmuPartInfrastructureSettingCtrl", 
                                         IID_CATIMmiPartInfrastructureSettingAtt,
                                         (void**)&pISettingCtrl)))
   {
    _callbackId= AddCallback(this, pISettingCtrl, CATSysSettingController::Param_Updated(),
                             (CATSubscriberMethod)&MyClass::OnSettingsChange, NULL);
    pISettingCtrl->Release(); pISettingCtrl=NULL;
   }
 }
 
 { //Unsubscription
  CATIMmiPartInfrastructureSettingAtt *pISettingCtrl=NULL;
  if(_callbackId && 
     SUCCEEDED(::CATInstantiateComponent("CATMmuPartInfrastructureSettingCtrl", IID_CATIMmiPartInfrastructureSettingAtt, (void**)&pISettingCtrl)))
    {
     RemoveCallback(this, pISettingCtrl, _callbackId);
     pISettingCtrl->Release(); pISettingCtrl=NULL;
    }
 }
 
 void MyClass::OnSettingsChange(CATCallbackEvent iEvt,void * iSrv,
                                CATNotification * iNotif, 
                                CATSubscriberData iData,CATCallback iCB)
 {
  if(!iNotif || !iNotif->IsAKindOf(CATSysSettingCtrlNotif::ClassName()))
    return;
   
  CATIMmiPartInfrastructureSettingAtt* pISettingCtrl=NULL;
  if(SUCCEEDED(::CATInstantiateComponent("CATMmuPartInfrastructureSettingCtrl", IID_CATIMmiPartInfrastructureSettingAtt, (void**)&pISettingCtrl)))
   {
    CATSettingInfo settingInfo, *notifSettingInfo=NULL;
       
    //Let us find out for which parameter the notification is sent.
    HRESULT rc=pISettingCtrl->GetParameterNameInfo(&settingInfo);
    pISettingCtrl->Release(); pISettingCtrl=NULL;
    if(FAILED(rc) ||
       ((notifSettingInfo=((CATSysSettingCtrlNotif*)iNotif)->_Info) &&
       !(settingInfo==*notifSettingInfo)))
      return;
 
     //Insert the dedicated code here.
    }     
 }
 
Parameters:
oEvent
The name of the event sent
Returns:
S_OK always.
o GetColorSynchronizationMode
public virtual HRESULT GetColorSynchronizationMode(CATBoolean& oColorSynchronizationMode) = 0
Retrieves the "ColorSynchronizationMode" parameter's value.
Role: This parameter determines color synchronization mode for imported feature in a part.
Color synchronization mode defines whether the imported feature, created through copy/paste as result with link mechanism, copies reference feature colors on its faces or not. If it is valuated to 1, synchronization will be effective and referece feature colors will be reported. If it is defined to 0, nothing will be copied(default mode). This option cannot be changed after a document has been opened.
Parameters:
oColorSynchronizationMode
Current "ColorSynchronizationMode" parameter's value:
  • TRUE or 1 if reference feature colors are reported on imported feature,
  • FALSE or 0 otherwise.
Returns:
S_OK if the parameter is correctly retrieved, E_FAIL otherwise.
o GetColorSynchronizationModeInfo
public virtual HRESULT GetColorSynchronizationModeInfo(CATSettingInfo* oInfo)= 0
Retrieves the state of the "SynchronizationMode" parameter.
Parameters:
oInfo
Address of an object CATSettingInfo.
Returns:
Legal values:
S_OK : on success
E_FAIL: on failure
o GetConstraintsInGeometry
public virtual HRESULT GetConstraintsInGeometry(CATBoolean& oDisplayed) = 0
Retrieves the "ConstraintsInGeometry" parameter's value.
Role: This parameter enables constraints to be visualized in the 3D view.
Parameters:
oDisplayed
Current "Display constraints within 3D" parameter's value:
  • TRUE or 1 if constraints are displayed,
  • FALSE or 0 otherwise.
Returns:
S_OK if the parameter is correctly retrieved, E_FAIL otherwise.
o GetConstraintsInGeometryInfo
public virtual HRESULT GetConstraintsInGeometryInfo(CATSettingInfo* oInfo)= 0
Retrieves the state of the "ConstraintsInGeometry" parameter.
Parameters:
oInfo
Address of an object CATSettingInfo.
Returns:
Legal values:
S_OK : on success
E_FAIL: on failure
o GetConstraintsNodeInTree
public virtual HRESULT GetConstraintsNodeInTree(CATBoolean& oNodeDisplayed) = 0
Retrieves the "ConstraintsNodeInTree" parameter's value.
Role: This parameter determines if a node called "Constraints" is created to contain all constraints.
Its value can be changed even after constraints have been created. The result is that the specification tree node display status will be affected.
Parameters:
oNodeDisplayed
Current "ConstraintsNodeInTree" parameter's value:
  • TRUE or 1 if such a node is displayed,
  • FALSE or 0 otherwise.
Returns:
S_OK if the parameter is correctly retrieved, E_FAIL otherwise.
o GetConstraintsNodeInTreeInfo
public virtual HRESULT GetConstraintsNodeInTreeInfo(CATSettingInfo* oInfo)= 0
Retrieves the state of the "ConstraintsNodeInTree" parameter.
Parameters:
oInfo
Address of an object CATSettingInfo.
Returns:
Legal values:
S_OK : on success
E_FAIL: on failure
o GetContextualFeaturesSelectableAtCreation
public virtual HRESULT GetContextualFeaturesSelectableAtCreation(CATBoolean& oContextualFeaturesSelectable) = 0
Retrieves the "ContextualFeaturesSelectableAtCreation" parameter's value.
Role: This parameter determines if contextual features can be selected during the creation of an other feature.
Parameters:
oContextualFeaturesSelectable
Current "ContextualFeaturesSelectableAtCreation" parameter's value:
  • TRUE or 1 if contextual features can be selected,
  • FALSE or 0 otherwise.
Returns:
S_OK if the parameter is correctly retrieved, E_FAIL otherwise.
o GetContextualFeaturesSelectableAtCreationInfo
public virtual HRESULT GetContextualFeaturesSelectableAtCreationInfo(CATSettingInfo* oInfo)= 0
Retrieves the state of the "ContextualFeaturesSelectableAtCreation" parameter.
Parameters:
oInfo
Address of an object CATSettingInfo.
Returns:
Legal values:
S_OK : on success
E_FAIL: on failure
o GetDeleteWarningBox
public virtual HRESULT GetDeleteWarningBox(CATBoolean& oDisplayed) = 0
Retrieves the "DeleteWarningBox" parameter's value.
Role: This parameter defines if a warning box is displayed when an element is deleted.
Parameters:
oDisplayed
Current "DeleteWarningBox" parameter's value:
  • TRUE or 1 if a warning box is displayed at deletion,
  • FALSE or 0 otherwise.
Returns:
S_OK if the parameter is correctly retrieved, E_FAIL otherwise.
o GetDeleteWarningBoxInfo
public virtual HRESULT GetDeleteWarningBoxInfo(CATSettingInfo* oInfo)= 0
Retrieves the state of the "DeleteWarningBox" parameter.
Parameters:
oInfo
Address of an object CATSettingInfo.
Returns:
Legal values:
S_OK : on success
E_FAIL: on failure
o GetDisplayGeometryAfterCurrent
public virtual HRESULT GetDisplayGeometryAfterCurrent(CATBoolean& oDisplayed) = 0
Retrieves the "DisplayGeometryAfterCurrent" parameter's value.
Role: This parameter enables to visualize in the 3D features after the current object in O.G.S. and "solid and surface set".
Parameters:
oDisplayed
Current "DisplayGeometryAfterCurrent" parameter's value:
  • TRUE or 1 if such is the visualization,
  • FALSE or 0 otherwise.
Returns:
S_OK if the parameter is correctly retrieved, E_FAIL otherwise.
o GetDisplayGeometryAfterCurrentInfo
public virtual HRESULT GetDisplayGeometryAfterCurrentInfo(CATSettingInfo* oInfo)= 0
Retrieves the state of the "DisplayGeometryAfterCurrent" parameter.
Parameters:
oInfo
Address of an object CATSettingInfo.
Returns:
Legal values:
S_OK : on success
E_FAIL: on failure
o GetExpandSketchBasedFeaturesNodeAtCreation
public virtual HRESULT GetExpandSketchBasedFeaturesNodeAtCreation(CATBoolean& oNodeExpanded) = 0
Retrieves the "ExpandSketchBasedFeaturesNodeAtCreation" parameter's value.
Role: This parameter determines if specification tree nodes for sketch-based features are expanded when such elements are created. This will enable to view their sketch node.
Parameters:
oNodeExpanded
Current "ExpandSketchBasedFeaturesNodeAtCreation" parameter's value:
  • TRUE or 1 if such nodes are expanded,
  • FALSE or 0 otherwise.
Returns:
S_OK if the parameter is correctly retrieved, E_FAIL otherwise.
o GetExpandSketchBasedFeaturesNodeAtCreationInfo
public virtual HRESULT GetExpandSketchBasedFeaturesNodeAtCreationInfo(CATSettingInfo* oInfo)= 0
Retrieves the state of the "ExpandSketchBasedFeaturesNodeAtCreation" parameter.
Parameters:
oInfo
Address of an object CATSettingInfo.
Returns:
Legal values:
S_OK : on success
E_FAIL: on failure
o GetExternalReferencesAsVisible
public virtual HRESULT GetExternalReferencesAsVisible(CATBoolean& oVisible) = 0
Retrieves the "ExternalReferencesAsVisible" parameter's value.
Role: This parameter defines if an external reference is visible when being created.
Parameters:
oVisible
Current "ExternalReferencesAsVisible" parameter's value:
  • TRUE or 1 if external references are visible when being created,
  • FALSE or 0 otherwise.
Returns:
S_OK if the parameter is correctly retrieved, E_FAIL otherwise.
o GetExternalReferencesAsVisibleInfo
public virtual HRESULT GetExternalReferencesAsVisibleInfo(CATSettingInfo* oInfo)= 0
Retrieves the state of the "ExternalReferencesAsVisible" parameter.
Parameters:
oInfo
Address of an object CATSettingInfo.
Returns:
Legal values:
S_OK : on success
E_FAIL: on failure
o GetExternalReferencesAssemblyRootContext
public virtual HRESULT GetExternalReferencesAssemblyRootContext(CATBoolean& oRootContextUsed) = 0
Retrieves the "ExternalReferencesAssemblyRootContext" parameter's value.
Role: This parameter defines if external references are created using the root context of an assembly.
Parameters:
oRootContextUsed
Current "ExternalReferencesAssemblyRootContext" parameter's value:
  • TRUE or 1 if external references are created using the root context of an assembly,
  • FALSE or 0 otherwise.
Returns:
S_OK if the parameter is correctly retrieved, E_FAIL otherwise.
o GetExternalReferencesAssemblyRootContextInfo
public virtual HRESULT GetExternalReferencesAssemblyRootContextInfo(CATSettingInfo* oInfo)= 0
Retrieves the state of the "ExternalReferencesAssemblyRootContext" parameter.
Parameters:
oInfo
Address of an object CATSettingInfo.
Returns:
Legal values:
S_OK : on success
E_FAIL: on failure
o GetExternalReferencesNodeInTree
public virtual HRESULT GetExternalReferencesNodeInTree(CATBoolean& oNodeDisplayed) = 0
Retrieves the "ExternalReferencesNodeInTree" parameter's value.
Role: This parameter determines if a node called "External Reference" is created to contain all linked external references.
Its value can be changed even after linked external references have been created. The result is that the specification tree node display status will be affected.
Parameters:
oNodeDisplayed
Current "ExternalReferencesNodeInTree" parameter's value:
  • TRUE or 1 if such a node is displayed,
  • FALSE or 0 otherwise.
Returns:
S_OK if the parameter is correctly retrieved, E_FAIL otherwise.
o GetExternalReferencesNodeInTreeInfo
public virtual HRESULT GetExternalReferencesNodeInTreeInfo(CATSettingInfo* oInfo)= 0
Retrieves the state of the "ExternalReferencesNodeInTree" parameter.
Parameters:
oInfo
Address of an object CATSettingInfo.
Returns:
Legal values:
S_OK : on success
E_FAIL: on failure
o GetHybridDesignMode
public virtual HRESULT GetHybridDesignMode(CATBoolean& oHybridDesign) = 0
Retrieves the "HybridDesignMode" parameter's value.
Role: This parameter determines if hybrid design is possible inside Part Bodies and bodies.
This option can be changed even after a document has been opened.
Parameters:
oHybridDesign
Current "HybridDesignMode" parameter's value:
  • TRUE or 1 if hybrid design is enabled,
  • FALSE or 0 otherwise.
Returns:
S_OK if the parameter is correctly retrieved, E_FAIL otherwise.
o GetHybridDesignModeInfo
public virtual HRESULT GetHybridDesignModeInfo(CATSettingInfo* oInfo)= 0
Retrieves the state of the "HybridDesignMode" parameter.
Parameters:
oInfo
Address of an object CATSettingInfo.
Returns:
Legal values:
S_OK : on success
E_FAIL: on failure
o GetKnowledgeInHybridDesignMode
public virtual HRESULT GetKnowledgeInHybridDesignMode(CATBoolean& oKnowledgeInHybridDesign) = 0
Retrieves the "KnowledgeInHybridDesignMode" parameter's value.
Role: This parameter determines if knowledge features (formulas, parameters, rules, ...) can be located inside ordered sets.
This option can be changed even after a document has been opened.
Parameters:
oHybridDesign
Current "KnowledegInHybridDesignMode" parameter's value:
  • TRUE or 1 if knowledge in hybrid design is enabled,
  • FALSE or 0 otherwise.
Returns:
S_OK if the parameter is correctly retrieved, E_FAIL otherwise.
o GetKnowledgeInHybridDesignModeInfo
public virtual HRESULT GetKnowledgeInHybridDesignModeInfo(CATSettingInfo* oInfo)= 0
Retrieves the state of the "KnowledgeInHybridDesignMode" parameter.
Parameters:
oInfo
Address of an object CATSettingInfo.
Returns:
Legal values:
S_OK : on success
E_FAIL: on failure
o GetLinkedExternalReferences
public virtual HRESULT GetLinkedExternalReferences(CATBoolean& oWithLink) = 0
Retrieves the "LinkedExternalReferences" parameter's value.
Role: This parameter enables creation of external references with links.
Parameters:
oWithLink
"LinkedExternalReferences" parameter's value:
  • TRUE or 1 if external references are created with links,
  • FALSE or 0 otherwise.
Returns:
S_OK if the parameter is correctly retrieved, E_FAIL otherwise.
o GetLinkedExternalReferencesInfo
public virtual HRESULT GetLinkedExternalReferencesInfo(CATSettingInfo* oInfo)= 0
Retrieves the state of the "LinkedExternalReferences" parameter.
Parameters:
oInfo
Address of an object CATSettingInfo.
Returns:
Legal values:
S_OK : on success
E_FAIL: on failure
o GetLinkedExternalReferencesOnlyOnPublication
public virtual HRESULT GetLinkedExternalReferencesOnlyOnPublication(CATBoolean& oOnlyForPublishedElements) = 0
Retrieves the "LinkedExternalReferencesOnlyOnPublication" parameter's value.
Role: This parameter restricts the creation of external references with links to only published elements.
This option is only used when external references are created with link.
Parameters:
oOnlyForPublishedElements
Current "LinkedExternalReferencesOnlyOnPublication" parameter's value:
  • TRUE or 1 if external references with link are only allowed on published elements,
  • FALSE or 0 otherwise.
Returns:
S_OK if the parameter is correctly retrieved, E_FAIL otherwise.
o GetLinkedExternalReferencesOnlyOnPublicationInfo
public virtual HRESULT GetLinkedExternalReferencesOnlyOnPublicationInfo(CATSettingInfo* oInfo)= 0
Retrieves the state of the "LinkedExternalReferencesOnlyOnPublication" parameter.
Parameters:
oInfo
Address of an object CATSettingInfo.
Returns:
Legal values:
S_OK : on success
E_FAIL: on failure
o GetLinkedExternalReferencesWarningAtCreation
public virtual HRESULT GetLinkedExternalReferencesWarningAtCreation(CATBoolean& oWarningAtCreation) = 0
Retrieves the "LinkedExternalReferencesWarningAtCreation" parameter's value.
Role: This parameter defines if a warning panel is displayed each time an external reference with llink is created. The panel enables the user to decide whether the link will be kept or not.
This option is only used when external references are created with link.
Parameters:
oWarningAtCreation
Current "LinkedExternalReferencesWarningAtCreation" parameter's value:
  • TRUE or 1 if a panel is displayed upon external references with link creation,
  • FALSE or 0 otherwise.
Returns:
S_OK if the parameter is correctly retrieved, E_FAIL otherwise.
o GetLinkedExternalReferencesWarningAtCreationInfo
public virtual HRESULT GetLinkedExternalReferencesWarningAtCreationInfo(CATSettingInfo* oInfo)= 0
Retrieves the state of the "LinkedExternalReferencesWarningAtCreation" parameter.
Parameters:
oInfo
Address of an object CATSettingInfo.
Returns:
Legal values:
S_OK : on success
E_FAIL: on failure
o GetNamingMode
public virtual HRESULT GetNamingMode(CatPartElementsNamingMode& oNamingMode) = 0
Retrieves the "NamingMode" parameter's value.
Role: This parameter determines how an element can be named through Edit/Properties or any operation creating a feature (Copy-Paste, etc.).
When this option is being changed, it only affects elements whose name is modified afterwards.
Parameters:
oNamingMode
Current "NamingMode" parameter's value:
  • catNoCheck when naming is rule-free,
  • catNamingCheckUnderSameNode when 2 elements cannot have the same name under the same node,
  • catNamingCheckWithinUIActiveObject when 2 elements cannot have the same name within a defined UIActiveObject.
Returns:
S_OK if the parameter is correctly retrieved, E_FAIL otherwise.
o GetNamingModeInfo
public virtual HRESULT GetNamingModeInfo(CATSettingInfo* oInfo)= 0
Retrieves the state of the "NamingMode" parameter.
Parameters:
oInfo
Address of an object CATSettingInfo.
Returns:
Legal values:
S_OK : on success
E_FAIL: on failure
o GetNewWith3DSupport
public virtual HRESULT GetNewWith3DSupport(CATBoolean& o3DSupportCreated) = 0
Retrieves the "NewWith3DSupport" parameter's value.
Role: This parameter determines if a new .CATPart document will be created with 3D working support.
Parameters:
o3DSupportCreated
Current "NewWith3DSupport" parameter's value:
  • TRUE or 1 if a 3D support is created,
  • FALSE or 0 otherwise.
Returns:
S_OK if the parameter is correctly retrieved, E_FAIL otherwise.
o GetNewWith3DSupportInfo
public virtual HRESULT GetNewWith3DSupportInfo(CATSettingInfo* oInfo)= 0
Retrieves the state of the "NewWith3DSupport" parameter.
Parameters:
oInfo
Address of an object CATSettingInfo.
Returns:
Legal values:
S_OK : on success
E_FAIL: on failure
o GetNewWithAxisSystem
public virtual HRESULT GetNewWithAxisSystem(CATBoolean& oAxisSystemCreated) = 0
Retrieves the "NewWithAxisSystem" parameter's value.
Role: This parameter determines if a new .CATPart document will be created with an Axis System.
Parameters:
oAxisSystemCreated
Current "NewWithAxisSystem" parameter's value:
  • TRUE or 1 if an axis system is created,
  • FALSE or 0 otherwise.
Returns:
S_OK if the parameter is correctly retrieved, E_FAIL otherwise.
o GetNewWithAxisSystemInfo
public virtual HRESULT GetNewWithAxisSystemInfo(CATSettingInfo* oInfo)= 0
Retrieves the information object for the "NewWithAxisSystem" parameter.
Parameters:
oInfo
Address of an object CATSettingInfo.
Returns:
Legal values:
S_OK : on success
E_FAIL: on failure
o GetNewWithGS
public virtual HRESULT GetNewWithGS(CATBoolean& oGSCreated) = 0
Retrieves the "NewWithGS" parameter's value.
Role: This parameter determines if a new .CATPart document will be created with a G.S..
Parameters:
oGSCreated
Current "NewWithGS" parameter's value:
  • TRUE or 1 if a G.S. is created,
  • FALSE or 0 otherwise.
Returns:
S_OK if the parameter is correctly retrieved, E_FAIL otherwise.
o GetNewWithGSInfo
public virtual HRESULT GetNewWithGSInfo(CATSettingInfo* oInfo)= 0
Retrieves the information object for the "NewWithGS" parameter.
Parameters:
oInfo
Address of an object CATSettingInfo.
Returns:
Legal values:
S_OK : on success
E_FAIL: on failure
o GetNewWithOGS
public virtual HRESULT GetNewWithOGS(CATBoolean& oOGSCreated) = 0
Retrieves the "NewWithOGS" parameter's value.
Role: This parameter determines if a new .CATPart document will be created with an O.G.S..
Parameters:
oOGSCreated
Current "NewWithOGS" parameter's value:
  • TRUE or 1 if an O.G.S. is created,
  • FALSE or 0 otherwise.
Returns:
S_OK if the parameter is correctly retrieved, E_FAIL otherwise.
o GetNewWithOGSInfo
public virtual HRESULT GetNewWithOGSInfo(CATSettingInfo* oInfo)= 0
Retrieves the state of the "NewWithOGS" parameter.
Parameters:
oInfo
Address of an object CATSettingInfo.
Returns:
Legal values:
S_OK : on success
E_FAIL: on failure
o GetNewWithPanel
public virtual HRESULT GetNewWithPanel(CATBoolean& oNewPartPanelDisplayed) = 0
Retrieves the "NewWithPanel" parameter's value.
Role: This parameter determines if a dedicated 'New Part' panel is displayed when createing a new .CATPart document.
Parameters:
oNewPartPanelDisplayed
Current "NewWithPanel" parameter's value:
  • TRUE or 1 if the 'New Part' panel is displayed,
  • FALSE or 0 otherwise.
Returns:
S_OK if the parameter is correctly retrieved, E_FAIL otherwise.
o GetNewWithPanelInfo
public virtual HRESULT GetNewWithPanelInfo(CATSettingInfo* oInfo)= 0
Retrieves the state of the "NewWithPanel" parameter.
Parameters:
oInfo
Address of an object CATSettingInfo.
Returns:
Legal values:
S_OK : on success
E_FAIL: on failure
o GetOnlyCurrentOperatedSolidSetInGeometry
public virtual HRESULT GetOnlyCurrentOperatedSolidSetInGeometry(CATBoolean& oDisplayed) = 0
Retrieves the "OnlyCurrentOperatedSolidSetInGeometry" parameter's value.
Role: This parameter enables to visualize in the 3D only the current operated body's feature (operated means being aggregated in a boolean operation), as well as all other bodies and sets direcly inserted under the Part feature.
Parameters:
oDisplayed
Current "Display in 3D only current operated solid set" parameter's value:
  • TRUE or 1 if such is the visualization,
  • FALSE or 0 otherwise.
Returns:
S_OK if the parameter is correctly retrieved, E_FAIL otherwise.
o GetOnlyCurrentOperatedSolidSetInGeometryInfo
public virtual HRESULT GetOnlyCurrentOperatedSolidSetInGeometryInfo(CATSettingInfo* oInfo)= 0
Retrieves the state of the "OnlyCurrentOperatedSolidSetInGeometry" parameter.
Parameters:
oInfo
Address of an object CATSettingInfo.
Returns:
Legal values:
S_OK : on success
E_FAIL: on failure
o GetOnlyCurrentSolidSetInGeometry
public virtual HRESULT GetOnlyCurrentSolidSetInGeometry(CATBoolean& oDisplayed) = 0
Retrieves the "OnlyCurrentSolidSetInGeometry" parameter's value.
Role: This parameter enables to visualize in the 3D only current body's features.
Parameters:
oDisplayed
Current "OnlyCurrentSolidSetInGeometry" parameter's value:
  • TRUE or 1 if such is the visualization,
  • FALSE or 0 otherwise.
Returns:
S_OK if the parameter is correctly retrieved, E_FAIL otherwise.
o GetOnlyCurrentSolidSetInGeometryInfo
public virtual HRESULT GetOnlyCurrentSolidSetInGeometryInfo(CATSettingInfo* oInfo)= 0
Retrieves the state of the "OnlyCurrentSolidSetInGeometry" parameter.
Parameters:
oInfo
Address of an object CATSettingInfo.
Returns:
Legal values:
S_OK : on success
E_FAIL: on failure
o GetParametersNodeInTree
public virtual HRESULT GetParametersNodeInTree(CATBoolean& oNodeDisplayed) = 0
Retrieves the "ParametersNodeInTree" parameter's value.
Role: This parameter determines if a node called "Parameters" is created to contain all Knowledgeware parameters.
Its value can be changed even after parameters have been created. The result is that the specification tree node display status will be affected.
Parameters:
oNodeDisplayed
Current "ParametersNodeInTree" parameter's value:
  • TRUE or 1 if such a node is displayed,
  • FALSE or 0 otherwise.
Returns:
S_OK if the parameter is correctly retrieved, E_FAIL otherwise.
o GetParametersNodeInTreeInfo
public virtual HRESULT GetParametersNodeInTreeInfo(CATSettingInfo* oInfo)= 0
Retrieves the state of the "ParametersNodeInTree" parameter.
Parameters:
oInfo
Address of an object CATSettingInfo.
Returns:
Legal values:
S_OK : on success
E_FAIL: on failure
o GetPublishTopologicalElements
public virtual HRESULT GetPublishTopologicalElements(CATBoolean& oTopologyAllowed) = 0
Retrieves the "PublishTopologicalElements" parameter's value.
Role: This parameter defines if topological elements (faces, edges, vertices, axes extremities) can be published.
Parameters:
oTopologyAllowed
Current "PublishTopologicalElements" parameter's value:
  • TRUE or 1 if topological elements can be used for publication,
  • FALSE or 0 otherwise.
Returns:
S_OK if the parameter is correctly retrieved, E_FAIL otherwise.
o GetPublishTopologicalElementsInfo
public virtual HRESULT GetPublishTopologicalElementsInfo(CATSettingInfo* oInfo)= 0
Retrieves the state of the "PublishTopologicalElements" parameter.
Parameters:
oInfo
Address of an object CATSettingInfo.
Returns:
Legal values:
S_OK : on success
E_FAIL: on failure
o GetRelationsNodeInTree
public virtual HRESULT GetRelationsNodeInTree(CATBoolean& oNodeDisplayed) = 0
Retrieves the "RelationsNodeInTree" parameter's value.
Role: This parameter determines if a node called "Relations" is created to contain all Knowledgeware relations (for instance formulas).
Its value can be changed even after parameters have been created. The result is that the specification tree node display status will be affected.
Parameters:
oNodeDisplayed
Current "RelationsNodeInTree" parameter's value:
  • TRUE or 1 if such a node is displayed,
  • FALSE or 0 otherwise.
Returns:
S_OK if the parameter is correctly retrieved, E_FAIL otherwise.
o GetRelationsNodeInTreeInfo
public virtual HRESULT GetRelationsNodeInTreeInfo(CATSettingInfo* oInfo)= 0
Retrieves the state of the "RelationsNodeInTree" parameter.
Parameters:
oInfo
Address of an object CATSettingInfo.
Returns:
Legal values:
S_OK : on success
E_FAIL: on failure
o GetReplaceOnlyAfterCurrent
public virtual HRESULT GetReplaceOnlyAfterCurrent(CATBoolean& oOnlyAfterCurrent) = 0
Retrieves the "ReplaceOnlyAfterCurrent" parameter's value.
Role: This parameter defines if the replace operation can only apply to components located after the current object.
Parameters:
oOnlyAfterCurrent
Current "ReplaceOnlyAfterCurrent" parameter's value:
  • TRUE or 1 if the replace operation can only apply to components located after the current object,
  • FALSE or 0 otherwise.
Returns:
S_OK if the parameter is correctly retrieved, E_FAIL otherwise.
o GetReplaceOnlyAfterCurrentInfo
public virtual HRESULT GetReplaceOnlyAfterCurrentInfo(CATSettingInfo* oInfo)= 0
Retrieves the state of the "ReplaceOnlyAfterCurrent" parameter.
Parameters:
oInfo
Address of an object CATSettingInfo.
Returns:
Legal values:
S_OK : on success
E_FAIL: on failure
o GetSurfaceElementsLocation
public virtual HRESULT GetSurfaceElementsLocation(CatPartSurfaceElementsLocation& oLocation) = 0
Retrieves the "SurfaceElementsLocation" parameter's value.
Role: This parameter determines where wireframe and surface elements are created when hybrid design is active.
This option can be changed when hybrid design mode is not active (but useless then), and also even after a document has been opened.
Parameters:
oLocation
Current "SurfaceElementsLocation" parameter's value:
  • catPartBodyLocation when elements are created within a PartBody,
  • catXGSLocation when elements are created within a G.S. or an O.G.S..
Returns:
S_OK if the parameter is correctly retrieved, E_FAIL otherwise.
o GetSurfaceElementsLocationInfo
public virtual HRESULT GetSurfaceElementsLocationInfo(CATSettingInfo* oInfo)= 0
Retrieves the state of the "SurfaceElementsLocation" parameter.
Parameters:
oInfo
Address of an object CATSettingInfo.
Returns:
Legal values:
S_OK : on success
E_FAIL: on failure
o GetTrueColorMode
public virtual HRESULT GetTrueColorMode(CATBoolean& oColorInheritanceMode) = 0
Retrieves the "ColorInheritanceMode" parameter's value.
Role: This parameter determines color inheritance mode for absorbing features in a part.
Color inheritance mode defines which mode of propagation will be used to set color on an absorbing feature. If it is valuated to 1, absorbing feature will inherit colors from all their input. If it is defined to 0, absorbing features will inherit colors from their main input only (default mode). This option can be changed even after a document has been opened.
Parameters:
oColorInheritanceMode
Current "ColorInheritanceMode" parameter's value:
  • TRUE or 1 if absorbing features inherit from all their inputs,
  • FALSE or 0 otherwise.
Returns:
S_OK if the parameter is correctly retrieved, E_FAIL otherwise.
o GetTrueColorModeInfo
public virtual HRESULT GetTrueColorModeInfo(CATSettingInfo* oInfo)= 0
Retrieves the state of the "ColorInheritanceMode" parameter.
Parameters:
oInfo
Address of an object CATSettingInfo.
Returns:
Legal values:
S_OK : on success
E_FAIL: on failure
o GetUpdateElementsRefreshed
public virtual HRESULT GetUpdateElementsRefreshed(CATBoolean& oElementsRefreshed) = 0
Retrieves the "UpdateElementsRefreshed" parameter's value.
Role: This parameter determines if elements visualization has to be refreshed individually during update tasks.
Parameters:
oElementsRefreshed
Current "UpdateElementsRefreshed" parameter's value:
  • TRUE or 1 if elements visualization is refreshed,
  • FALSE or 0 otherwise.
Returns:
S_OK if the parameter is correctly retrieved, E_FAIL otherwise.
o GetUpdateElementsRefreshedInfo
public virtual HRESULT GetUpdateElementsRefreshedInfo(CATSettingInfo* oInfo)= 0
Retrieves the state of the "UpdateElementsRefreshed" parameter.
Parameters:
oInfo
Address of an object CATSettingInfo.
Returns:
Legal values:
S_OK : on success
E_FAIL: on failure
o GetUpdateLinkedExternalReferences
public virtual HRESULT GetUpdateLinkedExternalReferences(CATBoolean& oExternalReferencesUpdated) = 0
Retrieves the "UpdateLinkedExternalReferences" parameter's value.
Role: This parameter determines if update tasks also apply to linked external references.
Parameters:
oExternalReferencesUpdated
Current "UpdateLinkedExternalReferences" parameter's value:
  • TRUE or 1 if the update tasks apply to linked external references,
  • FALSE or 0 otherwise.
Returns:
S_OK if the parameter is correctly retrieved, E_FAIL otherwise.
o GetUpdateLinkedExternalReferencesInfo
public virtual HRESULT GetUpdateLinkedExternalReferencesInfo(CATSettingInfo* oInfo)= 0
Retrieves the state of the "UpdateLinkedExternalReferences" parameter.
Parameters:
oInfo
Address of an object CATSettingInfo.
Returns:
Legal values:
S_OK : on success
E_FAIL: on failure
o GetUpdateMode
public virtual HRESULT GetUpdateMode(CatPartUpdateMode& oUpdateMode) = 0
Retrieves the "UpdateMode" parameter's value.
Role: This parameter determines how the update of a .CATPart document is conducted.
Parameters:
oUpdateMode
Current update mode:
  • catAutomaticUpdate when update is automatically launched,
  • catManualUpdate when update has to be launched manually.
Returns:
S_OK if the parameter is correctly retrieved, E_FAIL otherwise.
o GetUpdateModeInfo
public virtual HRESULT GetUpdateModeInfo(CATSettingInfo* oInfo)= 0
Retrieves the state of the "UpdateMode" parameter.
Parameters:
oInfo
Address of an object CATSettingInfo.
Returns:
Legal values:
S_OK : on success
E_FAIL: on failure
o GetUpdateStoppedOnError
public virtual HRESULT GetUpdateStoppedOnError(CATBoolean& oStoppedOnError) = 0
Retrieves the "UpdateStoppedOnError" parameter's value.
Role: This parameter determines if update tasks stop on the first detected error.
Parameters:
oStoppedOnError
Current "UpdateStoppedOnError" parameter's value:
  • TRUE or 1 if update tasks stop,
  • FALSE or 0 otherwise.
Returns:
S_OK if the parameter is correctly retrieved, E_FAIL otherwise.
o GetUpdateStoppedOnErrorInfo
public virtual HRESULT GetUpdateStoppedOnErrorInfo(CATSettingInfo* oInfo)= 0
Retrieves the state of the "UpdateStoppedOnError" parameter.
Parameters:
oInfo
Address of an object CATSettingInfo.
Returns:
Legal values:
S_OK : on success
E_FAIL: on failure

This object is included in the file: CATIMmiPartInfrastructureSettingAtt.h
If needed, your Imakefile.mk should include the module: CATMecModInterfaces

Copyright © 2003, Dassault Systèmes. All rights reserved.