pycatia.dnb_robot_interfaces.rob_generic_controller

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.rob_generic_controller.RobGenericController(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

RobGenericController

INTERFACE : DNBIARobGenericController

DESCRIPTION This allows add/remove and get/set of controller

profiles

add_accuracy_profile(profile: GenericAccuracyProfile) → None

Note

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

o Sub AddAccuracyProfile(GenericAccuracyProfile profile)

Add a new Accuracy Profile into controller.

Parameters:

profile

interface pointer to Accuracy profile

Returns:

an HRESULT value.

Legal values:

S_OK if the operation succeeds

E_FAIL otherwise

Parameters:

profile (GenericAccuracyProfile) –

Return type:

None

add_motion_profile(profile: GenericMotionProfile) → None

Note

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

o Sub AddMotionProfile(GenericMotionProfile profile)

Add a new Motion Profile into controller.

Parameters:

profile

interface pointer to Motion profile

Returns:

an HRESULT value.

Legal values:

S_OK if the operation succeeds

E_FAIL otherwise

Parameters:

profile (GenericMotionProfile) –

Return type:

None

add_obj_frame_profile(profile: GenericObjFrameProfile) → None

Note

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

o Sub AddObjFrameProfile(GenericObjFrameProfile profile)

Add a new ObjFrame Profile into controller.

Parameters:

profile

interface pointer to ObjFrame profile

Returns:

an HRESULT value.

Legal values:

S_OK if the operation succeeds

E_FAIL otherwise

Parameters:

profile (GenericObjFrameProfile) –

Return type:

None

add_tool_profile(i_profile: GenericToolProfile) → None

Note

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

o Sub AddToolProfile(GenericToolProfile iProfile)

Add a new Tool Profile into controller.

Parameters:

profile

interface pointer to tool profile

Returns:

an HRESULT value.

Legal values:

S_OK if the operation succeeds

E_FAIL otherwise

Parameters:

i_profile (GenericToolProfile) –

Return type:

None

get_accuracy_profile(name: str, profile: GenericAccuracyProfile) → None

Note

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

o Sub GetAccuracyProfile(CATBSTR name,

GenericAccuracyProfile profile)

Get Accuracy profile given name.

Parameters:

name

This parameter contains name of the Accuracy profile.

profile

This outer parameter contains interface pointer to Accuracy

profile.

Returns:

an HRESULT value.

Legal values:

S_OK if the operation succeeds

E_FAIL otherwise

Parameters:

• name (str) –

• profile (GenericAccuracyProfile) –

Return type:

None

get_accuracy_profile_count(count: int) → None

Note

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

o Sub GetAccuracyProfileCount(long count)

Get number of Accuracy profiles in controller.

Parameters:

count

This outer parameter contains number of Accuracy profiles.

Returns:

an HRESULT value.

Legal values:

S_OK if the operation succeeds

E_FAIL otherwise

Parameters:

count (int) –

Return type:

None

get_accuracy_profiles(profiles: tuple) → None

Note

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

o Sub GetAccuracyProfiles(CATSafeArrayVariant profiles)

Get Accuracy profiles list in controller.

Parameters:

profiles

This outer parameter contains Accuracy profile list.

Returns:

an HRESULT value.

Legal values:

S_OK if the operation succeeds

E_FAIL otherwise

.

Parameters:

profiles (tuple) –

Return type:

None

get_current_accuracy_profile(profile: str) → None

Note

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

o Sub GetCurrentAccuracyProfile(CATBSTR profile)

Get current Accuracy profile name used in controller.

Parameters:

profile

This outer parameter contains Accuracy profile name.

Returns:

an HRESULT value.

Legal values:

S_OK if the operation succeeds

E_FAIL otherwise

Parameters:

profile (str) –

Return type:

None

get_current_motion_profile(profile: str) → None

Note

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

o Sub GetCurrentMotionProfile(CATBSTR profile)

Get current Motion profile name used in controller.

Parameters:

profile

This outer parameter contains Motion profile name.

Returns:

an HRESULT value.

Legal values:

S_OK if the operation succeeds

E_FAIL otherwise

Parameters:

profile (str) –

Return type:

None

get_current_obj_frame_profile(profile: str) → None

Note

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

o Sub GetCurrentObjFrameProfile(CATBSTR profile)

Get current ObjFrame profile name used in controller.

Parameters:

profile

This outer parameter contains ObjFrame profile name.

Returns:

an HRESULT value.

Legal values:

S_OK if the operation succeeds

E_FAIL otherwise

Parameters:

profile (str) –

Return type:

None

get_current_tool_profile(profile: str) → None

Note

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

o Sub GetCurrentToolProfile(CATBSTR profile)

Get current tool profile name used in controller.

Parameters:

profile

This outer parameter contains tool profile name.

Returns:

an HRESULT value.

Legal values:

S_OK if the operation succeeds

E_FAIL otherwise

Parameters:

profile (str) –

Return type:

None

get_motion_profile(name: str, profile: GenericMotionProfile) → None

Note

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

o Sub GetMotionProfile(CATBSTR name,

GenericMotionProfile profile)

Get Motion profile given name.

Parameters:

name

This parameter contains name of the Motion profile.

profile

This outer parameter contains interface pointer to Motion profile.

Returns:

an HRESULT value.

Legal values:

S_OK if the operation succeeds

E_FAIL otherwise

Parameters:

• name (str) –

• profile (GenericMotionProfile) –

Return type:

None

get_motion_profile_count(count: int) → None

Note

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

o Sub GetMotionProfileCount(long count)

Get number of Motion profiles in controller.

Parameters:

count

This outer parameter contains number of Motion profiles.

Returns:

an HRESULT value.

Legal values:

S_OK if the operation succeeds

E_FAIL otherwise

Parameters:

count (int) –

Return type:

None

get_motion_profiles(profiles: tuple) → None

Note

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

o Sub GetMotionProfiles(CATSafeArrayVariant profiles)

Get Motion profiles list in controller.

Parameters:

profiles

This outer parameter contains Motion profile list.

Returns:

an HRESULT value.

Legal values:

S_OK if the operation succeeds

E_FAIL otherwise

Parameters:

profiles (tuple) –

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)

