pycatia.cat_tps_interfaces.reference_frame

Module initially auto generated using V5Automation files from CATIA V5 R28 on 2020-09-25 14:34:21.593357

Warning

The notes denoted “CAA V5 Visual Basic Help” are to be used as reference only. They are there as a guide as to how the visual basic / catscript functions work and thus help debugging in pycatia.

class pycatia.cat_tps_interfaces.reference_frame.ReferenceFrame(com_object)

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)

System.IUnknown
System.IDispatch
System.CATBaseUnknown
System.CATBaseDispatch
System.AnyObject
ReferenceFrame

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 |
———————
property all_datums_simple: Annotations

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property AllDatumsSimple() As Annotations (Read Only)


Retrieves all datums simple used in Reference Frame.

Parameters:

opiListDatumsSimple

All objects of the collection
Return type:

Annotations

frame(o_first_box: str, o_second_box: str, o_third_box: str) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub Frame(CATBSTR oFirstBox,
CATBSTR oSecondBox,
CATBSTR oThirdBox)

Retrieves Frame of the TPS.

Parameters:

oFirstBox
oSecondBox
oThirdBox

Texts in first, second and third boxes.
Parameters:

  • o_first_box (str) –

  • o_second_box (str) –

  • o_third_box (str) –

Return type:

None

get_axis_system_ttrs(op_axis_system_ttrs: UserSurface) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub GetAxisSystemTTRS(UserSurface 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.
Parameters:

op_axis_system_ttrs (UserSurface) –

Return type:

None

get_degrees_of_freedom(in_box: cat_variant, o_value: str) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub GetDegreesOfFreedom(CATVariant inBox,
CATBSTR 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.
Parameters:

  • in_box (cat_variant) –

  • o_value (str) –

Return type:

None

set_axis_system_ttrs(ip_axis_system_ttrs: UserSurface) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub SetAxisSystemTTRS(UserSurface 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.
Parameters:

ip_axis_system_ttrs (UserSurface) –

Return type:

None

set_degrees_of_freedom(in_box: cat_variant, i_value: str) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub SetDegreesOfFreedom(CATVariant inBox,
CATBSTR 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.
Parameters:

  • in_box (cat_variant) –

  • i_value (str) –

Return type:

None

set_frame(i_first_box: str, i_second_box: str, i_third_box: str) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub SetFrame(CATBSTR iFirstBox,
CATBSTR iSecondBox,
CATBSTR iThirdBox)

Set Frame of the TPS.

Parameters:

oFirstBox
oSecondBox
oThirdBox

Texts in first, second and third boxes.
Parameters:

  • i_first_box (str) –

  • i_second_box (str) –

  • i_third_box (str) –

Return type:

None