All Frameworks  Object Hierarchy  This Framework  Previous  Next  Indexes  

RRSSettingAtt (Object)

IUnknown
  |
  +---IDispatch
    |
    +---CATBaseUnknown
      |
      +---CATBaseDispatch
        |
        +---AnyObject
          |
          +---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.

Property Index

RCSDataLibDir
Gets value of "RCSDATA$LIB" parameter.
RRS2ConnectDownloaders
Gets value of "RRS2ConnectDownloaders" parameter.
RRS2ConsistencyCmdDownloaders
Gets value of "RRS2ConsistencyCmdDownloaders" parameter.
RRS2ControllerIdentifiers
Gets value of "RRS2ControllerIdentifiers" parameter.
RRS2DeleteAutoDownloadFilesAfterXfer
Gets value of "RRS2DeleteAutoDownloadFilesAfterXfer" parameter.
RRS2DfltControllerIdentifier
Gets value of "RRS2DfltControllerIdentifier" parameter.
RRS2DownloadDuringConnect
Gets value of "RRS2DownloadDuringConnect" parameter.
RRS2DownloadDuringSimRun
Gets value of "RRS2DownloadDuringSimRun" parameter.
RRS2DownloadInPartCoordinates
Gets value of "RRS2DownloadInPartCoordinates" parameter.
RRS2DownloadLogFileName
Gets value of "RRS2DownloadLogFileName" parameter.
RRS2FreePlaySimStepSize
Gets value of "RRS2FreePlaySimStepSize" parameter.
RRS2MainTaskProcessing
Gets value of "RRS2MainTaskProcessing" parameter.
RRS2MotionPlannerActiveDuringTeachOLP
Gets value of "RRS2MotionPlannerActiveDuringTeachOLP" parameter.
RRS2SimRunDownloaders
Gets value of "RRS2SimRunDownloaders" parameter.
RRS2StopVRCWhenSimStops
Gets value of "RRS2StopVRCWhenSimStops" parameter.
RRS2UpdateProgramOnDownload
Gets value of "RRS2UpdateProgramOnDownload" parameter.
RRS2UseVRCInverseKinematics
Gets value of "RRS2UseVRCInverseKinematics" parameter.
RRS2UseVRCTurnLimits
Gets value of "RRS2UseVRCTurnLimits" parameter.
RRSLibDir
Gets value of "RRS$LIB" parameter.
RRSServerFile
Gets value of "RRS Servers File" parameter.

Method Index

