CATMecModExtendItf Interface CATIMmiProcReport

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

interface CATIMmiProcReport

Interface to create a generic naming scope with a procedural report.
Role:This advanced interface is useful to create the genering naming scope of a new geometrical feature.

The scope is the link between the geometrical feature and its topology result (CATBody). It enables you to name in a stable way the CATCells of the CATBody result. Each scope contains nodes, one for each followed cells. It is the responsability of the feature to ask the generation of its own scope. This task is done in the following methods:

• : to build the topology result of the feature
• : to build the topology associated with the form of the feature. This method is only useful for the form features (pad, pocket, shaft, groove stiffener,...)

However, the feature has only an indirect control on how its scope is generated. There are two means to create it wich depends on the type of the geometrical feature:

• The feature has no geometrical feature as input specification

In this case the feature is a datum, a geometrical feature without historic. The interface must be used.

• Otherwise

The topology of the feature will reuse the topology of the input features. As the geometry is based on the cell reusage, the scope creation will reuse the nodes of the input feature scopes. Once the topological operations have been done, the topological journal will be used to create the feature's scope. This operation is possible thanks to a procedural report. This interface allows you to control the usage of this report.

1. Create the procedural report with a call,
2. Run the topological operator,
3. Store the procedural report with a call or if a problem occurs in the Build/BuildShape methods use the call.

Refer to the CAA Encyclopedia articles entitled "Integrating a New Geometrical Feature in the Update Mechanism" and "Generic Naming Overview" for details about the usage of this interface.

Method Index

o CreateProcReport(CATListValCATBaseUnknown_var&,CATListOfCATUnicodeString&,int,CATIMmiMechanicalFeature_var&)

Creates a report.

o DeleteProcReport()

Deletes the current report.

o GetCGMJournalList(CATCGMJournalList*&)

Reads the topological journal.

o GetGeoFactoryFromFeature(CATGeoFactory_var&)

Gets the geometrical factory.

o InactivateResult(int)

Inactivates the result of a geometrical feature.

o InsertCGMJournalList(CATCGMJournalList*)

Inserts a new topological journal.

o SetProcTranslateRule(CATMfProcTranslateRule)

Adds a rule on the journal.

o StoreProcReport(CATBody_var&,CATMfStoreProcReportType,int)

Stores the report.

Methods

Creates a report.
Role:This method creates the procedural report of the feature.
For example, to create the report of a pad built on Sketch.2 with a bottom face until the FSur.1:

 iSpecs[1]=Sketch.2, iKeys[1]=MfKeyExtrudedFrom, 
 iSpecs[2]=FSur.1, iKeys[2]=MfKeyBottom.
 

Parameters:

iInputSpecificationList

The list of specifications must contain the geometrical features whose scopes are needed to build the scope of the current feature. This list can be empty.

iKeyList

The list of key must have the same count of elements as the list of specifications. The default value is MfKeyNone. A different value will tell to the V5 mechanism to replace the historical relationship of a node with a user info.
Legal values:

• MfKeyNone,
• MfKeyTop,
• MfKeyBottom,
• MfKeyExtrudedFrom

iBoolOper

The integer value indicates which feature will own the generated scope. It is the same value as used in the

method.
Legal values:

• 0, when the scope should be associated with the feature itself:

For the contextual feature inside the Build method or the form feature inside the BuildShape method. Refer to the interface for details about form and contextual features.
• 1, when the scope should be associated with the ResultOUT attribute of a shape feature.

For the form feature inside the Build method. Refer to the interface for detail about the ResultOUT attribute.

iReferenceFeature

The reference feature to use only for pattern. Lets the default value, NULL_var.

Deletes the current report.
Role:This method enables you to clean the internal data created during the procedural report. You must use this method if an error occurs during the Build/BuildShape method.

Reads the topological journal.
Role:This method returns the object useful to create the CATTopData class instance needed in topological operator.
Lifecycle rules deviation:Do not release the returned value.

Gets the geometrical factory.
Role:This method gets the geometrical factory of the feature.

It is the factory which allows you to create the topological result of the geometrical feature. A geometrical feature is a mechanical feature for which a topological object can be associated with its result. This topological object is a .

Parameters:

oGeoFactory

The geometrical factory which will contain the topological result of the geometrical feature.

Returns:

S_OK when succeeded
E_FAIL if the factory has not been found.

Inactivates the result of a geometrical feature.
Role:This method must be used when the feature is deactivated. In other words when the returns 1. But you have to take into account of this flag only for a feature deriving either from GSMGeom or from GeometricalElement3D. In the case of a feature deriving either from the MechanicalFormFeature or from MechanicalContextualFeature, the Build method in not called.

Parameters:

iBoolOper

The integer value indicates which feature will own the generated scope. It is the same value as used in the

method.
Legal values:

• 0, when the scope should be associated with the feature itself:

For the contextual feature inside the Build method or the form feature inside the BuildShape method. Refer to the interface for details about form and contextual features.
• 1, when the scope should be associated with the ResultOUT attribute of a shape feature.

For the form feature inside the Build method. Refer to the interface for detail about the ResultOUT attribute.

Throws:

Inserts a new topological journal.

Parameters:

iNewJournal

New topological journal.

Adds a rule on the journal.
Role:This method must be used to add a rule to be applied when creating the nodes at the end of the build. It should be invoqued before calling the method. It allows managing the behavior of the created elements in the selection process. See CAA articles for more information.

Parameters:

Rule

The rule to be applied.

Returns:

S_OK when succeeded
E_FAIL if the rule could not be set.

Stores the report.

Parameters:

iBody

The result body of the topological operator.

iType

Legal values:
Copy: the nodes of the previous scope which are not modified by the operation are copied in the current scope,
NoCopy: the nodes of the previous scope which are not modified by the operation are not copied in the current scope.

iBoolOper

The integer value indicates which feature will own the generated scope. It is the same value as used in the

method.
Legal values:

• 0 when the scope should be associated with the feature itself:

For the contextual feature inside the build method or the form feature inside the BuildShape method. Refer to the interface for details about form and contextual features.
• 1 when the scope should be associated with the ResultOUT feature of a shape feature.

For the form feature inside the Build method. Refer to the interface for detail about the ResultOUT feature.

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