CATTPSBaseUseItf Interface CATITPSExtendedCylinder
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
 interface CATITPSExtendedCylinder
 
 Method Index
 
 -  o 
    GetDiameter(double&)
 -   Gets the diameter of the extended cylinder.
 
 -  o 
    GetEndPoint(CATMathPoint&)
 -   Gets the end point of the extended cylinder.
 
 -  o 
    GetLength(double&)
 -   Gets the length of the extended cylinder.
 
 -  o 
    GetOffset(double&)
 -   Gets the offset of the extended cylinder.
 
 -  o 
    GetPosition(CATMathPoint&)
 -   Gets the center point of the extended cylinder.
 
 -  o 
    GetReferencePlaneTTRS(CATITTRS**)
 -   Gets the reference plane TTRS of the extended cylinder.
 
 -  o 
    GetRepresentedCylinderTTRS(CATITTRS**)
 -   Gets the represented TTRS of the extended cylinder.
 
 -  o 
    GetStartPoint(CATMathPoint&)
 -   Gets the start point of the extended cylinder.
 
 -  o 
    SetDiameter(double&)
 -   Sets the diameter of the extended cylinder.
 
 -  o 
    SetEndPoint(CATMathPoint&)
 -   Sets the end point of the extended cylinder.
 
 -  o 
    SetLength(double&)
 -   Sets the length of the extended cylinder.
 
 -  o 
    SetOffset(double&)
 -   Sets the offset of the extended cylinder.
 
 -  o 
    SetPosition(CATMathPoint&)
 -   Sets the center point of the extended cylinder.
 
 -  o 
    SetStartPoint(CATMathPoint&)
 -   Sets the start point of the extended cylinder.
 
 Methods
 
  o GetDiameter
  |   public virtual   GetDiameter( |   | oDiameter)   | 
  - 
 Gets the diameter of the extended cylinder.
  
  -  Parameters:
  
 - 
    
    -  oDiameter
   
 -    diameter of the extended cylinder
  returns S_OK when the diameter has been correctly retrieved, 
  returns E_FAIL otherwise.
 
 
 
  o GetEndPoint
  |   public virtual   GetEndPoint( |   | oEndPoint)   | 
  - 
 Gets the end point of the extended cylinder.
  
  -  Parameters:
  
 - 
    
    -  oEndPoint
   
 -    end point of the extended cylinder
  returns S_OK when the point has been correctly retrieved, 
  returns E_FAIL otherwise.
 
 
 
  o GetLength
  |   public virtual   GetLength( |   | oLength)   | 
  - 
 Gets the length of the extended cylinder.
  
  -  Parameters:
  
 - 
    
    -  oLength
   
 -    length of the extended cylinder
  returns S_OK when the length has been correctly retrieved, 
  returns E_FAIL otherwise.
 
 
 
  o GetOffset
  |   public virtual   GetOffset( |   | oOffset)   | 
  - 
 Gets the offset of the extended cylinder.
  
  -  Parameters:
  
 - 
    
    -  oOffset
   
 -    offset of the extended cylinder
  returns S_OK when the offset has been correctly retrieved, 
  returns E_FAIL otherwise.
 
 
 
  o GetPosition
  |   public virtual   GetPosition( |   | oPoint)   | 
  - 
 Gets the center point of the extended cylinder.
  
  -  Parameters:
  
 - 
    
    -  oPoint
   
 -    canter point of the extended cylinder
  returns S_OK when the point has been correctly retrieved, 
  returns E_FAIL otherwise.
 
 
 
  o GetReferencePlaneTTRS
  |   public virtual   GetReferencePlaneTTRS( |   | opiReferencePlaneTTRS)   | 
  - 
 Gets the reference plane TTRS of the extended cylinder.
  
  -  Parameters:
  
 - 
    
    -  opiReferencePlaneTTRS
   
 -    Reference plane TTRS of the extended cylinder
  returns S_OK when the TTRS has been correctly retrieved, 
  returns E_FAIL otherwise.
 
 
 
  o GetRepresentedCylinderTTRS
  |   public virtual   GetRepresentedCylinderTTRS( |   | opiRepresentedCylinderTTRS)   | 
  - 
 Gets the represented TTRS of the extended cylinder.
  
  -  Parameters:
  
 - 
    
    -  opiRepresentedCylinderTTRS
   
 -    Represented TTRS of the extended cylinder
  returns S_OK when the TTRS has been correctly retrieved, 
  returns E_FAIL otherwise.
 
 
 
  o GetStartPoint
  |   public virtual   GetStartPoint( |   | oStartPoint)   | 
  - 
 Gets the start point of the extended cylinder.
  
  -  Parameters:
  
 - 
    
    -  oStartPoint
   
 -    start point of the extended cylinder
  returns S_OK when the point has been correctly retrieved, 
  returns E_FAIL otherwise.
 
 
 
  o SetDiameter
  |   public virtual   SetDiameter( |  const   | iDiameter)   | 
  - 
 Sets the diameter of the extended cylinder.
  
  -  Parameters:
  
 - 
    
    -  iDiameter
   
 -    Diameter of the extended cylinder
  returns S_OK when the diameter has been correctly set, 
  returns E_FAIL otherwise.
 
 
 
  o SetEndPoint
  |   public virtual   SetEndPoint( |  const   | iEndPoint)   | 
  - 
 Sets the end point of the extended cylinder.
  
  -  Parameters:
  
 - 
    
    -  iEndPoint
   
 -    End point of the extended cylinder
  returns S_OK when the point has been correctly set, 
  returns E_FAIL otherwise.
 
 
 
  o SetLength
  |   public virtual   SetLength( |  const   | iLength)   | 
  - 
 Sets the length of the extended cylinder.
  
  -  Parameters:
  
 - 
    
    -  iLength
   
 -    Length of the extended cylinder
  returns S_OK when the length has been correctly set, 
  returns E_FAIL otherwise.
 
 
 
  o SetOffset
  |   public virtual   SetOffset( |  const   | iOffset)   | 
  - 
 Sets the offset of the extended cylinder.
  
  -  Parameters:
  
 - 
    
    -  iOffset
   
 -    offset of the extended cylinder
  returns S_OK when the offset has been correctly set, 
  returns E_FAIL otherwise.
 
 
 
  o SetPosition
  |   public virtual   SetPosition( |  const   | iPoint)   | 
  - 
 Sets the center point of the extended cylinder.
  
  -  Parameters:
  
 - 
    
    -  iPoint
   
 -    canter point of the extended cylinder
  returns S_OK when the point has been correctly set, 
  returns E_FAIL otherwise.
 
 
 
  o SetStartPoint
  |   public virtual   SetStartPoint( |  const   | iStartPoint)   | 
  - 
 Sets the start point of the extended cylinder.
  
  -  Parameters:
  
 - 
    
    -  iStartPoint
   
 -    start point of the extended cylinder
  returns S_OK when the point has been correctly set, 
  returns E_FAIL otherwise.
 
 
 
 This object is included in the file: CATITPSExtendedCylinder.h
If needed, your Imakefile.mk should include the module: CATTPSBaseUseItf
Copyright © 1999-2014, Dassault Systèmes. All rights reserved.