pycatia.dnb_robot_interfaces.generic_accuracy_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_accuracy_profile.GenericAccuracyProfile(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

GenericAccuracyProfile

Interface to manage Generic Accuracy Profile of Robot

controller.

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

Profile.

get_accuracy_type() → int

Note

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

o Sub GetAccuracyType(AccuracyType accuracy)

Get the accuracy type for the profile.

Parameters:

accurancy

accurancy type to get, could be ACCURACY_TYPE_DISTANCE /

ACCURACY_TYPE_SPEED

Returns:

An HRESULT.

Legal values:

S_OK if the operation succeeds

E_FAIL otherwise

Returns:

enum accuracy_type

Return type:

int

get_accuracy_value() → float

Note

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

o Sub GetAccuracyValue(double value)

Retrieves accuracy value of the profile.

Parameters:

value

This parameter contains accuracy value.

Returns:

An HRESULT.

Legal values:

S_OK if the operation succeeds

E_FAIL otherwise

Return type:

float

get_controller() → RobGenericController

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

Return type:

RobGenericController

get_fly_by_mode() → bool

Note

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

o Sub GetFlyByMode(boolean oMode)

Gets On/Off status of Flyby mode.

Parameters:

oMode

mode indicating On/Off status.

Returns:

an HRESULT value.

Legal values:

S_OK if the operation succeeds

E_FAIL otherwise

Return type:

bool

get_name() → str

Note

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

o Sub GetName(CATBSTR oName)

Gets name of the Accuracy Profile.

Parameters:

oName

Name of the required Accuracy Profile.

Returns:

an HRESULT value.

Legal values:

S_OK if the operation succeeds

E_FAIL otherwise

Return type:

str

set_accuracy_type(accuracy: int) → None

Note

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

o Sub SetAccuracyType(AccuracyType accuracy)

Set the accuracy type for the profile.

Parameters:

accurancy

accurancy type to set, could be ACCURACY_TYPE_DISTANCE /

ACCURACY_TYPE_SPEED

Returns:

An HRESULT.

Legal values:

S_OK if the operation succeeds

E_FAIL otherwise

Parameters:

accuracy (int) – enum accuracy_type

Return type:

None

set_accuracy_value(value: float) → None

Note

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

o Sub SetAccuracyValue(double value)

Set accuracy value of the profile.

Parameters:

value

This parameter is percentage or absolute value, depending on

accurancy type.

Returns:

An HRESULT.

Legal values:

S_OK if the operation succeeds

E_FAIL otherwise

Parameters:

value (float) –

Return type:

None

set_fly_by_mode(i_mode: bool) → None

Note

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

o Sub SetFlyByMode(boolean iMode)

Switch On/Off Flyby mode.

Parameters:

iMode

mode indicating On/Off status.

Returns:

an HRESULT value.

Legal values:

S_OK if the operation succeeds

E_FAIL otherwise

Parameters:

i_mode (bool) –

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 Accuracy Profile.

Parameters:

iName

Name of the Accuracy 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