All Frameworks Class Hierarchy This Framework Indexes Previous Next

CATPartUseItf Interface CATIPdgUsePrtSimpleLimit

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

interface CATIPdgUsePrtSimpleLimit

Interface which provides a basic limit behaviour to a limit feature.
Role: Some features contain one or several limit components which describe how their own shape is limited.
A simple limit allows users to set specifications and to retrieve associated data deduced from those specifications. Offsets are not managed.

See also:: , , ,

Method Index

o ClearData(): Releases the data associated to the specifications.
o ExtractData(): Computes the data associated to the specifications.
o GetExtentType(): Returns the limit type specification.
o GetInit(): Returns the limiting element specification.
o GetInitGeom(CATGeometry_var&): Gets the geometrical limiting element associated to the specifications.
o GetInitGeomList(ListPOfCATCell&): Gets the geometrical limiting elements associated to the specifications.
o GetLimitType(CATTopLimitType&): Gets the topological limit type associated to the specifications.
o GetNamingSpec(CATBaseUnknown_var&): Gets the specification used to create the scope associated to the feature.
o GetPropagGeom(CATGeometry_var&): Gets the geometrical element used for propagation associated to the specifications.
o GetPropagType(CATTopPropagationType&): Gets the topological propagation type associated to the specifications.
o SetExtentType(int): Sets the limit type specification.
o SetInit(CATBaseUnknown_var): Sets the limiting element for the catUpToPlaneLimit and catUpToSurfaceLimit types.

Methods

o ClearData

public virtual ClearData(

)

Releases the data associated to the specifications.
Role: After a call to this method, the computed data are released and not available anymore.

o ExtractData

public virtual ExtractData(

)

Computes the data associated to the specifications.
Role: These data should be needed to build topological operators or scopes associated to the feature containing the limit.

o GetExtentType

public virtual GetExtentType(

)

Returns the limit type specification.

Returns:: The limit type.

o GetInit

public virtual GetInit(

)

Returns the limiting element specification.

Returns:: The limiting element.

o GetInitGeom

public virtual GetInitGeom( ohInitGeom)

Gets the geometrical limiting element associated to the specifications.
Precondition: The data must have been computed with ExtractData() before calling this method.
Postcondition: Do not forget to release the data with ClearData() after reading.

Parameters:

ohInitGeom: The geometrical limiting element.

o GetInitGeomList

public virtual GetInitGeomList( oInitGeomList)

Gets the geometrical limiting elements associated to the specifications.
Precondition: The data must have been computed with ExtractData() before calling this method.
Postcondition: Do not forget to release the data with ClearData() after reading.

Parameters:

oInitGeomList: The geometrical limiting elements.

o GetLimitType

public virtual GetLimitType( oLimitType)

Gets the topological limit type associated to the specifications.
Precondition: The data must have been computed with ExtractData() before calling this method.
Postcondition: Do not forget to release the data with ClearData() after reading.

Parameters:

oLimitType: The topological limit type.

o GetNamingSpec

public virtual GetNamingSpec( ohNamingSpec)

Gets the specification used to create the scope associated to the feature.
Precondition: The data must have been computed with ExtractData() before calling this method.
Postcondition: Do not forget to release the data with ClearData() after reading.

Parameters:

ohNamingSpec: The specification used to create scopes.

o GetPropagGeom

public virtual GetPropagGeom( ohPropagGeom)

Gets the geometrical element used for propagation associated to the specifications.
Precondition: The data must have been computed with ExtractData() before calling this method.
Postcondition: Do not forget to release the data with ClearData() after reading.

Parameters:

ohPropagGeom: The geometrical element used for propagation.

o GetPropagType

public virtual GetPropagType( oPropagType)

Gets the topological propagation type associated to the specifications.
Precondition: The data must have been computed with ExtractData() before calling this method.
Postcondition: Do not forget to release the data with ClearData() after reading.

Parameters:

oPropagType: The topological propagation type.

o SetExtentType

public virtual SetExtentType( const iType)

Sets the limit type specification.

Parameters:

iType: The limit type.
Legal values: They are provided with the CatLimitMode enum.
Prismatic elements and holes are limited with surfaces or offset values. The CatLimitMode enum lists appropriate values to set this property.
- catOffsetLimit: The shape is limited with an offset value.
- catUpToNextLimit: The shape is limited with the next boundary encountered in its mechanical body.
- catUpToLastLimit: The shape is limited with the last boundary encountered in its mechanical body.
- catUpToPlaneLimit: The shape is limited with a selected plane.
- catUpToSurfaceLimit: The shape is limited with a selected surface.
- catUpThruNextLimit: The shape is limited with the next boundary encountered and always removes material.

o SetInit

public virtual SetInit( const ihInit_input)

Sets the limiting element for the catUpToPlaneLimit and catUpToSurfaceLimit types.

Parameters:

ihInit: The limiting element specification.
For the catUpToPlaneLimit type, it must be a plane feature or a planar FSur feature (CATIMfFsur).
For the catUpToSurfaceLimit type, it must be a face feature.
If this face belongs to some surfacic geometry, it must be a FSur feature. Then the entire surface is used to limit the shape.
If it is a face of a volume, it must be a RSur feature (CATIMfRsur) which belongs to the body in which the limited feature is created. In this case, the limiting surface is defined by a propagation on the surface of the body starting from the initial face.

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