CATMecModUseItf Interface CATIMmiUseSolidInsertion

Usage: you can reimplement this interface by deriving the supplied CATMmrUseSolidInsertionAdapt adapter class.


interface CATIMmiUseSolidInsertion

Interface to insert and reorder a solid feature into a procedural body.
Role: A procedural body, see the interface, is a body which contains solid features involved in the procedural view of the body. A solid feature contributes to the global topological result of the federating body in which it is instanciated. It is plugged to a "spine" and is automatically involved in a boolean operation with the previous solid feature. The interface enables you to retrieve the result of this procedural body.
This interface is available for the features which can be set in a procedural body. It enables you to:

BOA information: this interface CAN be implemented using the BOA (Basic Object Adapter). To know more about the BOA, refer to the CAA Encyclopedia home page. Click Middleware at the bottom left, then click the Object Modeler tab page. Several articles deal with the BOA.


Method Index


o InsertFeature(CATIMmiMechanicalFeature_var&)
Inserts a solid feature into a procedural body.
o ReorderFeature(CATIMmiMechanicalFeature_var&)
Relocates a solid feature in a procedural body.

Methods


o InsertFeature
public virtual InsertFeature( const iDestination)
Inserts a solid feature into a procedural body.
Role:This method is used to insert a solid feature into a procedural body. If the feature already exists in a Body or Solid Body, use the method to move it.
Parameters:
iDestination
The place where the feature will be inserted depends on the factors described below:
  • The feature is a Body or Solid Body: the feature is set at the first position in the Body or Solid Body.
  • The feature is a solid feature: the feature is set after the given iDestination
  • The feature equals NULL_var: the destination is automatically valuated with the "In Work Object" feature. The "In Work Object" can be set by using the interface
, method and can be set with the method. If the given iDestination and the "In Work Object" feature are not valid, the ReorderFeature method will throw exceptions.
Returns:
This method returns S_OK if the operation went through successfully and E_FAIL otherwise.
o ReorderFeature
public virtual ReorderFeature( const iDestination)
Relocates a solid feature in a procedural body.
Role:This method is used to move a solid feature, that already exists in a procedural body, to another position. If the given destination is not valid, a new destination will sometimes be automatically redefined.
Parameters:
iDestination
The place where the feature will be inserted depends on the factors described below:
  • The feature is a Body or Solid Body: the feature is set at the first position in the Body or Solid Body.
  • The feature is a solid feature: the feature is set after the given iDestination
  • The feature equals NULL_var: the destination is automatically valuated with the "In Work Object" feature. The "In Work Object" can be set by using the interface
, method and can be set with the method. If the given iDestination and the "In Work Object" feature are not valid, the ReorderFeature method will throw exceptions.
Returns:
This method returns S_OK if the operation went through successfully and E_FAIL otherwise.

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

Copyright © 1999-2014, Dassault Systèmes. All rights reserved.