GMModelInterfaces CATCGMDiagnosis

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

public class CATCGMDiagnosis

Class for the management of the diagnosis raised during a topological operation.
A diagnosis is an error that also retrieves two lists of body pointers:

• The list of the pointers to the created bodies defining the topological location of the error
• The list of the pointers to the created bodies defining the topological neighborhood of the error.

Constructor and Destructor Index

o ~CATCGMDiagnosis()

Declares that the class CATCGMDiagnosis is an error class which derives from CATTopOpInError.

Method Index

o Contains(CATBody*,CATCGMDiagnosis::CATListType&)

Tests whether a body is referenced inside one of the lists of this diagnosis.

o GetLocation(CATLISTP(CATBody)&,CATLISTP(CATBody)&,CATBoolean)

Retrieves the topological location of this error.

o GetLocationWithInputBodies(CATLISTP(CATBody)&,CATLISTP(CATBody)&,CATLISTP(CATBody)&,CATBoolean)

Retrieves the topological location of this error.

o IsEmpty(CATBoolean&)

Tests whether this diagnosis references bodies.

o SetLocation(CATLISTP(CATBody)&,CATLISTP(CATBody)&,CATBoolean)

Sets the topological location of this error.

o SetLocationWithInputBodies(CATLISTP(CATBody)&,CATLISTP(CATBody)&,CATLISTP(CATBody)&,CATBoolean)

Sets the topological location of this error.

Enumerated Type Index

o CATListType

Defines the list types.

Constructor and Destructor

Declares that the class CATCGMDiagnosis is an error class which derives from CATTopOpInError.

Methods

Tests whether a body is referenced inside one of the lists of this diagnosis.

Parameters:

iBodyTest

The pointer to the body to test.

ioListType

The list inside which the body is referenced.

Retrieves the topological location of this error.

Parameters:

ioLocationList

The list of the pointers to the bodies defining the location of the error. Once read, the bodies of the list must be managed by the caller. In particular, they must be removed (

) after use by the caller. However, if the method GetLocation is not called, the CATCGMDiagnosis destructor removes them.

ioContextList

The list of the pointers to the bodies defining the topological neighborhood of the error. Once read, the bodies of the list must be managed by the caller. In particular, they must be removed (

) after use by the caller. However, if the method GetLocation is not called, the CATCGMDiagnosis destructor removes them.

iReadOnly

Dedicated to the case where you just want to read.
Legal values: FALSE if the bodies of the list must be managed by the caller (default mode), TRUE otherwise.

Retrieves the topological location of this error.

Parameters:

ioLocationList

The list of the pointers to the bodies defining the location of the error. Once read, the bodies of the list must be managed by the caller. In particular, they must be removed (

) after use by the caller. However, if the method GetLocation is not called, the CATCGMDiagnosis destructor removes them.

ioInputList

The list of the input bodies containing the cells of the location bodies, if it was specified. If input list was specified during diagnosis creation, it has the same size as ioLocationList. The n-th body of ioLocationList is associated to the n-th body of ioInputList. If the input list was not specified, this list is empty.

ioContextList

The list of the pointers to the bodies defining the topological neighborhood of the error. Once read, the bodies of the list must be managed by the caller. In particular, they must be removed (

) after use by the caller. However, if the method GetLocation is not called, the CATCGMDiagnosis destructor removes them.

iReadOnly

Dedicated to the case where you just want to read.
Legal values: FALSE if the bodies of the list must be managed by the caller (default mode), TRUE otherwise.

Tests whether this diagnosis references bodies.

Parameters:

ioYesOrNo

The result of the test.
Legal values: TRUE if empty, FALSE if there is at least one body referenced.

Sets the topological location of this error.

Parameters:

iLocationList

The list of the pointers to the bodies defining the location of the error. To be called inside an operator as an help for the caller.

iContextList

The list of the pointers to the bodies defining the topological neighborhood of the error. To be called inside an operator as an help for the caller.

iAppendOnly

Dedicated to the case where previous lists of pointers to the bodies were not empty.
Legal values: FALSE if the previous lists of pointers to the bodies are forgotten, TRUE if the previous lists of pointers to the bodies are kept.

Sets the topological location of this error.

Parameters:

iLocationList

The list of the pointers to the bodies defining the location of the error. To be called inside an operator as an help for the caller.

iInputList

The list of the pointers to the input bodies containing the cells of the location bodies. To be called inside an operator as an help for the caller. This list and iLocationList should have the same size.

iContextList

The list of the pointers to the bodies defining the topological neighborhood of the error. To be called inside an operator as an help for the caller.

iAppendOnly

Dedicated to the case where previous lists of pointers to the bodies were not empty.
Legal values: FALSE if the previous lists of pointers to the bodies are forgotten, TRUE if the previous lists of pointers to the bodies are kept.

Enumerated Types