All Frameworks Class Hierarchy This Framework Indexes Previous Next

CATMecModUseItf Interface CATIMf3DBehavior

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

interface CATIMf3DBehavior

Interface characterizing the mechanical modeler behaviors of geometrical features.

Role: The geometrical features (i.e. the features derivating of GeometricalElement3D startup) can be distinguished by the topological dimension of their associated topology but, according to mechanical modeler, the differences between behaviors are not directly based on this topological dimension criterion. They are two categories, defining the way features are managed by generic commands (insertion, deletion, copy, ...), which are:

Solid features (see method)
        Geometric features generating volume topology (see and ).
        Located only in solid sets and solid and surface sets.
        Inserted in the specification tree using specific process (see ).
        Implicit link to the preceding feature in the specification tree, modifying and hidding it.

Surface features (see method)
Geometric features generating any kind of topology (volume, surface or wireframe).
Located (if no specific restriction) in surface sets (geometrical set and ordered geometrical sets) and solid and surface set.

The surface feature category contains a sub-category, the volume features, which is a restriction to features generating volume topology (see method).

A feature can not belong to both categories. Therefore the methods and must return different results.

Beyond these two categories, there's another category, not exclusive of the two preceding one, which is the category of datum features (see method). The datum property applies to features without any link to other features, except internal or external references, affected by the "not up-to-date" mechanism. In other words datum features are not specification features but only copies, static or dynamic, of others geometrical features.

The behavior of a feature may not be fixed by its late type. For instance, a same geometric feature (startup) may be used for both solid or surface designs and therefore the methods of this interface must return variable results depending on the using context of the feature instance.

Implementation: For every startup deriving from GeometricalElement3D, it is essential to reimplement this interface to avoid hazardous behaviors.

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 IsADatum(): Indicates whether a feature is a datum feature.
o IsAShape(): Indicates whether a feature is a surface feature.
o IsASolid(): Indicates whether a feature is a solid feature.
o IsAVolume(): Tells whether the feature is a volume feature.

Methods

o IsADatum

public virtual IsADatum(

)

Indicates whether a feature is a datum feature.
Role: Determines whether datum property (see above) applies to the feature. There no link between this property and the fact that the feature is a solid feature or a surface feature.

Returns:

Legal values:

S_OK: The feature is a datum feature.
E_FAIL: The feature is not a datum feature.

o IsAShape

public virtual IsAShape(

)

Indicates whether a feature is a surface feature.

Returns:

Legal values:

S_OK: The feature is a surface feature.
E_FAIL: The feature is not a surface feature.

o IsASolid

public virtual IsASolid(

)

Indicates whether a feature is a solid feature.

Returns:

Legal values:

S_OK: The feature is a solid feature.
E_FAIL: The feature is not a solid feature.

o IsAVolume

public virtual IsAVolume(

)

Tells whether the feature is a volume feature.
Role: Tells whether the feature is a volume feature. A volume feature is a sub-kind of surface feature and therefore if the method returns S_OK, the method invoked on the same feature must also return S_OK.

Returns:

Legal values:

S_OK: The feature is a volume feature.
E_FAIL: The feature is not a volume feature. It can nevertheless be a surface feature.

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