Retreives name of the generic controller.

Parameters:

name

name of the controller to be set.

Returns:

an HRESULT value.

Legal values:

S_OK if the operation succeeds

E_FAIL otherwise

Parameters:

o_name (str) –

Return type:

None

get_obj_frame_profile(name: str, profile: GenericObjFrameProfile) → None

Note

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

o Sub GetObjFrameProfile(CATBSTR name,

GenericObjFrameProfile profile)

Get ObjFrame profile given name.

Parameters:

name

This parameter contains name of the ObjFrame profile.

profile

This outer parameter contains interface pointer to ObjFrame

profile.

Returns:

an HRESULT value.

Legal values:

S_OK if the operation succeeds

E_FAIL otherwise

Parameters:

• name (str) –

• profile (GenericObjFrameProfile) –

Return type:

None

get_obj_frame_profile_count(count: int) → None

Note

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

o Sub GetObjFrameProfileCount(long count)

Get number of ObjFrame profiles in controller.

Parameters:

count

This outer parameter contains number of ObjFrame profiles.

Returns:

an HRESULT value.

Legal values:

S_OK if the operation succeeds

E_FAIL otherwise

Parameters:

count (int) –

Return type:

None

get_obj_frame_profiles(profiles: tuple) → None

Note

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

o Sub GetObjFrameProfiles(CATSafeArrayVariant profiles)

Get ObjFrame profiles list in controller.

Parameters:

profiles

This outer parameter contains ObjFrame profile list.

Returns:

an HRESULT value.

Legal values:

S_OK if the operation succeeds

E_FAIL otherwise

Parameters:

profiles (tuple) –

Return type:

None

get_tool_profile(name: str, profile: GenericToolProfile) → None

Note

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

o Sub GetToolProfile(CATBSTR name,

GenericToolProfile profile)

Get tool profile given name.

Parameters:

name

This parameter contains name of the tool profile.

profile

This outer parameter contains interface pointer to tool profile.

Returns:

an HRESULT value.

Legal values:

S_OK if the operation succeeds

E_FAIL otherwise

Parameters:

• name (str) –

• profile (GenericToolProfile) –

Return type:

None

get_tool_profile_count(count: int) → None

Note

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

o Sub GetToolProfileCount(long count)

Get number of tool profiles in controller.

Parameters:

count

This outer parameter contains number of tool profiles.

Returns:

an HRESULT value.

Legal values:

S_OK if the operation succeeds

E_FAIL otherwise

Parameters:

count (int) –

Return type:

None

get_tool_profiles(profiles: tuple) → None

Note

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

o Sub GetToolProfiles(CATSafeArrayVariant profiles)

Get tool profiles list in controller.

Parameters:

profiles

This outer parameter contains tool profile list.

Returns:

an HRESULT value.

Legal values:

S_OK if the operation succeeds

E_FAIL otherwise

Parameters:

profiles (tuple) –

Return type:

None

has_accuracy_profile(name: str, flag: bool) → None

Note

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

o Sub HasAccuracyProfile(CATBSTR name,

boolean flag)

Check whether given tool profile exists.

Parameters:

name

This parameter contains name of the Accuracy profile.

flag

This outer parameter contains whether Accuracy profile exists.

Returns:

an HRESULT value.

Legal values:

S_OK if the operation succeeds

E_FAIL otherwise

Parameters:

• name (str) –

• flag (bool) –

Return type:

None

has_motion_profile(name: str, flag: bool) → None

Note

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

