All Frameworks Class Hierarchy This Framework Indexes Previous Next

CATMecModUseItf Interface CATIShapeFeatureBody

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

interface CATIShapeFeatureBody

Interface to manage the procedural view of solid features within a Body.
Role: A solid feature (See is a 3D geometrical feature that can be aggregated by a a Solid Body or a Hybrid Body. This aggregation should be done using interface that ensures the procedural build of the Body.

The first methods of this interface enables you to retrieve data on the solid feature which are used for the build of the Body and the solid feature itself:

The ResultIN and the ResultOUT attributes of the solid feature

These are specific attributes used to manage links between solid features within a procedural design.

The ResultOUT attribute value of the a solid feature will be the value of the ResultIN attribute of its next solid.

The two methods to retrieve these attributes are and

The topology (CATBody) associated with these attributes

The dedicated methods are and

The CATBody associated with the form of the solid

The method is interesting for the form feature. For those features, this method returns the topological object which represents the form of the feature, also called footprint: a cylinder for the Hole feature for example. This topology is built by the method.

The four last methods (from to enable you to browse the procedural design of the aggregating Body.

Method Index

o GetBodyIN(CATClassId,CATListValCATBaseUnknown_var&): Returns the topological result associated with the ResultIN attribute.
o GetBodyINAttributes(CATListValCATBaseUnknown_var&): Returns the ResultIN attribute.
o GetBodyOUT(CATClassId,CATListValCATBaseUnknown_var&): Returns the topological result associated with the ResultOUT attribute.
o GetNextShape(CATIShapeFeatureBody_var&): Returns the solid feature following the current feature in the procedural view.
o GetPreviousShape(CATIShapeFeatureBody_var&): Returns the solid feature prior to the current feature in the procedural view.
o GetResultOUT(CATIMmiMechanicalFeature_var&): Returns the ResultOUT attribute value.
o GetShape(CATClassId,CATListValCATBaseUnknown_var&): Returns the topology directly associated with the solid feature.
o ListNextShapeFeatures(CATLISTV(CATIMmiMechanicalFeature_var)&): Returns all the solid features following the current feature in the procedural view.
o ListPreviousShapeFeatures(CATLISTV(CATIMmiMechanicalFeature_var)&): Returns all the solid features prior to the current feature in the procedural view.

Methods

o GetBodyIN

public virtual GetBodyIN(		`iInterfaceName`,
		`oBodyIN`)

Returns the topological result associated with the ResultIN attribute.
Role: This method returns a list with only one element, the CATBody associated with the ResultIN feature.

Parameters:

iInterfaceName: [in]
Legal values: Use CATBody as interface name.
oBodyIN: [out] The input body of the solid feature.

Returns:

S_OK: succefully return the body in
E_FAIL: failed to return the body in

o GetBodyINAttributes

public virtual GetBodyINAttributes( oBodyInAttributes)

Returns the ResultIN attribute.
Role: This method returns a list with only one element, the ResultIN attribute.

Parameters:

oBodyInAttributes: [out] the ResultIN attribute.

Returns:

S_OK: succefully return the attribute
E_FAIL: failed to return the attribute

o GetBodyOUT

public virtual GetBodyOUT(		`iInterfaceName`,
		`oBodyOut`)

Returns the topological result associated with the ResultOUT attribute.

Parameters:

iInterfaceName: [in]
Legal values: Use CATBody as interface name.
oBodyOut: [out] a list with only one element, the CATBody associated with the ResultOUT feature.

Returns:

S_OK: succefully return the topological result
E_FAIL: failed to return the topological result

o GetNextShape

public virtual GetNextShape( oNextShape)

Returns the solid feature following the current feature in the procedural view.

Parameters:

oNextShape: [out] The next shape feature.

Returns:

S_OK: succefully return the next shape
E_FAIL: failed to return the next shape

o GetPreviousShape

public virtual GetPreviousShape( oPreviousShape)

Returns the solid feature prior to the current feature in the procedural view.

Parameters:

oPreviousShape: [out] The previous shape feature.

Returns:

S_OK: succefully return the previous shape
E_FAIL: failed to return the previous shape

o GetResultOUT

public virtual GetResultOUT( oResultOut)

Returns the ResultOUT attribute value.
Role:This methods returns the internal feature aggregated by the solid feature that holds its topological result. To retrieve this topological result, a CATBody, you have two means:

on the returned value
Retrieve the first element in the list returned by the method

Parameters:

oResultOut: [out] the ResultOUT of the solid feature.

Returns:

S_OK: succefully return the ResultOUT
E_FAIL: failed to return the ResultOUT

o GetShape

public virtual GetShape(		`iInterfaceName`,
		`oShape`)

Returns the topology directly associated with the solid feature.
Role:This method concerns Form features, for which there is an intermediate Shape, also called footprint. The method is equivalent to the method applied on the solid feature.

Parameters:

iInterfaceName: [in]
Legal values: Use CATBody as interface name.
oShape: [out] The shape of the feature.

Returns:

S_OK: succefully return the shape
E_FAIL: failed to return the shape

o ListNextShapeFeatures

public virtual ListNextShapeFeatures( oNextShapeFeatures)

Returns all the solid features following the current feature in the procedural view.

Parameters:

oNextShapeFeatures: [out] The list of next shape features

Returns:

S_OK: succefully return the list
E_FAIL: failed to return the list

o ListPreviousShapeFeatures

public virtual ListPreviousShapeFeatures( oPreviousShapeFeatures)

Returns all the solid features prior to the current feature in the procedural view.

Parameters:

oPreviousShapeFeatures: [out] The list of previous shape features

Returns:

S_OK: succefully return the list
E_FAIL: failed to return the list

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