All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

PartInterfaces Interface CATIShape

System.IUnknown
  |
  +---System.IDispatch
    |
    +---System.CATBaseUnknown
      |
      +---CATIShape
 

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


interface CATIShape

Interface which provides a basic behavior to a Mechanical Design feature.
Role: This interface allows users to manage the persistence of default values. It also provides various informations about the feature.


Method Index


o GetDefaultValue(CATUnicodeString&,CATISpecObject_var&)
Retrieves a CATISpecObject type default value.
o GetDefaultValue(CATUnicodeString&,double&)
Retrieves a double type default value.
o GetDefaultValue(CATUnicodeString&,int&)
Retrieves a integer type default value.
o IsFirstInTool()
Tests if the feature was created in first position in its mechanical body.
o SetDefaultValue(CATUnicodeString&,CATISpecObject_var&)
Stores a default value of CATISpecObject type.
o SetDefaultValue(CATUnicodeString&,double)
Stores a default value of double type.
o SetDefaultValue(CATUnicodeString&,int)
Stores a default value of integer type.

Methods


o GetDefaultValue
public virtual void GetDefaultValue( const CATUnicodeString& iStr,
CATISpecObject_var& oVal) = 0
Retrieves a CATISpecObject type default value.
Parameters:
iStr
The storage name.
oVal
The value.
o GetDefaultValue
public virtual void GetDefaultValue( const CATUnicodeString& iStr,
double& oVal) = 0
Retrieves a double type default value.
Parameters:
iStr
The storage name.
oVal
The value.
o GetDefaultValue
public virtual void GetDefaultValue( const CATUnicodeString& iStr,
int& oVal) = 0
Retrieves a integer type default value.
Parameters:
iStr
The storage name.
oVal
The value.
o IsFirstInTool
public virtual int IsFirstInTool()= 0
Tests if the feature was created in first position in its mechanical body.
Returns:
1 if the feature is in first position, 0 otherwise.
o SetDefaultValue
public virtual void SetDefaultValue( const CATUnicodeString& iStr,
CATISpecObject_var& iVal) = 0
Stores a default value of CATISpecObject type.
Parameters:
iStr
The storage name. Use a characteristic name to avoid naming conflicts.
iVal
The value.
o SetDefaultValue
public virtual void SetDefaultValue( const CATUnicodeString& iStr,
double iVal) = 0
Stores a default value of double type.
Parameters:
iStr
The storage name. Use a characteristic name to avoid naming conflicts.
iVal
The value.
o SetDefaultValue
public virtual void SetDefaultValue( const CATUnicodeString& iStr,
int iVal) = 0
Stores a default value of integer type.
Parameters:
iStr
The storage name. Use a characteristic name to avoid naming conflicts.
iVal
The value.

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

Copyright © 2003, Dassault Systèmes. All rights reserved.