pycatia.dnb_robot_interfaces.generic_obj_frame_profile

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.dnb_robot_interfaces.generic_obj_frame_profile.GenericObjFrameProfile(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

GenericObjFrameProfile

Interface to manage Generic Object frame Profile of Robot

controller.

Role: This interface provides methods to get/set data related to Object

Profile.

get_controller(o_controller: RobGenericController) → None

Note

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

o Sub GetController(RobGenericController oController)

Retrieves controller owning the profile.

Parameters:

oController

This parameter contains pointer to controller.

Returns:

An HRESULT.

Legal values:

S_OK if the operation succeeds

E_FAIL otherwise

Parameters:

o_controller (RobGenericController) –

Return type:

None

get_name(o_name: str) → None

Note

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

o Sub GetName(CATBSTR oName)

Gets name of the Object frame Profile.

Parameters:

oName

Name of the required Object frame Profile.

Returns:

an HRESULT value.

Legal values:

S_OK if the operation succeeds

E_FAIL otherwise

Parameters:

o_name (str) –

Return type:

None

get_object_frame(x: float, y: float, z: float, roll: float, pitch: float, yaw: float) → None

Note

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

o Sub GetObjectFrame(double x,

double y,

double z,

double roll,

double pitch,

double yaw)

Retrieve the underlying x,y,z, roll, pitch, yaw of the Object

Frame.

Parameters:

x,

The X Coordinate.

y,

The Y Coordinate.

z,

The Z Coordinate.

roll,

The roll Coordinate.

pitch,

The pitch Coordinate.

yaw,

The yaw Coordinate.

Returns:

an HRESULT value.

Legal values:

S_OK if the operation succeeds

E_FAIL otherwise

Parameters:

• x (float) –

• y (float) –

• z (float) –

• roll (float) –

• pitch (float) –

• yaw (float) –

Return type:

None

set_name(i_name: str) → None

Note

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

o Sub SetName(CATBSTR iName)

Set name of the Object frame Profile.

Parameters:

iName

Name of the Object frame Profile to be set.

Returns:

an HRESULT value.

Legal values:

S_OK if the operation succeeds

E_FAIL otherwise

Parameters:

i_name (str) –

Return type:

None

set_object_frame(x: float, y: float, z: float, roll: float, pitch: float, yaw: float) → None

Note

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

o Sub SetObjectFrame(double x,

double y,

double z,

double roll,

double pitch,

double yaw)

Set the underlying x,y,z, roll, pitch, yaw of the Object

Frame.

Parameters:

x,

The X Coordinate.

y,

The Y Coordinate.

z,

The Z Coordinate.

roll,

The roll Coordinate.

pitch,

The pitch Coordinate.

yaw,

The yaw Coordinate.

Returns:

an HRESULT value.

Legal values:

S_OK if the operation succeeds

E_FAIL otherwise

Parameters:

• x (float) –

• y (float) –

• z (float) –

• roll (float) –

• pitch (float) –

• yaw (float) –

Return type:

None