All Frameworks Class Hierarchy This Framework Indexes Previous Next

CATMecModExtendItf Interface CATIMmiFeatureAttributes

Usage: you must use this class as is. You should never derive it.

interface CATIMmiFeatureAttributes

Interface to manage specific attributes used in backup startup context.

Role:When feature's startup catalog and code implementation are not available on the runtime view, for a feature read from a document, the feature instance is replaced with a backup startup. To be able to manage correctly this backup startup, the mechanical modeler need to get information from attributes. This class enables the CAA application to set this information on its CAA features during instanciation.

Method Index

o GetFeatureType(CATBaseUnknown_var&,CATIInputDescription::FeatureType&): Gets the type of feature.
o SetFeatureType(CATBaseUnknown_var&,CATIInputDescription::FeatureType&): Sets the type of feature.

Methods

o GetFeatureType

public virtual GetFeatureType(	const	`iGeometricFeature`,
		`ioFeatureType`)

Gets the type of feature.
Role:
Get the feature type according to implementation. This method is meaningfull for a CAA feature derivated from GSMGeom satrtup, GeometricalElement3D startup or MechanicalShapeFeature startup.

Parameters:

iGeometricFeature

The feature for which the type is set. The feature must derivate from GSMGeom startup (directly or undirectly).

ioFeatureType

Returned values:
.

FeatureType_Creation: The feature is a creation feature, it doesn't absorb any feature.
FeatureType_Modification: The feature is a modification feature, it absorbs at least one feature.

Returns:

Legal values:

S_OK: The feature type has been correctly retrieved.
E_FAIL: The feature type has not been retrieve because of internal failure or because of bad arguments.

o SetFeatureType

public virtual SetFeatureType(	const	`iGeometricFeature`,
	const	`iFeatureType`)

Sets the type of feature.
Role:
Set the feature type according to implementation. This attribute value will be used when the code of CATIInputDescription implementation won't be available. This method is meaningfull for a CAA feature derivated from GSMGeom satrtup or GeometricalElement3D startup. If the CAA feature is derivated from MechanicalShapeFeature startup the call is not necessary since the feature's type (creation or modification) is determined from internal modelisation.

Parameters:

iGeometricFeature

The feature for which the type is set. The feature must derivate from GSMGeom startup (directly or undirectly) or from GeometricalElement3D.

iFeatureType

Legal values:

FeatureType_Creation: The feature is a creation feature, it doesn't absorb any feature.
FeatureType_Modification: The feature is a modification feature, it absorbs at least one feature.

Returns:

Legal values:

S_OK: The feature type has been correctly set.
E_FAIL: The feature type has not been set because of internal failure or because of bad arguments.

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