CATTTRSUseItf Interface CATIRGE
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
 interface CATIRGE
 Interface representing RGEs (Reference Geometrical Elements).
 Role: RGE is one of the two main concepts of the TTRS theory.
 
 - It is a handle representing either a surface, or one to three wireframes elements. 
 
 - It respects the six TTRS class.
 
 - It is made up of a point and/or a line and/or a plane.
 
 Method Index
 
 -  o 
    GetMathRGE(CATMathRGE*&)
 -   Computes its corresponding CATMathRGE.
 
 -  o 
    GetReferencedGeometry(CATBaseUnknown_var&)
 -   Returns the geometrical element associated to the RGE.
 
 -  o 
    GetReferencedGeometry(CATPoint_var&,CATLine_var&,CATPlane_var&)
 -   Gets the one to three geometrical elements associated to the RGE if they exist (skeleton model).
 
 -  o 
    GetTTRSClass(CATMmrTTRSClass&)
 -    Gets the TTRS Class of the RGE.
 
 -  o 
    ReplaceReferencedGeometry(CATBaseUnknown_var&)
 -   Replaces the single geometrical element associated to the RGE by another of the same TTRS Class 
 
  -  o 
    ReplaceReferencedGeometry(CATPoint_var&,CATLine_var&,CATPlane_var&)
 -   Replaces the geometrical elements associated to the RGE by one to three GeometricalElements.
 
 Methods
 
  o GetMathRGE
  |   public virtual   GetMathRGE( |   | oMathRGE)   | 
  - 
 Computes its corresponding CATMathRGE.
 You just have to ask this CATMathRGE for its coordinates (CATMathPoint, CAMathLine, CATMathPlane).
 
  -  Parameters:
  
 - 
    
    -  oMathRGE
   
 -    The CATMathRGE.
 
 
 
  o GetReferencedGeometry
  |   public virtual   GetReferencedGeometry( |   | oReferencedGeometry)   | 
  - 
 Returns the geometrical element associated to the RGE.
 
  -  Parameters:
  
 - 
    
    -  oReferencedGeometry
   
 -    In general, oReferencedGeometry is a feature representing a relimited surface.
   
GeometricalElement may be NULL in case of a RGE representing several wireframe features :
   
For example : a point and a line for a Revolute RGE. 
   
In that case, use GetReferencedGeometry(CATPoint_var, CATLine_var, CATPlane_var) 
 
 
  o GetReferencedGeometry
  |   public virtual   GetReferencedGeometry( |   | oPoint, | 
 |   | oLine, | 
 |   | oPlane)   | 
  - 
 Gets the one to three geometrical elements associated to the RGE if they exist (skeleton model).
 
(to be used only if GetReferencedGeometry(CATBaseUnknown_var) returns nothing).
 
  -  Parameters:
  
 - 
    
    -  oPoint
   
 -    The point.
 
 
    -  oLine
   
 -    The line.
 
 
    -  oPlane
   
 -    The plane.
 
 
 
  o GetTTRSClass
  |   public virtual   GetTTRSClass( |   | oTTRSClass)   | 
  - 
  Gets the TTRS Class of the RGE.
 
  -  Parameters:
  
 - 
    
    -  oTTRSClass
   
 -    The TTRS class of the RGE
   
Legal values: There are six classes of surfaces, TTRS and RGE :
   Spherical, Planar, Cylindrical, Prismatic, Revolute, Complex
 
 
 
  o ReplaceReferencedGeometry
  |   public virtual   ReplaceReferencedGeometry( |   | iNewGeometry)   | 
  - 
 Replaces the single geometrical element associated to the RGE by another of the same TTRS Class 
 
  -  Parameters:
  
 - 
    
    -  iNewGeometry
   
 -    The replacing geometry.
 
 
 
  o ReplaceReferencedGeometry
  |   public virtual   ReplaceReferencedGeometry( |   | oPoint, | 
 |   | oLine, | 
 |   | oPlane)   | 
  - 
 Replaces the geometrical elements associated to the RGE by one to three GeometricalElements.
 
Typical usage are skeleton models: to replace a conic RSUR by a point (the apex) and a line (the axis).
 
  -  Parameters:
  
 - 
    
    -  oPoint
   
 -    The point.
 
 
    -  oLine
   
 -    The line.
 
 
    -  oPlane
   
 -    The plane.
 
 
 
 This object is included in the file: CATIRGE.h
If needed, your Imakefile.mk should include the module: CATTTRSUseItf
Copyright © 1999-2014, Dassault Systèmes. All rights reserved.