All Frameworks Class Hierarchy This Framework Indexes Previous Next

GMModelInterfaces Interface CATICGMTopOperator

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

interface CATICGMTopOperator

Abstract class for the topological operators.

The topological operators follow the use frame of all operator and satisfy to the smart mechanism: the input bodies are not modified. A new resulting body is created, possibly sharing data with the input ones. They are not streamable. To use a topological operator:

Create it with the CATCGMCreateTopXxx global methods
Tune it with appropriate options, using the SetXxx methods.
Run it
Get the result with the GetResult method. If you do not want to keep the resulting body, use the method to remove it from the geometric factory.
Release the operator with the Release method after use.

Method Index

o GetFailsafeDiagnosis(CATLISTP(CATCGMDiagnosis)&): If Failsafe mode is active, this method allows to retrieve all failure diagnosis after Run.
o GetFailsafeMode(): To be used to know if Failsafe mode is active.
o GetFreezeMode(): Returns the mode in which the resulting body is created.
o GetInputObjectsForJournal(CATBoolean&,CATLISTP(CATICGMObject)&,CATTopCheckJournalType,CATGeometricType): Returns the input objects used by this CATICGMTopOperator to create its journal.
o GetJournal(): Returns a pointer to the topological journal associated with this CATICGMTopOperator.
o GetResult(): Returns a pointer to the resulting body.
o GetResult(CATCGMJournalList*): Returns the pointer to the resulting body.
o SetFailsafeMode(CATBoolean): Activates Failsafe mode : in the case of failure, instead of throwing an error, a partial or non-optimal result is returned.
o SetFreezeMode(CATBodyFreezeMode): Defines the state of the resulting body.

Methods

o GetFailsafeDiagnosis

public virtual GetFailsafeDiagnosis( oFailsafeDiagnosis)

If Failsafe mode is active, this method allows to retrieve all failure diagnosis after Run. Failsafe mode should be activated using SetFailsafeMode method before Run.

Parameters:

oFailsafeDiagnosis: The list of failure diagnosis stored during the operation.
All diagnosis should be destroyed by the caller using Release.

o GetFailsafeMode

public virtual GetFailsafeMode(

)

To be used to know if Failsafe mode is active.

Returns:

Legal values:

FALSE: Failsafe mode is not active.
TRUE: Failsafe mode is active.

o GetFreezeMode

public virtual GetFreezeMode(

)

Returns the mode in which the resulting body is created.

Returns:: The smart mode.

o GetInputObjectsForJournal

public virtual GetInputObjectsForJournal(	`oSucceeded`,
	`oObjects`,
	`iCopy_Or_Not`	`= CATTopCheckCopy`,
	`iTypeOfObjects`	`= CATBodyType`)

Returns the input objects used by this CATICGMTopOperator to create its journal.

Parameters:

oSucceeded

This returned value tells whether this CATICGMTopOperator actually defined its journal inputs or not. If FALSE, the content of oObjects should not be relied on.

oObjects

The list of requested inputs.

iCopy_Or_Not

The copy status of requested input objects.
Legal values:

CATTopCheckCopy
CATTopCheckNoCopy
CATTopCheckNeutral

iTypeOfObjects

The geometric type of the requested input objects.

o GetJournal

public virtual GetJournal(

)

Returns a pointer to the topological journal associated with this CATICGMTopOperator.
Only available if a journal was given at the operator creation.

Returns:: The pointer to the journal of the operation.

o GetResult

public virtual GetResult(

)

Returns a pointer to the resulting body. The body is frozen and completed if CATBodyFreezeOn is active (default mode).

Returns:: The pointer to the resulting body. Use if you do not want to keep it.

o GetResult

public virtual GetResult( iJournal)

Returns the pointer to the resulting body. The pointer to the journal of the operation.

Parameters:

iJournal: The pointer to the journal to fill.

Returns:

The pointer to the resulting body. If you do not want to keep it, use the method to remove it from the geometric factory.

o SetFailsafeMode

public virtual SetFailsafeMode( iFailsafeMode)

Activates Failsafe mode : in the case of failure, instead of throwing an error, a partial or non-optimal result is returned.
Please notice that not all operators support this mode. By default an operator doesn't support Failsafe, except where it is explicitly declared.
This option is not activated by default.
The error diagnosis are stored by the operator, and can be retrieved via GetFailsafeDiagnosis method.

Parameters:

iFailsafeMode

Legal values:

FALSE: Failsafe mode not active: if a failure occurs, an error is thrown.
TRUE: Failsafe mode active: if a failure occurs, a partial result is returned.

o SetFreezeMode

public virtual SetFreezeMode( iOnOrOff)

Defines the state of the resulting body.

Parameters:

iOnOrOff: The state of the resulting body.

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