All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

ObjectModelerBase Class CATDocumentIntegrityServices

CATDocumentIntegrityServices
 

Usage: you must use this class as is. You should never derive it.


public class CATDocumentIntegrityServices

Services to check data integrity within a document.
Role: Provide support to know if a given document contains CATDUA errors


Method Index


o CheckDataIntegrity(CATDocument*,int,int,CATListOfInt&,CATListOfCATUnicodeString&,CATIReporter*&)
Test if a given document contains CATDUA errors
Role: Provide support to know if a given document contains CATDUA errors

Methods


o CheckDataIntegrity
public static HRESULT CheckDataIntegrity(CATDocument* iDoc,
int iRepairMode,
int iSelectMode,
CATListOfInt& ilstSelectedCriteriaType,
CATListOfCATUnicodeString& ilstSelectedCriteria,
CATIReporter*& oReporter)
Test if a given document contains CATDUA errors
Role: Provide support to know if a given document contains CATDUA errors
Parameters:
iDoc
[in] The given document to check.
iRepairMode
[in] The given RepairMode to process.
    0: To activate Check action (default value).
    1: To activate Clean action.
iSelectMode
[in] The given SelectMode to process.
    0: "AllBut" mode: All errors available on site except the one specified in the following criteria are applied.
    1: "NonePlus" mode (default value): Only errors specified in the following criteria are applied.
ilstSelectedCriteriaType
[in] List of criteria type that has to be applied to ilstSelectedCriteria argue.
    Possible values are:
    0: Criteria is a ErrorName filter (default value).
    1: Criteria is a Severity filter.
    2: Criteria is a Domain filter.
    3: Criteria is a Keyword filter.
ilstSelectedCriteria
[in] List of criteria that has to be taken into account to specify the list of errors to be considered while CATDUA check/clean process.
    Possible values are:
  • When the correspondant Criteria type is a "ErrorName" filter (=0):
      Error to process filter defines a list of error, identified with their names, to process or not, depending on the iSelectMode argue.
      ex: UAV_11, LIF_3, DOC_4, CST_4 ...
      See the complete list of possible error in the CATDUA documentation error code table.
      All the value are not case sensitive: you can write "Cst_4", "DOc_4", "lif_3" ...
  • When the correspondant Criteria type is a "Severity" filter (=1):
      1: Severity One: Cleaning action may lead to data deletion.
      2: Severity Two: Cleaning action may lead to data modification (without deletion).
      3: Severity Three: Unimportant error. Cleaning action without huge impact on data.
  • When the correspondant Criteria type is a "Domain" filter (=2):
      Error to process filter defines a list of error, identified with their Domain, to process or not, depending on the iSelectMode argue.
      ex: Drafting, Sketcher, MechanicalDesign, ...
      The complete list of available Domains is defined in the CATCheckReport.CATNls file.
        3DFunctionalTolerancingAndAnnotation
        Aggregation
        Analysis
        AssemblyDesign
        BodyinWhite
        Camera
        Catalog
        DMUFitting
        DMUKinematics
        DMUNavigator
        Drafting
        Electrical
        EquipmentandSystemsArrangement
        FunctionalModeler
        GenerativeDrafting
        GenerativeShapeDesign
        GenericNaming
        Geometry
        Knowledge
        Manufacturing
        Material
        MechanicalDesign
        MechanicalModeler
        MoldDesign
        Numbering
        ObjectModeler
        PartDesign
        PlantShipModeler
        ProductStructure
        Robotics
        SheetMetal
        Sketcher
        SketcherModeler
        SpecsModeler
        TopologicalObjects
        V4V5integration
      All the value are not case sensitive: you can write "MECHANICALDESIGN", "mechanicaldesign", ...
  • When the correspondant Criteria type is a "Keyword" filter (=3):
      Error to process filter defines a list of error, identified with keyword, to process or not, depending on the iSelectMode argue.
        Specification: List of errors dealing with the specifications
        Geometry: List of errors dealing with geometry only
        Update: List of errors impacting the Update status of the document
        PCS: List of errors impacting the PCS and performance result
        GhostLinks: List of errors dealing with Ghost Link
      The complete list of available Keywords is defined in the CATCheckReport.CATNls file.
      All the value are not case sensitive: you can write "UPDATE", "pcs", ...

  • When no criteria is defined (empty list), all the errors available on the site are automatically processed while CATDUA check/clean process.
oReporter
[out] Pointer allowing to retrieve all information regarding detected errors after processing the input document.
Use CATIReporter#GetListReporterInfo to retrieve all errors.
The pointer has to be released after use by the caller.
Returns:
S_OK if everything goes well, otherwise E_FAIL.

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

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