ReferenceFrame (Object)

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 |
         ---------------------
 

Properties


Property AllDatumsSimple() As (Read Only)
Retrieves all datums simple used in Reference Frame.
Parameters:
opiListDatumsSimple
All objects of the collection

Methods


Sub Frame( oFirstBox, oSecondBox, oThirdBox)
Retrieves Frame of the TPS.
Parameters:
oFirstBox
oSecondBox
oThirdBox
Texts in first, second and third boxes.
Sub GetAxisSystemTTRS( opAxisSystemTTRS)
Gets the AxisSystem TTRS.
Parameters:
opAxisSystemTTRS
AxisSystem TTRS
Returns:
HRESULT S_OK:- the Axis System has been correctly retrieved. E_FAIL or E_NOIMPL : Axis System cannot be retrieved.
Sub GetDegreesOfFreedom( 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
oValue begins with the symbol :”[“ and ends by the symbol “]”. and between these symbols “[..]”, value are a a combination of following legal values: x, y, z, u, v, w
Returns:
HRESULT S_OK : the Degrees Of Freedom has been correctly retrieved. E_FAIL or E_NOIMPL : the Degrees Of Freedom cannot be retrieved.
Sub SetAxisSystemTTRS( ipAxisSystemTTRS)
Sets the AxisSystem TTRS.
Parameters:
ipAxisSystemTTRS
AxisSystem TTRS. If it is NULL, the AxisSystem TTRS in the model will be removed.
Returns:
HRESULT S_OK:- the Axis System has been correctly set. E_FAIL or E_NOIMPL : Axis System cannot be set.
Sub SetDegreesOfFreedom( inBox, 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
iValue must begin by the symbol :”[“ and must end by the symbol “]”. and between these symbols “[..]”, value must be a combination of following legal values: x, y, z, u, v, w E.G.1:- To set [x,z] as the DOF:- iValue = [x,z]; E.G.2:- To set [y] as the DOF:- iValue = [y];
Returns:
HRESULT S_OK : the Degrees Of Freedom has been correctly set. E_FAIL or E_NOIMPL : the Degrees Of Freedom cannot be set.
Sub SetFrame( iFirstBox, iSecondBox, iThirdBox)
Set Frame of the TPS.
Parameters:
oFirstBox
oSecondBox
oThirdBox
Texts in first, second and third boxes.