AddNewRRS2ControllerIdentifier
Adds new controller identifier into the list represented by the "RRS2ControllerIdentifiers" parameter.
GetRCSDataLibDirInfo
Retrieves environment informations for the "RCSDATA$LIB" parameter.
GetRRS2ConnectDownloadersInfo
Retrieves environment informations for the "RRS2ConnectDownloaders" parameter.
GetRRS2ConsistencyCmdDownloadersInfo
Retrieves environment informations for the "RRS2ConsistencyCmdDownloaders" parameter.
GetRRS2ControllerIdentifierAttributes
Gets various controller identifier-specific attributes associated with a given controller identifier.
GetRRS2ControllerIdentifiersInfo
Retrieves environment informations for the "RRS2ControllerIdentifiers" parameter.
GetRRS2DeleteAutoDownloadFilesAfterXferInfo
Retrieves environment informations for the "RRS2DeleteAutoDownloadFilesAfterXfer" parameter.
GetRRS2DfltControllerIdentifierInfo
Retrieves environment informations for the "RRS2DfltControllerIdentifier" parameter.
GetRRS2DownloadDuringConnectInfo
Retrieves environment informations for the "RRS2DownloadDuringConnect" parameter.
GetRRS2DownloadDuringSimRunInfo
Retrieves environment informations for the "RRS2DownloadDuringSimRun" parameter.
GetRRS2DownloadInPartCoordinatesInfo
Retrieves environment informations for the "RRS2DownloadInPartCoordinates" parameter.
GetRRS2DownloadLogFileNameInfo
Retrieves environment informations for the "RRS2DownloadLogFileName" parameter.
GetRRS2FreePlaySimStepSizeInfo
Retrieves environment informations for the "RRS2FreePlaySimStepSize" parameter.
GetRRS2MainTaskProcessingInfo
Retrieves environment informations for the "RRS2MainTaskProcessing" parameter.
GetRRS2MotionPlannerActiveDuringTeachOLPInfo
Retrieves environment informations for the "RRS2MotionPlannerActiveDuringTeachOLP" parameter.
GetRRS2SimRunDownloadersInfo
Retrieves environment informations for the "RRS2SimRunDownloaders" parameter.
GetRRS2StopVRCWhenSimStopsInfo
Retrieves environment informations for the "RRS2StopVRCWhenSimStops" parameter.
GetRRS2UpdateProgramOnDownloadInfo
Retrieves environment informations for the "RRS2UpdateProgramOnDownload" parameter.
GetRRS2UseVRCInverseKinematicsInfo
Retrieves environment informations for the "RRS2UseVRCInverseKinematics" parameter.
GetRRS2UseVRCTurnLimitsInfo
Retrieves environment informations for the "RRS2UseVRCTurnLimits" parameter.
GetRRSLibDirInfo
Retrieves environment informations for the "RRS$LIB" parameter.
GetRRSServerFileInfo
Retrieves environment informations for the "RRS Servers File" parameter.
SetRCSDataLibDirLock
Locks or unlocks the "RCSDATA$LIB" parameter.
SetRRS2ConnectDownloadersLock
Locks or unlocks the "RRS2ConnectDownloaders" parameter.
SetRRS2ConsistencyCmdDownloadersLock
Locks or unlocks the "RRS2ConsistencyCmdDownloaders" parameter.
SetRRS2ControllerIdentifiersLock
Locks or unlocks the "RRS2ControllerIdentifiers" parameter.
SetRRS2DeleteAutoDownloadFilesAfterXferLock
Locks or unlocks the "RRS2DeleteAutoDownloadFilesAfterXfer" parameter.
SetRRS2DfltControllerIdentifierLock
Locks or unlocks the "RRS2DfltControllerIdentifier" parameter.
SetRRS2DownloadDuringConnectLock
Locks or unlocks the "RRS2DownloadDuringConnect" parameter.
SetRRS2DownloadDuringSimRunLock
Locks or unlocks the "RRS2DownloadDuringSimRun" parameter.
SetRRS2DownloadInPartCoordinatesLock
Locks or unlocks the "RRS2DownloadInPartCoordinates" parameter.
SetRRS2DownloadLogFileNameLock
Locks or unlocks the "RRS2DownloadLogFileName" parameter.
SetRRS2FreePlaySimStepSizeLock
Locks or unlocks the "RRS2FreePlaySimStepSize" parameter.
SetRRS2MainTaskProcessingLock
Locks or unlocks the "RRS2MainTaskProcessing" parameter.
SetRRS2MotionPlannerActiveDuringTeachOLPLock
Locks or unlocks the "RRS2MotionPlannerActiveDuringTeachOLP" parameter.
SetRRS2SimRunDownloadersLock
Locks or unlocks the "RRS2SimRunDownloaders" parameter.
SetRRS2StopVRCWhenSimStopsLock
Locks or unlocks the "RRS2StopVRCWhenSimStops" parameter.
SetRRS2UpdateProgramOnDownloadLock
Locks or unlocks the "RRS2UpdateProgramOnDownload" parameter.
SetRRS2UseVRCInverseKinematicsLock
Locks or unlocks the "RRS2UseVRCInverseKinematics" parameter.
SetRRS2UseVRCTurnLimitsLock
Locks or unlocks the "RRS2UseVRCTurnLimits" parameter.
SetRRSLibDirLock
Locks or unlocks the "RRS$LIB" parameter.
SetRRSServerFileLock
Sets value of "RRS Servers File" parameter.

Properties


