GMModelInterfaces Interface CATTopObject

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

interface CATTopObject

Base interface representing a CATBody or a CATCell.

Method Index

o AddDomainWithLocation(CATDomain*,CATLocation): Adds a CATDomain to this CATTopObject.
o GetDomain(CATLONG32,CATLocation*): Returns the iNum-th CATDomain of this CATTopObject.
o GetNbDomains(): Returns the number of CATDomains of this CATTopObject.
o HasInfiniteGeometry(): Test whether this CATTopObject can be considered as infinite.
o RemoveDomain(CATDomain*,CATBoolean): Removes a CATDomain from this CATTopObject.

Methods

o AddDomainWithLocation

public virtual AddDomainWithLocation(		`iDomain`,
		`iLocation`)

Adds a CATDomain to this CATTopObject.
For bodies, volumes and faces only.

Parameters:

iDomain: The pointer to the domain to add.
iLocation: The location of the domain to bound this.

o GetDomain

public virtual GetDomain(		`iNum`,
		`oLocation`	`=NULL` )

Returns the iNum-th CATDomain of this CATTopObject.

Parameters:

iNum: The domain number starting at 1.
oLocation: The pointer to the corresponding CATLocation. If NULL in input, this is not output.

Returns:

The pointer to the iNum-th CATDomain.

o GetNbDomains

public virtual GetNbDomains(

)

Returns the number of CATDomains of this CATTopObject.

Returns:: The number of domains.

o HasInfiniteGeometry

public virtual HasInfiniteGeometry(

)

Test whether this CATTopObject can be considered as infinite.

Returns:: The infinity status of this.
Legal values: TRUE, if this contains (or is) an infinite cell or has a bounding box outside ModelSize, FALSE if it is finite topology.

o RemoveDomain

public virtual RemoveDomain(		`iDomainToDetach`,
		`iRemoveFromFactory`	`= FALSE` )

Removes a CATDomain from this CATTopObject.
For bodies, volumes and faces only.

Parameters:

iDomainToDetach

The pointer to the domain to detach from this. The domain still remains in the CATGeoFactory, but is not a boundary of this anymore in default mode.

iRemoveFromFactory

The action on the detached domain iDomainToDetach. Dedicated to the case where no more CATTopObject refers to iDomainToDetach.
Legal values:

FALSE: the iDomainToDetach remains in the factory
TRUE: the iDomainToDetach is removed from the factory with RemoveDependancies management

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