CATGSMUseItf Interface CATIGSMUseWorkingSupport
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATIGSMUseWorkingSupport
Working support feature.
Role : allows to manipulate the data of a working support
- See also:
-
Method Index
- o
GetGeometricData(CATIMmiMechanicalFeature_var&,int)
- Gets the geometric data useful for working support sub-elements featurizarion in case of selectable WorkingSupport.
- o
GetGrid(CATIGSMUseGrid_var&)
- Gets the grid feature.
- o
GetGridType(GridType&)
- Gets the grid type.
- o
GetListOfFeaturesOnSupport(CATLISTV(CATIMmiMechanicalFeature_var)&)
- Gets all features created on the WorkOnSupport.
- o
GetReferenceMathPoint(CATMathPoint&)
- Gets the reference mathematical point.
- o
GetReferencePoint(CATIMmiMechanicalFeature_var&)
- Gets the reference point.
- o
GetReferenceSupport(CATIMmiMechanicalFeature_var&)
- Gets the working support.
- o
IsCurrent()
- Asks whether this working support is the active one.
- o
SetFeatureOnSupport(CATIMmiMechanicalFeature_var&)
- Flags features created on the WorkOnSupport.
- o
SetGridType(GridType)
- Sets the grid type.
- o
SetReferencePoint(CATIMmiMechanicalFeature_var&)
- Sets the reference point.
- o
SetReferenceSupport(CATIMmiMechanicalFeature_var&)
- Sets the working support.
Enumerated Type Index
- o
GridType
- Defines available grid types
Methods
o GetGeometricData
| public virtual GetGeometricData( | | ospData, |
| | iRank) |
-
Gets the geometric data useful for working support sub-elements featurizarion in case of selectable WorkingSupport.
The geometrics data are the 2 infinite lines representing the two main direction of the grid.
- Parameters:
-
- ospData
- The geometric line.
- iRank
- The rank of the geometic line (1 or 2)
o GetGrid
| public virtual GetGrid( | | ospGrid) |
-
Gets the grid feature.
- Parameters:
-
- ospGrid
- the returned grid when it exits.
Note: This can be :
- - NULL_var when there is no grid
- - a CATIGSMUseCartesianGrid handler when grid type is Cartesian
- See also:
- ,
o GetGridType
| public virtual GetGridType( | | oType) |
-
Gets the grid type.
- Parameters:
-
- oType
- Type of grid support
o GetListOfFeaturesOnSupport
| public virtual GetListOfFeaturesOnSupport( | | oListOfFeatures) |
-
Gets all features created on the WorkOnSupport.
- Parameters:
-
- oListOfFeatures
- List of features created on the WorkOnSupport
o GetReferenceMathPoint
| public virtual GetReferenceMathPoint( | | oPoint) |
-
Gets the reference mathematical point.
Note: This method is only valid when the reference support has been set
and when there is no grid.
This point is either the default computed point or the reference point that has
been set by the user.
- Parameters:
-
- oPoint
- The point
- Returns:
- S_OK if OK, E_FAIL if fail
o GetReferencePoint
| public virtual GetReferencePoint( | | ospPoint) |
-
Gets the reference point.
Note: This data is not mandatory, point can be NULL_var
- Parameters:
-
- ospPoint
- The point
o GetReferenceSupport
| public virtual GetReferenceSupport( | | ospSupport) |
-
Gets the working support.
- Parameters:
-
- ospSupport
- The support.
Note: The support can be a plane or a surface.
o IsCurrent
| public virtual IsCurrent( | ) |
-
Asks whether this working support is the active one.
TRUE = if Working Support is current
FALSE = if Working Support is NOT current one
o SetFeatureOnSupport
| public virtual SetFeatureOnSupport( | const | iFeatureOnSupport) |
-
Flags features created on the WorkOnSupport.
- Parameters:
-
- iFeatureOnSupport
- Feature to be flag as creasted on the WorkOnSupport
o SetGridType
| public virtual SetGridType( | const | iType) |
-
Sets the grid type.
- Parameters:
-
- iType
- Type of grid support
o SetReferencePoint
| public virtual SetReferencePoint( | const | ispPoint) |
-
Sets the reference point.
This data is not mandatory, point=NULL_var is allowed.
- Parameters:
-
- ispPoint
- The point
o SetReferenceSupport
| public virtual SetReferenceSupport( | const | ispSupport) |
-
Sets the working support.
- Parameters:
-
- ispSupport
- The support.
Note: The support can be a plane or a surface.
Enumerated Types
o GridType
-
enum GridType {
GSMUnknownGrid,
GSMNoGrid,
GSMCartesianGrid,
GSMGridSetGrid
}
Defines available grid types
- Parameters:
-
- GSMUnknownGrid
- Unknown type of grid
- GSMNoGrid
- No grid
- GSMCartesianGrid
- Cartesian grid
- GSMSelectableGrid
- New selectable cartesian Grid (R10)
- GSMReferenceGrid
- New selectable reference cartesian Grid (R10)
- GSMGridSetGrid
- GridSet Grid
This object is included in the file: CATIGSMUseWorkingSupport.h
If needed, your Imakefile.mk should include the module: CATGSMUseItf
Copyright © 1999-2014, Dassault Systèmes. All rights reserved.