All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

CATTTRSInterfaces Class CATMathRGE

CATMathRGE
 

Usage: you must use this class as is. You should never derive it.


public class CATMathRGE

Class representing the mathematical properties of RGEs (TTRS).
Role: CATMathRGE is derived into six specialized classes:

  1. CATMathSphericalRGE made up of a CATMathPoint
  2. CATMathPlanarRGE made up of a CATMathPlane
  3. CATMathCylindricalRGE made up of a CATMathLine
  4. CATMathRevoluteRGE made up of a CATMathPoint and a CATMathLine
  5. CATMathPrismaticRGE made up of a CATMathLine and a CATMathPlane
  6. CATMathComplexRGE made up of a CATMathPoint, a CATMathLine and a CATMathPlane


Constructor and Destructor Index


o CATMathRGE()
Default constructor.

Method Index


o GetMathLine(CATMathLine&)
Retrieves the line making up the RGE.
o GetMathPlane(CATMathPlane&)
Retrieves the plane making up the RGE.
o GetMathPoint(CATMathPoint&)
Retrieves the point making up the RGE.
o GetTTRSClass()
Returns the TTRS class associated with the RGE.
o GetTTRSclass()
Returns the TTRS class associated with the RGE.

Constructor and Destructor


o CATMathRGE
public CATMathRGE()
Default constructor. Do not use. Preferably instantiate derived classes.

Methods


o GetMathLine
public virtual HRESULT GetMathLine(CATMathLine& ioMathLine)
Retrieves the line making up the RGE.
Role: If the RGE is made up of a line, the derived class redefines this method to supply the line. Otherwise, no line makes up the RGE, and this method returns E_FAIL.
Parameters:
ioMathLine
The retrieved line
Returns:
E_FAIL Returns always E_FAIL
o GetMathPlane
public virtual HRESULT GetMathPlane(CATMathPlane& ioMathPlane)
Retrieves the plane making up the RGE.
Role: If the RGE is made up of a plane, the derived class redefines this method to supply the plane. Otherwise, no plane makes up the RGE, and this method returns E_FAIL.
Parameters:
ioMathPlane
The retrieved plane
Returns:
E_FAIL Returns always E_FAIL
o GetMathPoint
public virtual HRESULT GetMathPoint(CATMathPoint& ioMathPoint)
Retrieves the point making up the RGE.
Role: If the RGE is made up of a point, the derived class redefines this method to supply the point. Otherwise, no point makes up the RGE, and this method returns E_FAIL.
Parameters:
ioMathPoint
The retrieved point
Returns:
E_FAIL Returns always E_FAIL
o GetTTRSClass
public virtual CATTTRSClass GetTTRSClass()const
Returns the TTRS class associated with the RGE.
o GetTTRSclass
public virtual CATMmrTTRSClass GetTTRSclass()const
Returns the TTRS class associated with the RGE.

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

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