All Frameworks Class Hierarchy This Framework Indexes Previous Next

GMOperatorsInterfaces Interface CATICGMBodyChecker

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

interface CATICGMBodyChecker

Class defining the operator to check a given body.

CATICGMBodyChecker follows the global frame of the topological operators.

Create it with the Create static function.
Run it.
Get the result (diagnosis).
Remove it with the Remove static function.

Method Index

o BeginningDiagnosis(): Initializes the iterator of the resulting diagnosis.
o Check(CATGeoFactory*,CATBody*,CATLONG32&,ostream&,CATBoolean&): Checks a given body.
o Create(CATGeoFactory*,CATTopData*,CATBody*): Constructs an operator that checks a body.
o Dump(ostream&): Gets all the diagnoses of this operator results after run.
o GetCheckMode(CATCGMBodyCheckMode&): Gets the active check mode of the operator.
o GetDiagnosis(CATUnicodeString&): Gets the current diagnosis of this operator results.
o GetNbDiagnoses(): Gets the number of diagnoses found after the operator run.
o NextDiagnosis(): Skips to the next diagnosis of this operator results, if any.
o Run(): Runs this operator.
o SetCheckCells(CATLISTP(CATCell)&): Sets the check cells for the operator.
o SetCheckMode(CATCGMBodyCheckMode&): Sets the new active check mode of the operator.
o SetCheckRules(CATListOfInt*&): Sets the check rules for the operator.
o Type(): Type of this operator.

Methods

o BeginningDiagnosis

public virtual BeginningDiagnosis(

)

Initializes the iterator of the resulting diagnosis.
By default, the initialization is performed once the operator runs, and this is therefore only used to read the diagnosis again.

o Check

public static Check(		`ipFactory`,
		`ipBodyToCheck`,
		`ioNumberOfSevereAnomalies`,
		`ioDetailsOfAnomalies`,
	const	`ibFullCheck`	`= FALSE`)

Checks a given body.
The body to check can contain several domains. All the cells of relevant type from all domains will be checked for the active body checker rules.

Parameters:

ipFactory: The pointer to the factory of the body to check.
ipBodyToCheck: The pointer to the body to check. It can contain several domains. In this case, the operator processes all the cells from all the domains.
ioNumberOfSevereAnomalies: Total number of severe anomalies found during check operation.
ioDetailsOfAnomalies: The details of severe anomalies found during check operation.
ibFullCheck: CATBoolean(0) indicates that body check operator would run in "Light" check mode.
CATBoolean(1) indicates that body check operator would run in "Full" check mode.

Returns:

The result of the check operation.
Legal values: TRUE if no errors were found, FALSE otherwise.

o Create

public static Create(		`ipFactory`,
		`ipData`,
		`ipBodyToCheck`)

Constructs an operator that checks a body.
The body to check can contain several domains. All the cells of relevant type from all domains will be checked for the active body checker rules.

Parameters:

ipFactory: The pointer to the factory of the body to check.
ipData: The pointer to the data defining the software configuration and the journal. If the journal inside ipData is NULL, it is not filled.
ipBodyToCheck: The pointer to the body to check. It can contain several domains. In this case, the operator processes all the cells from all the domains.

Returns:

[out, IUnknown#Release] The pointer to the created operator. To remove the operator from memory, use Release method after use.

o Dump

public virtual Dump( ioOutput)

Gets all the diagnoses of this operator results after run.

Parameters:

ioOutput: The details of severe anomalies found during check operation.

o GetCheckMode

public virtual GetCheckMode( oCheckMode)

Gets the active check mode of the operator.
Note that the default check mode of the operator is Light mode.

Parameters:

oCheckMode: The active check mode of the operator.

Returns:

The result of the operation.
Legal values: TRUE if succeeded, FALSE otherwise.

o GetDiagnosis

public virtual GetDiagnosis( oDiagnosisString)

Gets the current diagnosis of this operator results.

Parameters:

oDiagnosisString: The reference to the string to be filled out with diagnosis details.

Returns:

The result of the operation.
Legal values: TRUE if succeeded, FALSE otherwise.

o GetNbDiagnoses

public virtual GetNbDiagnoses(

)

Gets the number of diagnoses found after the operator run.

Returns:: The count of diagnoses found.

o NextDiagnosis

public virtual NextDiagnosis(

)

Skips to the next diagnosis of this operator results, if any.
After BeginningDiagnosis, it skips to the first diagnosis.

Returns:

The existence of the next diagnosis.
Legal values:

TRUE: if there is a diagnosis
FALSE: if no more diagnosis.

o Run

public virtual Run(

)

Runs this operator.

Returns:: Legal values: 1 if ok, 0 if failed.

o SetCheckCells

public virtual SetCheckCells( ilsCheckCells)

Sets the check cells for the operator.
Use this method to restrict the check operation to certain cells of interest.

Parameters:

ilsCheckCells: The list of cells to be used for check (a subset from ipBodyToCheck, i.e. body being checked).

Returns:

The result of the operation.
Legal values: TRUE if succeeded, FALSE otherwise.

o SetCheckMode

public virtual SetCheckMode( const iCheckMode)

Sets the new active check mode of the operator.
Note that the default check mode of the operator is Light mode.

Parameters:

iCheckMode: The new active check mode of the operator to be set.

Returns:

The result of the operation.
Legal values: TRUE if succeeded, FALSE otherwise.

o SetCheckRules

public virtual SetCheckRules( iplsCheckRuleIDs)

Sets the check rules for the operator.
Use this method to restrict the check operation to certain rules of interest.
One can use this method and then set the check mode to CATICGMBodyChecker::BodyChkModeLightPlus, in which case, the operator checks for rules set by this method in addition to Light rules.

Parameters:

iplsCheckRuleIDs: The list of check rule IDs of type CATCGMBodyCheckerRuleID to be checked.

Returns:

The result of the operation.
Legal values: TRUE if succeeded, FALSE otherwise.

o Type

public virtual Type(

)

Type of this operator.

Returns:: Legal values: >1.

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