pycatia.cat_tps_interfaces.datum_target

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.datum_target.DatumTarget(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

DatumTarget

Interface for Datum Target TPS (datum entity).

TPS for Technological Product Specifications.

property datum: AnyObject

Note

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

o Property Datum() As AnyObject (Read Only)

Retrieves simple datum, the target belongs to.

Return type:

AnyObject

get_area_form(o_area_form: str) → None

Note

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

o Sub GetAreaForm(CATBSTR oAreaForm)

Gets the form of the target area.

Parameters:

oAreaForm

Form of the target area. Legal values are:- Point, Circular,

Rectangular.

Returns:

HRESULT S_OK:- the Area Form has been correctly retrieved. E_FAIL or E_NOIMPL : Area Form cannot be retrieved.

Parameters:

o_area_form (str) –

Return type:

None

get_circular_area_size(o_area_size: float) → None

Note

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

o Sub GetCircularAreaSize(double oAreaSize)

Gets the size of the circular area.

Parameters:

oAreaSize

Size of the Circular target area.

Returns:

HRESULT S_OK:- the Area Size has been correctly retrieved. E_FAIL or E_NOIMPL : Area Size cannot be retrieved.

Parameters:

o_area_size (float) –

Return type:

None

get_movable_direction_ttrs(op_direction_ttrs: UserSurface) → None

Note

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

o Sub GetMovableDirectionTTRS(UserSurface opDirectionTTRS)

Gets the movable Direction TTRS.

Parameters:

ospDirectionTTRS

Movable Direction TTRS

Returns:

HRESULT S_OK:- the movable direction has been correctly retrieved. E_FAIL or E_NOIMPL : movable direction cannot be retrieved.

Parameters:

op_direction_ttrs (UserSurface) –

Return type:

None

get_rectangular_area_size(o_length: float, o_width: float) → None

Note

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

o Sub GetRectangularAreaSize(double oLength,

double oWidth)

Gets the size of the rectangular area.

Parameters:

oLength

Length of the Rectangular target area.

oWidth

Width of the Rectangular target area.

Returns:

HRESULT S_OK:- the Area Size has been correctly retrieved. E_FAIL or E_NOIMPL : Area Size cannot be retrieved.

Parameters:

• o_length (float) –

• o_width (float) –

Return type:

None

property label: str

Note

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

o Property Label() As CATBSTR

Retrieves Label.

Return type:

str

set_area_form(i_area_form: str) → None

Note

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

o Sub SetAreaForm(CATBSTR iAreaForm)

Sets the form of the target area.

Parameters:

iAreaForm

Form of the target area. Legal values are:- Point, Circular,

Rectangular.

Returns:

HRESULT S_OK:- the Area Form has been correctly set. E_FAIL or E_NOIMPL : Area Form cannot be set.

Parameters:

i_area_form (str) –

Return type:

None

set_circular_area_size(i_area_size: float) → None

Note

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

o Sub SetCircularAreaSize(double iAreaSize)

Sets the size of the circular area.

Parameters:

iAreaSize

Size of the Circular target area.

Returns:

HRESULT S_OK:- the Area Size has been correctly set. E_FAIL or E_NOIMPL : Area Size cannot be set.

Parameters:

i_area_size (float) –

Return type:

None

set_movable_direction_ttrs(ip_direction_ttrs: UserSurface) → None

Note

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

o Sub SetMovableDirectionTTRS(UserSurface ipDirectionTTRS)

Sets the movable Direction TTRS.

Parameters:

ispDirectionTTRS

Movable Direction TTRS If the ipDirectionTTRS is NULL_var, the

direction TTRS inside the model is removed.

Returns:

HRESULT S_OK:- the movable direction has been correctly set. E_FAIL or E_NOIMPL : movable direction cannot be set.

Parameters:

ip_direction_ttrs (UserSurface) –

Return type:

None

set_rectangular_area_size(i_length: float, i_width: float) → None

Note

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

o Sub SetRectangularAreaSize(double iLength,

double iWidth)

Sets the size of the rectangular area.

Parameters:

iLength

Length of the Rectangular target area.

iWidth

Width of the Rectangular target area.

Returns:

HRESULT S_OK:- the Area Size has been correctly set. E_FAIL or E_NOIMPL : Area Size cannot be set.

Parameters:

• i_length (float) –

• i_width (float) –

Return type:

None