o Sub HasMotionProfile(CATBSTR name,

boolean flag)

Check whether given Motion profile exists.

Parameters:

name

This parameter contains name of the Motion profile.

flag

This outer parameter contains whether Motion profile exists.

Returns:

an HRESULT value.

Legal values:

S_OK if the operation succeeds

E_FAIL otherwise

Parameters:

• name (str) –

• flag (bool) –

Return type:

None

has_obj_frame_profile(name: str, flag: bool) → None

Note

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

o Sub HasObjFrameProfile(CATBSTR name,

boolean flag)

Check whether given ObjFrame profile exists.

Parameters:

name

This parameter contains name of the ObjFrame profile.

flag

This outer parameter contains whether ObjFrame profile exists.

Returns:

an HRESULT value.

Legal values:

S_OK if the operation succeeds

E_FAIL otherwise

Parameters:

• name (str) –

• flag (bool) –

Return type:

None

has_tool_profile(name: str, flag: bool) → None

Note

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

o Sub HasToolProfile(CATBSTR name,

boolean flag)

Check whether given tool profile exists.

Parameters:

name

This parameter contains name of the tool profile.

flag

This outer parameter contains whether tool profile exists.

Returns:

an HRESULT value.

Legal values:

S_OK if the operation succeeds

E_FAIL otherwise

Parameters:

• name (str) –

• flag (bool) –

Return type:

None

remove_accuracy_profile(name: str) → None

Note

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

o Sub RemoveAccuracyProfile(CATBSTR name)

Remove Accuracy profile given name in controller.

Parameters:

name

This parameter contains Accuracy profile name.

Returns:

an HRESULT value.

Legal values:

S_OK if the operation succeeds

E_FAIL otherwise

Parameters:

name (str) –

Return type:

None

remove_motion_profile(name: str) → None

Note

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

o Sub RemoveMotionProfile(CATBSTR name)

Remove Motion profile given name in controller.

Parameters:

name

This parameter contains Motion profile name.

Returns:

an HRESULT value.

Legal values:

S_OK if the operation succeeds

E_FAIL otherwise

Parameters:

name (str) –

Return type:

None

remove_obj_frame_profile(name: str) → None

Note

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

o Sub RemoveObjFrameProfile(CATBSTR name)

Remove ObjFrame profile given name in controller.

Parameters:

name

This parameter contains ObjFrame profile name.

Returns:

an HRESULT value.

Legal values:

S_OK if the operation succeeds

E_FAIL otherwise

Parameters:

name (str) –

Return type:

None

remove_tool_profile(name: str) → None

Note

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

o Sub RemoveToolProfile(CATBSTR name)

Remove tool profile given name in controller.

Parameters:

name

This parameter contains tool profile name.

Returns:

an HRESULT value.

Legal values:

S_OK if the operation succeeds

E_FAIL otherwise

Parameters:

name (str) –

Return type:

None

set_current_accuracy_profile(profile: str) → None

Note

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

o Sub SetCurrentAccuracyProfile(CATBSTR profile)

Make Accuracy profile with given name as current tool profile being used by

controller.

Parameters:

profile

This parameter contains Accuracy profile name.

Returns:

an HRESULT value.

Legal values:

S_OK if the operation succeeds

E_FAIL otherwise

Parameters:

profile (str) –

Return type:

None

set_current_motion_profile(profile: str) → None

Note

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

o Sub SetCurrentMotionProfile(CATBSTR profile)

Make Motion profile with given name as current tool profile being used by

controller.

Parameters:

profile

This parameter contains Motion profile name.

Returns:

an HRESULT value.

Legal values:

S_OK if the operation succeeds

E_FAIL otherwise

Parameters:

profile (str) –

Return type:

None

set_current_obj_frame_profile(profile: str) → None

Note

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

o Sub SetCurrentObjFrameProfile(CATBSTR profile)

Make ObjFrame profile with given name as current ObjFrame profile being

used by controller.

Parameters:

profile

This parameter contains ObjFrame profile name.

Returns:

an HRESULT value.

Legal values:

S_OK if the operation succeeds

E_FAIL otherwise

Parameters:

profile (str) –

Return type:

None

set_current_tool_profile(profile: str) → None

Note

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

o Sub SetCurrentToolProfile(CATBSTR profile)

Make tool profile with given name as current tool profile being used by

controller.

Parameters:

profile

This parameter contains tool profile name.

Returns:

an HRESULT value.

Legal values:

S_OK if the operation succeeds

E_FAIL otherwise

Parameters:

profile (str) –

Return type:

None

set_name(name: str) → None

Note

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

o Sub SetName(CATBSTR name)

Set name of the generic controller.

Parameters:

name

name of the controller to be set.

Returns:

an HRESULT value.

Legal values:

S_OK if the operation succeeds

E_FAIL otherwise

Parameters:

name (str) –

Return type:

None