CATTPSBaseUseItf Interface CATITPSReferenceFrame

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

interface CATITPSReferenceFrame

Interface designed to manage reference frame associated to a TPS.
Reference frame is composed of three boxes.

                         Reference Frame
                        / 
                  _____|_____
                 /           \
         ---------------------
         |   |   |Box|Box|Box|
         |   |   | 1 | 2 | 3 |
         ---------------------
 
 Reference Frame must be defined with the SetFrame method that returns a 
 semantic diagnostic on the input frame. When not in a definition context,
 this diagnostic on frame is included in global diagnostic returned by 
 CATITPSSemanticValidity::Check() method.


 
Method Index
 


 
 o 
    GetAllDatumsSimple(CATITPSList**)
  Retrieves all datums simple used in Reference Frame.
 
 o 
    GetAxisSystemTTRS(CATITTRS_var&)
  Gets the AxisSystem TTRS.
 
 o 
    GetDegreesOfFreedom(int,CATTPSConstrainingDOF&)
  Retrieves the values of Degrees Of Freedom(DOF) [x,y,z,u,v,w].
 
 o 
    GetFrame(wchar_t**,wchar_t**,wchar_t**)
  Retrieves Frame of the TPS.
 
 o 
    SetAxisSystemTTRS(CATITTRS_var&)
  Sets the AxisSystem TTRS.
 
 o 
    SetDegreesOfFreedom(int,CATTPSConstrainingDOF)
  Sets the values of Degrees Of Freedom(DOF) [x,y,z,u,v,w].
 
 o 
    SetFrame(wchar_t*,wchar_t*,wchar_t*,wchar_t**)
  Set Frame of the TPS.





 
Methods
 

 
 o GetAllDatumsSimple

  
  public virtual   GetAllDatumsSimple(
 
oDatums)  

  

 Retrieves all datums simple used in Reference Frame.
   

  
 Parameters:
  

    

    
 oDatums
   
 [out, CATITPSList#Release]     All objects of the collection adhere to CATITPSDatumSimple.



 
 o GetAxisSystemTTRS

  
  public virtual   GetAxisSystemTTRS(
 
ospAxisSystemTTRS)  

  

 Gets the AxisSystem TTRS.
  

  
 Parameters:
  

    

    
 ospAxisSystemTTRS
   
   AxisSystem TTRS
  returns S_OK when the TTRS has been correctly retrieved, 
  returns E_FAIL otherwise.



 
 o GetDegreesOfFreedom

  
  public virtual   GetDegreesOfFreedom(
 const  
inBox,
 
oValue)  

  

 Retrieves the values of Degrees Of Freedom(DOF) [x,y,z,u,v,w].
 Is only defined when "Axis System" attribute is valued.
 Only for ASME 2009 (does not exist in ISO).
  

  
 Parameters:
  

    

    
 inBox
   
   First, Second or the Third Box of the DRF on which
   the Degrees Of Freedom is to be retrieved.
  
    
 oValue
   
   Legal values are:-
   CATTPSConstrainX,
   CATTPSConstrainY,
   CATTPSConstrainZ,
   CATTPSConstrainU,
   CATTPSConstrainV,
   CATTPSConstrainW
  

  
 Returns: 
  
  HRESULT    S_OK : the Degrees Of Freedom has been correctly retrieved.
    E_FAIL or E_NOIMPL : the Degrees Of Freedom cannot be retrieved.


 
 o GetFrame

  
  public virtual   GetFrame(
 
oFirstBox,
 
oSecondBox,
 
oThirdBox)  

  

 Retrieves Frame of the TPS.
   

  
 Parameters:
  

    

    
 oFirstBox
   
   
    
 oSecondBox
   
   
    
 oThirdBox
   
     Texts in first, second and third boxes.



 
 o SetAxisSystemTTRS

  
  public virtual   SetAxisSystemTTRS(
 const  
ispAxisSystemTTRS)  

  

 Sets the AxisSystem TTRS.
  

  
 Parameters:
  

    

    
 ispAxisSystemTTRS
   
   AxisSystem TTRS. If it is NULL, the AxisSystem TTRS in the model
   will be removed.
  returns S_OK when the TTRS has been correctly set, 
  returns E_FAIL otherwise.



 
 o SetDegreesOfFreedom

  
  public virtual   SetDegreesOfFreedom(
 const  
inBox,
 const  
iValue)  

  

 Sets the values of Degrees Of Freedom(DOF) [x,y,z,u,v,w].
 Is only defined when "Axis System" attribute is valued.
 Only for ASME 2009 (does not exist in ISO).
  

  
 Parameters:
  

    

    
 inBox
   
   First, Second or the Third Box of the DRF on which
   the Degrees Of Freedom is to be set.
  
    
 iValue
   
   Legal values are:-
   CATTPSConstrainX,
   CATTPSConstrainY,
   CATTPSConstrainZ,
   CATTPSConstrainU,
   CATTPSConstrainV,
   CATTPSConstrainW
   E.G.:- To set [x,z] as the DOF:-
   iValue = CATTPSConstrainX|CATTPSConstrainZ;
  

  
 Returns: 
  
  HRESULT    S_OK : the Degrees Of Freedom has been correctly set.
    E_FAIL or E_NOIMPL : the Degrees Of Freedom cannot be set.


 
 o SetFrame

  
  public virtual   SetFrame(
 const  
iFirstBox,
 const  
iSecondBox,
 const  
iThirdBox,
 
oDiagnostic)  

  

 Set Frame of the TPS. Frame is defined by a string in each box.
   

  
 Parameters:
  

    

    
 iFirstBox
   
   
    
 iSecondBox
   
   
    
 iThirdBox
   
     Texts in first, second and third boxes.
   
    
 oDiagnostic
   
     Message that contains semantic diagnostic on Reference Frame.
     It is composed of [0...n] NLS Keys separated by blank.
     oDiagnostic must be deleted after use.




 This object is included in the file: CATITPSReferenceFrame.h


Copyright © 1999-2014, Dassault Systèmes. All rights reserved.