o Property RCSDataLibDir() As CATBSTR
Gets value of "RCSDATA$LIB" parameter.
Role: Gets value of "RCSDATA$LIB" parameter
Parameters:
oDataDir
Variable to return value in.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on Failure
o Property RRS2ConnectDownloaders() As CATBSTR
Gets value of "RRS2ConnectDownloaders" parameter.
Role: Gets value of "RRS2ConnectDownloaders" parameter.
Parameters:
oRRS2ConnectDownloaders
Variable to return value in. Formatted as an array of elements separated by ";" where each element corresponds to the controller at the same position in the "RRS2ControllersIdentifiers" list.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on Failure
o Property RRS2ConsistencyCmdDownloaders() As CATBSTR
Gets value of "RRS2ConsistencyCmdDownloaders" parameter.
Role: Gets value of "RRS2ConsistencyCmdDownloaders" parameter.
Parameters:
oRRS2ConsistencyCmdDownloaders
Variable to return value in. Formatted as an array of elements separated by ";" where each element corresponds to the controller at the same position in the
Returns:
Legal values:
S_OK : on Success
E_FAIL: on Failure
o Property RRS2ControllerIdentifiers() As CATBSTR
Gets value of "RRS2ControllerIdentifiers" parameter.
Role: Gets value of "RRS2ControllerIdentifiers" parameter.
Parameters:
oRRS2ControllerIdentifiers
Variable to return value in. Formatted as an array of elements separated by ";".
Returns:
Legal values:
S_OK : on Success
E_FAIL: on Failure
o Property RRS2DeleteAutoDownloadFilesAfterXfer() As boolean
Gets value of "RRS2DeleteAutoDownloadFilesAfterXfer" parameter.
Role: Gets value of "RRS2DeleteAutoDownloadFilesAfterXfer" parameter.
Parameters:
oRRS2DeleteAutoDownloadFilesAfterXfer
Variable to return value in.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on Failure
o Property RRS2DfltControllerIdentifier() As CATBSTR
Gets value of "RRS2DfltControllerIdentifier" parameter.
Role: Gets value of "RRS2DfltControllerIdentifier" parameter.
Parameters:
oRRS2DfltControllerIdentifier
Variable to return value in.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on Failure
o Property RRS2DownloadDuringConnect() As CATBSTR
Gets value of "RRS2DownloadDuringConnect" parameter.
Role: Gets value of "RRS2DownloadDuringConnect" parameter.
Parameters:
oRRS2DownloadDuringConnect
Variable to return value in. Formatted as an array of elements separated by ";" where each element has a value 1 for TRUE and 0 for FALSE, and corresponds to the controller at the same position in the "RRS2ControllersIdentifiers" list.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on Failure
o Property RRS2DownloadDuringSimRun() As CATBSTR
Gets value of "RRS2DownloadDuringSimRun" parameter.
Role: Gets value of "RRS2DownloadDuringSimRun" parameter.
Parameters:
oRRS2DownloadDuringSimRun
Variable to return value in. Formatted as an array of elements separated by ";" where each element has a value 1 for TRUE and 0 for FALSE, and corresponds to the controller at the same position in the "RRS2ControllersIdentifiers" list.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on Failure
o Property RRS2DownloadInPartCoordinates() As CATBSTR
Gets value of "RRS2DownloadInPartCoordinates" parameter.
Role: Gets value of "RRS2DownloadInPartCoordinates" parameter.
Parameters:
oRRS2DownloadInPartCoordinates
Variable to return value in. Formatted as an array of elements separated by ";" where each element has a value 1 for TRUE and 0 for FALSE, and corresponds to the controller at the same position in the "RRS2ControllersIdentifiers" list.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on Failure
o Property RRS2DownloadLogFileName() As CATBSTR
Gets value of "RRS2DownloadLogFileName" parameter.
Role: Gets value of "RRS2DownloadLogFileName" parameter.
Parameters:
oRRS2DownloadLogFileName
Variable to return value in.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on Failure
o Property RRS2FreePlaySimStepSize() As float
Gets value of "RRS2FreePlaySimStepSize" parameter.
Role: Gets value of "RRS2FreePlaySimStepSize" parameter.
Parameters:
oRRS2FreePlaySimStepSize
Variable to return value in seconds.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on Failure
o Property RRS2MainTaskProcessing() As boolean
Gets value of "RRS2MainTaskProcessing" parameter.
Role: Gets value of "RRS2MainTaskProcessing" parameter.
Parameters:
oRRS2MainTaskProcessing
Variable to return value in.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on Failure
o Property RRS2MotionPlannerActiveDuringTeachOLP() As boolean
Gets value of "RRS2MotionPlannerActiveDuringTeachOLP" parameter.
Role: Gets value of "RRS2MotionPlannerActiveDuringTeachOLP" parameter.
Parameters:
oRRS2MotionPlannerActiveDuringTeachOLP
Variable to return value in.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on Failure
o Property RRS2SimRunDownloaders() As CATBSTR
Gets value of "RRS2SimRunDownloaders" parameter.
Role: Gets value of "RRS2SimRunDownloaders" parameter.
Parameters:
oRRS2SimRunDownloaders
Variable to return value in. Formatted as an array of elements separated by ";" where each element corresponds to the controller at the same position in the "RRS2ControllersIdentifiers" list.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on Failure
o Property RRS2StopVRCWhenSimStops() As boolean
Gets value of "RRS2StopVRCWhenSimStops" parameter.
Role: Gets value of "RRS2StopVRCWhenSimStops" parameter.
Parameters:
oRRS2StopVRCWhenSimStops
Variable to return value in.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on Failure
o Property RRS2UpdateProgramOnDownload() As CATBSTR
Gets value of "RRS2UpdateProgramOnDownload" parameter.
Role: Gets value of "RRS2UpdateProgramOnDownload" parameter.
Parameters:
oRRS2UpdateProgramOnDownload
Variable to return value in. Formatted as an array of elements separated by ";" where each element has a value 1 for TRUE and 0 for FALSE, and corresponds to the controller at the same position in the "RRS2ControllersIdentifiers" list.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on Failure
o Property RRS2UseVRCInverseKinematics() As boolean
Gets value of "RRS2UseVRCInverseKinematics" parameter.
Role: Gets value of "RRS2UseVRCInverseKinematics" parameter.
Parameters:
oRRS2UseVRCInverseKinematics
Variable to return value in.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on Failure
o Property RRS2UseVRCTurnLimits() As boolean
Gets value of "RRS2UseVRCTurnLimits" parameter.
Role: Gets value of "RRS2UseVRCTurnLimits" parameter.
Parameters:
oRRS2UseVRCTurnLimits
Variable to return value in.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on Failure
o Property RRSLibDir() As CATBSTR
Gets value of "RRS$LIB" parameter.
Role: Gets value of "RRS$LIB" parameter
Parameters:
oLibDir
Variable to return value in.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on Failure
o Property RRSServerFile() As CATBSTR
Gets value of "RRS Servers File" parameter.
Role: Gets value of "RRS Servers File" parameter
Parameters:
oServerFile
Variable to return value in.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on Failure

Methods


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

Copyright © 2003, Dassault Systèmes. All rights reserved.