All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

GSMInterfaces Interface CATIGSMMaskSet

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

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


interface CATIGSMMaskSet

Mask set feature.
Role : allows to manipulate the masks of the model.


Method Index


o AppendMask(CATIGSMMask_var&,int)
Adds a Mask in the list.
o GetActiveMask(CATISpecObject_var&)
Gets active mask of the Part.
o GetAllMasks(CATListValCATISpecObject_var&)
Gets all the masks of the Part.
o GetMasksLinkedToAxis(CATISpecObject_var&,CATListValCATISpecObject_var&)
Gets masks linked to the axis system.
o SetCurrentMask(CATIGSMMask_var&)
Activate mask.

Methods


o AppendMask
public virtual HRESULT AppendMask( const CATIGSMMask_var& iMask,
int iSetState=1) = 0
Adds a Mask in the list.
Parameters:
iMask
Mask object
iSetState

iSetState = 1 for setting as current
iSetState = 0 either
Note : default SetState= 1
o GetActiveMask
public virtual HRESULT GetActiveMask(CATISpecObject_var& oMask) = 0
Gets active mask of the Part.
Parameters:
oMask
Active Mask.
o GetAllMasks
public virtual HRESULT GetAllMasks(CATListValCATISpecObject_var& oMasks) = 0
Gets all the masks of the Part.
Parameters:
oMasks
Masks list.
o GetMasksLinkedToAxis
public virtual HRESULT GetMasksLinkedToAxis( const CATISpecObject_var& iAxisSystem,
CATListValCATISpecObject_var& oMasks) = 0
Gets masks linked to the axis system.
Parameters:
iAxisSystem
Axis system.
oMasks
Masks linked to the axis system.
o SetCurrentMask
public virtual HRESULT SetCurrentMask( const CATIGSMMask_var& iMask) = 0
Activate mask. (If input NULL_var, the active one is deactivated.)
Parameters:
iMask
Mask to activate.

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

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