pycatia.dnb_robot_interfaces.rrs_setting_att

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.rrs_setting_att.RRSSettingAtt(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

System.SettingController

RRSSettingAtt

Interface to handle parameters of IGRIP RRS Tools Options Tab page Role: This

interface is implemented by a component which represents the controller of

IGRIP RRS Tools Options parameter settings.

Methods to set value of each parameter

Methods to get value of each parameter

Methods to get information on each parameter

Methods to lock/unlock value of each parameter

add_new_rrs2_controller_identifier(i_controller_identifier: str) → None

Note

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

o Sub AddNewRRS2ControllerIdentifier(CATBSTR

iControllerIdentifier)

Adds new controller identifier into the list represented by the

“RRS2ControllerIdentifiers” parameter. If it is already in the list, does

nothing.

Role: Adds new controller identifier to “RRS2ControllerIdentifiers”

list.

Parameters:

iControllerIdentifier

Controller Identifier to be added to the list.

Returns:

Legal values:

S_OK : on Success

E_FAIL: on Failure

Parameters:

i_controller_identifier (str) –

Return type:

None

get_rcs_data_lib_dir_info(io_admin_level: str, io_locked: str) → bool

Note

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

o Func GetRCSDataLibDirInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the “RCSDATA$LIB”

parameter.

Role:Retrieves the state of the “RCSDATA$LIB” parameter in the current

environment.

Parameters:

ioAdminLevel

If the parameter is locked, AdminLevel gives the administration

level that imposes the value of the parameter.

If the parameter is not locked, AdminLevel gives the administration

level that will give the value of the parameter after a reset.

ioLocked

Indicates if the parameter has been locked.

Returns:

Indicates if the parameter has been explicitly modified or remain to

the administrated value.

Parameters:

• io_admin_level (str) –

• io_locked (str) –

Return type:

bool

get_rrs2_connect_downloaders_info(io_admin_level: str, io_locked: str) → bool

Note

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

o Func GetRRS2ConnectDownloadersInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the “RRS2ConnectDownloaders”

parameter.

Role:Retrieves the state of the “RRS2ConnectDownloaders” parameter in the

current environment.

Parameters:

ioAdminLevel

If the parameter is locked, AdminLevel gives the administration

level that imposes the value of the parameter.

If the parameter is not locked, AdminLevel gives the administration

level that will give the value of the parameter after a reset.

ioLocked

Indicates if the parameter has been locked.

Returns:

Indicates if the parameter has been explicitly modified or remain to

the administrated value.

Parameters:

• io_admin_level (str) –

• io_locked (str) –

Return type:

bool

get_rrs2_consistency_cmd_downloaders_info(io_admin_level: str, io_locked: str) → bool

Note

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

o Func GetRRS2ConsistencyCmdDownloadersInfo(CATBSTR

ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the “RRS2ConsistencyCmdDownloaders”

parameter.

Role:Retrieves the state of the “RRS2ConsistencyCmdDownloaders” parameter

in the current environment.

Parameters:

ioAdminLevel

If the parameter is locked, AdminLevel gives the administration

level that imposes the value of the parameter.

If the parameter is not locked, AdminLevel gives the administration

level that will give the value of the parameter after a reset.

ioLocked

Indicates if the parameter has been locked.

Returns:

Indicates if the parameter has been explicitly modified or remain to

the administrated value.

Parameters:

• io_admin_level (str) –

• io_locked (str) –

Return type:

bool

get_rrs2_controller_identifier_attributes(i_controller_identifier: str, o_rrs2_connect_downloader: str, o_rrs2_sim_run_downloader: str, o_rrs2_consistency_cmd_downloader: str, o_rrs2_download_during_connect: bool, o_rrs2_download_during_sim_run: bool, o_rrs2_update_program_on_download: bool, o_rrs2_download_in_part_coordinates: bool) → None

Note

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

o Sub GetRRS2ControllerIdentifierAttributes(CATBSTR

iControllerIdentifier,

CATBSTR oRRS2ConnectDownloader,

CATBSTR oRRS2SimRunDownloader,

CATBSTR oRRS2ConsistencyCmdDownloader,

boolean oRRS2DownloadDuringConnect,

boolean oRRS2DownloadDuringSimRun,

boolean oRRS2UpdateProgramOnDownload,

boolean oRRS2DownloadInPartCoordinates)

Gets various controller identifier-specific attributes associated with a

given controller identifier.

Role: Gets various attributes associated with a given controller

identifier.

Parameters:

iControllerIdentifier

Controller Identifier whose attributes are requested.

iControllerIdentifier

Controller Identifier whose attributes are requested.

Returns:

Legal values:

S_OK : on Success

E_FAIL: on Failure

Parameters:

• i_controller_identifier (str) –

• o_rrs2_connect_downloader (str) –

• o_rrs2_sim_run_downloader (str) –

• o_rrs2_consistency_cmd_downloader (str) –

• o_rrs2_download_during_connect (bool) –

• o_rrs2_download_during_sim_run (bool) –

• o_rrs2_update_program_on_download (bool) –

• o_rrs2_download_in_part_coordinates (bool) –

Return type:

None

get_rrs2_controller_identifiers_info(io_admin_level: str, io_locked: str) → bool

Note

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

o Func GetRRS2ControllerIdentifiersInfo(CATBSTR

ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the “RRS2ControllerIdentifiers”

parameter.

Role:Retrieves the state of the “RRS2ControllerIdentifiers” parameter in

the current environment.

Parameters:

ioAdminLevel

If the parameter is locked, AdminLevel gives the administration

level that imposes the value of the parameter.

If the parameter is not locked, AdminLevel gives the administration

level that will give the value of the parameter after a reset.

ioLocked

Indicates if the parameter has been locked.

Returns:

Indicates if the parameter has been explicitly modified or remain to

the administrated value.

Parameters:

• io_admin_level (str) –

• io_locked (str) –

Return type:

bool

get_rrs2_delete_auto_download_files_after_xfer_info(io_admin_level: str, io_locked: str) → bool

Note

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

o Func GetRRS2DeleteAutoDownloadFilesAfterXferInfo(CATBSTR

ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the

“RRS2DeleteAutoDownloadFilesAfterXfer” parameter.

Role:Retrieves the state of the “RRS2DeleteAutoDownloadFilesAfterXfer”

parameter in the current environment.

Parameters:

ioAdminLevel

If the parameter is locked, AdminLevel gives the administration

level that imposes the value of the parameter.

If the parameter is not locked, AdminLevel gives the administration

level that will give the value of the parameter after a reset.

ioLocked

Indicates if the parameter has been locked.

Returns:

Indicates if the parameter has been explicitly modified or remain to

the administrated value.

Parameters:

• io_admin_level (str) –

• io_locked (str) –

Return type:

bool

get_rrs2_dflt_controller_identifier_info(io_admin_level: str, io_locked: str) → bool

Note

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

o Func GetRRS2DfltControllerIdentifierInfo(CATBSTR

ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the “RRS2DfltControllerIdentifier”

parameter.

Role:Retrieves the state of the “RRS2DfltControllerIdentifier” parameter in

the current environment.

Parameters:

ioAdminLevel

If the parameter is locked, AdminLevel gives the administration

level that imposes the value of the parameter.

If the parameter is not locked, AdminLevel gives the administration

level that will give the value of the parameter after a reset.

ioLocked

Indicates if the parameter has been locked.

Returns:

Indicates if the parameter has been explicitly modified or remain to

the administrated value.

Parameters:

• io_admin_level (str) –

• io_locked (str) –

Return type:

bool

get_rrs2_download_during_connect_info(io_admin_level: str, io_locked: str) → bool

Note

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

o Func GetRRS2DownloadDuringConnectInfo(CATBSTR

ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the “RRS2DownloadDuringConnect”

parameter.

Role:Retrieves the state of the “RRS2DownloadDuringConnect” parameter in

the current environment.

Parameters:

ioAdminLevel

If the parameter is locked, AdminLevel gives the administration

level that imposes the value of the parameter.

If the parameter is not locked, AdminLevel gives the administration

level that will give the value of the parameter after a reset.

ioLocked

Indicates if the parameter has been locked.

Returns:

Indicates if the parameter has been explicitly modified or remain to

the administrated value.

Parameters:

• io_admin_level (str) –

• io_locked (str) –

Return type:

bool

get_rrs2_download_during_sim_run_info(io_admin_level: str, io_locked: str) → bool

Note

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

o Func GetRRS2DownloadDuringSimRunInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the “RRS2DownloadDuringSimRun”

parameter.

Role:Retrieves the state of the “RRS2DownloadDuringSimRun” parameter in the

current environment.

Parameters:

ioAdminLevel

If the parameter is locked, AdminLevel gives the administration

level that imposes the value of the parameter.

If the parameter is not locked, AdminLevel gives the administration

level that will give the value of the parameter after a reset.

ioLocked

Indicates if the parameter has been locked.

Returns:

Indicates if the parameter has been explicitly modified or remain to

the administrated value.

Parameters:

• io_admin_level (str) –

• io_locked (str) –

Return type:

bool

get_rrs2_download_in_part_coordinates_info(io_admin_level: str, io_locked: str) → bool

Note

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

o Func GetRRS2DownloadInPartCoordinatesInfo(CATBSTR

ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the “RRS2DownloadInPartCoordinates”

parameter.

Role:Retrieves the state of the “RRS2DownloadInPartCoordinates” parameter

in the current environment.

Parameters:

ioAdminLevel

If the parameter is locked, AdminLevel gives the administration

level that imposes the value of the parameter.

If the parameter is not locked, AdminLevel gives the administration

level that will give the value of the parameter after a reset.

ioLocked

Indicates if the parameter has been locked.

Returns:

Indicates if the parameter has been explicitly modified or remain to

the administrated value.

Parameters:

• io_admin_level (str) –

• io_locked (str) –

Return type:

bool

get_rrs2_download_log_file_name_info(io_admin_level: str, io_locked: str) → bool

Note

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

o Func GetRRS2DownloadLogFileNameInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the “RRS2DownloadLogFileName”

parameter.

Role:Retrieves the state of the “RRS2DownloadLogFileName” parameter in the

current environment.

Parameters:

ioAdminLevel

If the parameter is locked, AdminLevel gives the administration

level that imposes the value of the parameter.

If the parameter is not locked, AdminLevel gives the administration

level that will give the value of the parameter after a reset.

ioLocked

Indicates if the parameter has been locked.

Returns:

Indicates if the parameter has been explicitly modified or remain to

the administrated value.

Parameters:

• io_admin_level (str) –

• io_locked (str) –

Return type:

bool

get_rrs2_free_play_sim_step_size_info(io_admin_level: str, io_locked: str) → bool

Note

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

o Func GetRRS2FreePlaySimStepSizeInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the “RRS2FreePlaySimStepSize”

parameter.

Role:Retrieves the state of the “RRS2FreePlaySimStepSize” parameter in the

current environment.

Parameters:

ioAdminLevel

If the parameter is locked, AdminLevel gives the administration

level that imposes the value of the parameter.

If the parameter is not locked, AdminLevel gives the administration

level that will give the value of the parameter after a reset.

ioLocked

Indicates if the parameter has been locked.

Returns:

Indicates if the parameter has been explicitly modified or remain to

the administrated value.

Parameters:

• io_admin_level (str) –

• io_locked (str) –

Return type:

bool

get_rrs2_main_task_processing_info(io_admin_level: str, io_locked: str) → bool

Note

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

o Func GetRRS2MainTaskProcessingInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the “RRS2MainTaskProcessing”

parameter.

Role:Retrieves the state of the “RRS2MainTaskProcessing” parameter in the

current environment.

Parameters:

ioAdminLevel

If the parameter is locked, AdminLevel gives the administration

level that imposes the value of the parameter.

If the parameter is not locked, AdminLevel gives the administration

level that will give the value of the parameter after a reset.

ioLocked

Indicates if the parameter has been locked.

Returns:

Indicates if the parameter has been explicitly modified or remain to

the administrated value.

Parameters:

• io_admin_level (str) –

• io_locked (str) –

Return type:

bool

get_rrs2_motion_planner_active_during_teach_olp_info(io_admin_level: str, io_locked: str) → bool

Note

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

o Func GetRRS2MotionPlannerActiveDuringTeachOLPInfo(CATBSTR

ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the

“RRS2MotionPlannerActiveDuringTeachOLP” parameter.

Role:Retrieves the state of the “RRS2MotionPlannerActiveDuringTeachOLP”

parameter in the current environment.

Parameters:

ioAdminLevel

If the parameter is locked, AdminLevel gives the administration

level that imposes the value of the parameter.

If the parameter is not locked, AdminLevel gives the administration

level that will give the value of the parameter after a reset.

ioLocked

Indicates if the parameter has been locked.

Returns:

Indicates if the parameter has been explicitly modified or remain to

the administrated value.

Parameters:

• io_admin_level (str) –

• io_locked (str) –

Return type:

bool

get_rrs2_sim_run_downloaders_info(io_admin_level: str, io_locked: str) → bool

Note

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

o Func GetRRS2SimRunDownloadersInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the “RRS2SimRunDownloaders”

parameter.

Role:Retrieves the state of the “RRS2SimRunDownloaders” parameter in the

current environment.

Parameters:

ioAdminLevel

If the parameter is locked, AdminLevel gives the administration

level that imposes the value of the parameter.

If the parameter is not locked, AdminLevel gives the administration

level that will give the value of the parameter after a reset.

ioLocked

Indicates if the parameter has been locked.

Returns:

Indicates if the parameter has been explicitly modified or remain to

the administrated value.

Parameters:

• io_admin_level (str) –

• io_locked (str) –

Return type:

bool

get_rrs2_stop_vrc_when_sim_stops_info(io_admin_level: str, io_locked: str) → bool

Note

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

o Func GetRRS2StopVRCWhenSimStopsInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the “RRS2StopVRCWhenSimStops”

parameter.

Role:Retrieves the state of the “RRS2StopVRCWhenSimStops” parameter in the

current environment.

Parameters:

ioAdminLevel

If the parameter is locked, AdminLevel gives the administration

level that imposes the value of the parameter.

If the parameter is not locked, AdminLevel gives the administration

level that will give the value of the parameter after a reset.

ioLocked

Indicates if the parameter has been locked.

Returns:

Indicates if the parameter has been explicitly modified or remain to

the administrated value.

Parameters:

• io_admin_level (str) –

• io_locked (str) –

Return type:

bool

get_rrs2_update_program_on_download_info(io_admin_level: str, io_locked: str) → bool

Note

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

o Func GetRRS2UpdateProgramOnDownloadInfo(CATBSTR

ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the “RRS2UpdateProgramOnDownload”

parameter.

Role:Retrieves the state of the “RRS2UpdateProgramOnDownload” parameter in

the current environment.

Parameters:

ioAdminLevel

If the parameter is locked, AdminLevel gives the administration

level that imposes the value of the parameter.

If the parameter is not locked, AdminLevel gives the administration

level that will give the value of the parameter after a reset.

ioLocked

Indicates if the parameter has been locked.

Returns:

Indicates if the parameter has been explicitly modified or remain to

the administrated value.

Parameters:

• io_admin_level (str) –

• io_locked (str) –

Return type:

bool

get_rrs2_use_vrc_inverse_kinematics_info(io_admin_level: str, io_locked: str) → bool

Note

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

o Func GetRRS2UseVRCInverseKinematicsInfo(CATBSTR

ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the “RRS2UseVRCInverseKinematics”

parameter.

Role:Retrieves the state of the “RRS2UseVRCInverseKinematics” parameter in

the current environment.

Parameters:

ioAdminLevel

If the parameter is locked, AdminLevel gives the administration

level that imposes the value of the parameter.

If the parameter is not locked, AdminLevel gives the administration

level that will give the value of the parameter after a reset.

ioLocked

Indicates if the parameter has been locked.

Returns:

Indicates if the parameter has been explicitly modified or remain to

the administrated value.

Parameters:

• io_admin_level (str) –

• io_locked (str) –

Return type:

bool

get_rrs2_use_vrc_turn_limits_info(io_admin_level: str, io_locked: str) → bool

Note

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

o Func GetRRS2UseVRCTurnLimitsInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the “RRS2UseVRCTurnLimits”

parameter.

Role:Retrieves the state of the “RRS2UseVRCTurnLimits” parameter in the

current environment.

Parameters:

ioAdminLevel

If the parameter is locked, AdminLevel gives the administration

level that imposes the value of the parameter.

If the parameter is not locked, AdminLevel gives the administration

level that will give the value of the parameter after a reset.

ioLocked

Indicates if the parameter has been locked.

Returns:

Indicates if the parameter has been explicitly modified or remain to

the administrated value.

Parameters:

• io_admin_level (str) –

• io_locked (str) –

Return type:

bool

get_rrs_lib_dir_info(io_admin_level: str, io_locked: str) → bool

Note

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

o Func GetRRSLibDirInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the “RRS$LIB”

parameter.

Role:Retrieves the state of the “RRS$LIB” parameter in the current

environment.

Parameters:

ioAdminLevel

If the parameter is locked, AdminLevel gives the administration

level that imposes the value of the parameter.

If the parameter is not locked, AdminLevel gives the administration

level that will give the value of the parameter after a reset.

ioLocked

Indicates if the parameter has been locked.

Returns:

Indicates if the parameter has been explicitly modified or remain to

the administrated value.

Parameters:

• io_admin_level (str) –

• io_locked (str) –

Return type:

bool

get_rrs_server_file_info(io_admin_level: str, io_locked: str) → bool

Note

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

o Func GetRRSServerFileInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the “RRS Servers File”

parameter.

Role:Retrieves the state of the “RRS Servers File” parameter in the current

environment.

Parameters:

ioAdminLevel

If the parameter is locked, AdminLevel gives the administration

level that imposes the value of the parameter.

If the parameter is not locked, AdminLevel gives the administration

level that will give the value of the parameter after a reset.

ioLocked

Indicates if the parameter has been locked.

Returns:

Indicates if the parameter has been explicitly modified or remain to

the administrated value.

Parameters:

• io_admin_level (str) –

• io_locked (str) –

Return type:

bool

set_rcs_data_lib_dir_lock(i_locked: bool) → None

Note

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

o Sub SetRCSDataLibDirLock(boolean iLocked)

Locks or unlocks the “RCSDATA$LIB” parameter.

Role: Locks or unlocks the “RCSDATA$LIB” parameter if the operation is

allowed in the current administrated environment. In user mode this method will

always return E_FAIL.

Parameters:

iLocked

the locking operation to be performed Legal

values:

1 : to lock the parameter.

0 : to unlock the parameter.

Returns:

Legal values:

S_OK : on Success

E_FAIL: on Failure

Parameters:

i_locked (bool) –

Return type:

None

set_rrs2_connect_downloaders_lock(i_locked: bool) → None

Note

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

o Sub SetRRS2ConnectDownloadersLock(boolean iLocked)

Locks or unlocks the “RRS2ConnectDownloaders” parameter.

Role: Locks or unlocks the “RRS2ConnectDownloaders” parameter if the

operation is allowed in the current administrated environment. In user mode

this method will always return E_FAIL.

Parameters:

iLocked

the locking operation to be performed Legal

values:

1 : to lock the parameter.

0 : to unlock the parameter.

Returns:

Legal values:

S_OK : on Success

E_FAIL: on Failure

Parameters:

i_locked (bool) –

Return type:

None

set_rrs2_consistency_cmd_downloaders_lock(i_locked: bool) → None

Note

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

o Sub SetRRS2ConsistencyCmdDownloadersLock(boolean iLocked)

Locks or unlocks the “RRS2ConsistencyCmdDownloaders”

parameter.

Role: Locks or unlocks the “RRS2ConsistencyCmdDownloaders” parameter if the

operation is allowed in the current administrated environment. In user mode

this method will always return E_FAIL.

Parameters:

iLocked

the locking operation to be performed Legal

values:

1 : to lock the parameter.

0 : to unlock the parameter.

Returns:

Legal values:

S_OK : on Success

E_FAIL: on Failure

Parameters:

i_locked (bool) –

Return type:

None

set_rrs2_controller_identifiers_lock(i_locked: bool) → None

Note

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

o Sub SetRRS2ControllerIdentifiersLock(boolean iLocked)

Locks or unlocks the “RRS2ControllerIdentifiers”

parameter.

Role: Locks or unlocks the “RRS2ControllerIdentifiers” parameter if the

operation is allowed in the current administrated environment. In user mode

this method will always return E_FAIL.

Parameters:

iLocked

the locking operation to be performed Legal

values:

1 : to lock the parameter.

0 : to unlock the parameter.

Returns:

Legal values:

S_OK : on Success

E_FAIL: on Failure

Parameters:

i_locked (bool) –

Return type:

None

set_rrs2_delete_auto_download_files_after_xfer_lock(i_locked: bool) → None

Note

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

o Sub SetRRS2DeleteAutoDownloadFilesAfterXferLock(boolean

iLocked)

Locks or unlocks the “RRS2DeleteAutoDownloadFilesAfterXfer”

parameter.

Role: Locks or unlocks the “RRS2DeleteAutoDownloadFilesAfterXfer” parameter

if the operation is allowed in the current administrated environment. In user

mode this method will always return E_FAIL.

Parameters:

iLocked

the locking operation to be performed Legal

values:

1 : to lock the parameter.

0 : to unlock the parameter.

Returns:

Legal values:

S_OK : on Success

E_FAIL: on Failure

Parameters:

i_locked (bool) –

Return type:

None

set_rrs2_dflt_controller_identifier_lock(i_locked: bool) → None

Note

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

o Sub SetRRS2DfltControllerIdentifierLock(boolean iLocked)

Locks or unlocks the “RRS2DfltControllerIdentifier”

parameter.

Role: Locks or unlocks the “RRS2DfltControllerIdentifier” parameter if the

operation is allowed in the current administrated environment. In user mode

this method will always return E_FAIL.

Parameters:

iLocked

the locking operation to be performed Legal

values:

1 : to lock the parameter.

0 : to unlock the parameter.

Returns:

Legal values:

S_OK : on Success

E_FAIL: on Failure

Parameters:

i_locked (bool) –

Return type:

None

set_rrs2_download_during_connect_lock(i_locked: bool) → None

Note

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

o Sub SetRRS2DownloadDuringConnectLock(boolean iLocked)

Locks or unlocks the “RRS2DownloadDuringConnect”

parameter.

Role: Locks or unlocks the “RRS2DownloadDuringConnect” parameter if the

operation is allowed in the current administrated environment. In user mode

this method will always return E_FAIL.

Parameters:

iLocked

the locking operation to be performed Legal

values:

1 : to lock the parameter.

0 : to unlock the parameter.

Returns:

Legal values:

S_OK : on Success

E_FAIL: on Failure

Parameters:

i_locked (bool) –

Return type:

None

set_rrs2_download_during_sim_run_lock(i_locked: bool) → None

Note

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

o Sub SetRRS2DownloadDuringSimRunLock(boolean iLocked)

Locks or unlocks the “RRS2DownloadDuringSimRun” parameter.

Role: Locks or unlocks the “RRS2DownloadDuringSimRun” parameter if the

operation is allowed in the current administrated environment. In user mode

this method will always return E_FAIL.

Parameters:

iLocked

the locking operation to be performed Legal

values:

1 : to lock the parameter.

0 : to unlock the parameter.

Returns:

Legal values:

S_OK : on Success

E_FAIL: on Failure

Parameters:

i_locked (bool) –

Return type:

None

set_rrs2_download_in_part_coordinates_lock(i_locked: bool) → None

Note

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

o Sub SetRRS2DownloadInPartCoordinatesLock(boolean iLocked)

Locks or unlocks the “RRS2DownloadInPartCoordinates”

parameter.

Role: Locks or unlocks the “RRS2DownloadInPartCoordinates” parameter if the

operation is allowed in the current administrated environment. In user mode

this method will always return E_FAIL.

Parameters:

iLocked

the locking operation to be performed Legal

values:

1 : to lock the parameter.

0 : to unlock the parameter.

Returns:

Legal values:

S_OK : on Success

E_FAIL: on Failure

Parameters:

i_locked (bool) –

Return type:

None

set_rrs2_download_log_file_name_lock(i_locked: bool) → None

Note

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

o Sub SetRRS2DownloadLogFileNameLock(boolean iLocked)

Locks or unlocks the “RRS2DownloadLogFileName” parameter.

Role: Locks or unlocks the “RRS2DownloadLogFileName” parameter if the

operation is allowed in the current administrated environment. In user mode

this method will always return E_FAIL.

Parameters:

iLocked

the locking operation to be performed Legal

values:

1 : to lock the parameter.

0 : to unlock the parameter.

Returns:

Legal values:

S_OK : on Success

E_FAIL: on Failure

Parameters:

i_locked (bool) –

Return type:

None

set_rrs2_free_play_sim_step_size_lock(i_locked: bool) → None

Note

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

o Sub SetRRS2FreePlaySimStepSizeLock(boolean iLocked)

Locks or unlocks the “RRS2FreePlaySimStepSize” parameter.

Role: Locks or unlocks the “RRS2FreePlaySimStepSize” parameter if the

operation is allowed in the current administrated environment. In user mode

this method will always return E_FAIL.

Parameters:

iLocked

the locking operation to be performed Legal

values:

1 : to lock the parameter.

0 : to unlock the parameter.

Returns:

Legal values:

S_OK : on Success

E_FAIL: on Failure

Parameters:

i_locked (bool) –

Return type:

None

set_rrs2_main_task_processing_lock(i_locked: bool) → None

Note

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

o Sub SetRRS2MainTaskProcessingLock(boolean iLocked)

Locks or unlocks the “RRS2MainTaskProcessing” parameter.

Role: Locks or unlocks the “RRS2MainTaskProcessing” parameter if the

operation is allowed in the current administrated environment. In user mode

this method will always return E_FAIL.

Parameters:

iLocked

the locking operation to be performed Legal

values:

1 : to lock the parameter.

0 : to unlock the parameter.

Returns:

Legal values:

S_OK : on Success

E_FAIL: on Failure

Parameters:

i_locked (bool) –

Return type:

None

set_rrs2_motion_planner_active_during_teach_olp_lock(i_locked: bool) → None

Note

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

o Sub SetRRS2MotionPlannerActiveDuringTeachOLPLock(boolean

iLocked)

Locks or unlocks the “RRS2MotionPlannerActiveDuringTeachOLP”

parameter.

Role: Locks or unlocks the “RRS2MotionPlannerActiveDuringTeachOLP”

parameter if the operation is allowed in the current administrated environment.

In user mode this method will always return E_FAIL.

Parameters:

iLocked

the locking operation to be performed Legal

values:

1 : to lock the parameter.

0 : to unlock the parameter.

Returns:

Legal values:

S_OK : on Success

E_FAIL: on Failure

Parameters:

i_locked (bool) –

Return type:

None

set_rrs2_sim_run_downloaders_lock(i_locked: bool) → None

Note

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

o Sub SetRRS2SimRunDownloadersLock(boolean iLocked)

Locks or unlocks the “RRS2SimRunDownloaders” parameter.

Role: Locks or unlocks the “RRS2SimRunDownloaders” parameter if the

operation is allowed in the current administrated environment. In user mode

this method will always return E_FAIL.

Parameters:

iLocked

the locking operation to be performed Legal

values:

1 : to lock the parameter.

0 : to unlock the parameter.

Returns:

Legal values:

S_OK : on Success

E_FAIL: on Failure

Parameters:

i_locked (bool) –

Return type:

None

set_rrs2_stop_vrc_when_sim_stops_lock(i_locked: bool) → None

Note

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

o Sub SetRRS2StopVRCWhenSimStopsLock(boolean iLocked)

Locks or unlocks the “RRS2StopVRCWhenSimStops” parameter.

Role: Locks or unlocks the “RRS2StopVRCWhenSimStops” parameter if the

operation is allowed in the current administrated environment. In user mode

this method will always return E_FAIL.

Parameters:

iLocked

the locking operation to be performed Legal

values:

1 : to lock the parameter.

0 : to unlock the parameter.

Returns:

Legal values:

S_OK : on Success

E_FAIL: on Failure

Parameters:

i_locked (bool) –

Return type:

None

set_rrs2_update_program_on_download_lock(i_locked: bool) → None

Note

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

o Sub SetRRS2UpdateProgramOnDownloadLock(boolean iLocked)

Locks or unlocks the “RRS2UpdateProgramOnDownload”

parameter.

Role: Locks or unlocks the “RRS2UpdateProgramOnDownload” parameter if the

operation is allowed in the current administrated environment. In user mode

this method will always return E_FAIL.

Parameters:

iLocked

the locking operation to be performed Legal

values:

1 : to lock the parameter.

0 : to unlock the parameter.

Returns:

Legal values:

S_OK : on Success

E_FAIL: on Failure

Parameters:

i_locked (bool) –

Return type:

None

set_rrs2_use_vrc_inverse_kinematics_lock(i_locked: bool) → None

Note

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

o Sub SetRRS2UseVRCInverseKinematicsLock(boolean iLocked)

Locks or unlocks the “RRS2UseVRCInverseKinematics”

parameter.

Role: Locks or unlocks the “RRS2UseVRCInverseKinematics” parameter if the

operation is allowed in the current administrated environment. In user mode

this method will always return E_FAIL.

Parameters:

iLocked

the locking operation to be performed Legal

values:

1 : to lock the parameter.

0 : to unlock the parameter.

Returns:

Legal values:

S_OK : on Success

E_FAIL: on Failure

Parameters:

i_locked (bool) –

Return type:

None

set_rrs2_use_vrc_turn_limits_lock(i_locked: bool) → None

Note

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

o Sub SetRRS2UseVRCTurnLimitsLock(boolean iLocked)

Locks or unlocks the “RRS2UseVRCTurnLimits” parameter.

Role: Locks or unlocks the “RRS2UseVRCTurnLimits” parameter if the

operation is allowed in the current administrated environment. In user mode

this method will always return E_FAIL.

Parameters:

iLocked

the locking operation to be performed Legal

values:

1 : to lock the parameter.

0 : to unlock the parameter.

Returns:

Legal values:

S_OK : on Success

E_FAIL: on Failure

Parameters:

i_locked (bool) –

Return type:

None

set_rrs_lib_dir_lock(i_locked: bool) → None

Note

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

o Sub SetRRSLibDirLock(boolean iLocked)

Locks or unlocks the “RRS$LIB” parameter.

Role:Locks or unlocks the “RRS$LIB” parameter if it is possible in the

current administrative context. In user mode this method will always return

E_FAIL.

Parameters:

iLocked

the locking operation to be performed Legal

values:

TRUE : to lock the parameter.

FALSE: to unlock the parameter.

Parameters:

i_locked (bool) –

Return type:

None

set_rrs_server_file_lock(i_locked: bool) → None

Note

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

o Sub SetRRSServerFileLock(boolean iLocked)

Sets value of “RRS Servers File” parameter.

Role: Sets value of “RRS Servers File” parameter

Parameters:

iServerFile

New value.

Returns:

Legal values:

S_OK : on Success

E_FAIL: on Failure

Parameters:

i_locked (bool) –

Return type:

None