CATMecModUseItf Interface CATIGSMTool

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

interface CATIGSMTool

Interface to manage a GSMTool feature.
Role: This interface manages GSMTool Features, also called Surfacic Feature Sets, since they aggregate surfacic features (features that reference 0D, 1D, or 2D geometry). There are two kinds of GSMTool features:

The method enables you to difference them.

The interface enables you to retrieve all the geometrical features of the surfacic set.

The interface enables you to create a GSMTool and the interface enables you to retrieve them.

Method Index


o AutoSortComponents(int)
Automatic sort of components inside the surfacic set.
o GetType(int&)
Retrieves the type of the surfacic body.
o IsPrivate(int&)
Retrieves the private mode of the surfacic body.
o SetPrivate(int)
Sets the GSMTool in private mode.
o SetType(int)
Sets the type of the surfacic body.

Methods


o AutoSortComponents
public virtual AutoSortComponents( iMode=0)
Automatic sort of components inside the surfacic set.
Role: This service automatically sorts the surfacic set components respecting Parents/Children links.
Parameters:
iMode
Default mode (0), only direct children are sorted. if iMode equals to 1, all sub-surfacic sets are sorted too.
Returns:
It can return E_FAIL if there is a update cycle.
o GetType
public virtual GetType( oType)
Retrieves the type of the surfacic body.
Parameters:
oType
The type of the surfacic body
Legal Values:
  • 0: Geometrical Set
  • 1: Ordered Geometrical Set
o IsPrivate
public virtual IsPrivate( oMode)
Retrieves the private mode of the surfacic body.
Parameters:
oMode
The private mode. The value is only available if the body is private.
  • 1 Private
  • 2 Private but user can remove an object inside
Returns:
The legal values are:
  • S_OK The surfacic body is private
  • E_FAIL otherwise
o SetPrivate
public virtual SetPrivate( iMode=1)
Sets the GSMTool in private mode.
Role: If a surfacic set is private, user cannot aggregate objects inside it and cannot reorder it. A private set may become in work object but not its internal elements. The Scan commands do not scan the internal elements. The Autosort command is not available. All manipulations inside this set should be done by code. Use this capability if you want to create your own surfacic set.
Parameters:
iMode
The private mode. The legal values are:
  • 1 The set is private and Delete or Cut are not allowed for elements inside it.
  • 2 The set is private and Delete or Cut are allowed for elements inside it.
  • 0 The set is public.
o SetType
public virtual SetType( iType)
Sets the type of the surfacic body.
Parameters:
iType
The type of the surfacic body
Legal Values:
  • 0: Geometrical Set
  • 1: Ordered Geometrical Set
Returns:
The legal values are:
  • S_OK The type of the surfacic body has been changed successfully
  • E_FAIL The type of the surfacic body has not been changed since it is forbidden by aggregation rules due to the body containt
This object is included in the file: CATIGSMTool.h
If needed, your Imakefile.mk should include the module: CATMecModUseItf

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