All Frameworks Class Hierarchy This Framework Indexes
DNBRobotInterfaces Interface DNBIRobRRSSettingAtt
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface DNBIRobRRSSettingAtt
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
Method Index
- o
AddNewRRS2ControllerIdentifier(CATUnicodeString&)
- Adds new controller identifier into the list represented by the
"RRS2ControllerIdentifiers" parameter.
- o
GetRCSDataLibDirInfo(CATSettingInfo*)
- Gets information on "RCSDATA$LIB" parameter.
- o
GetRCSDataLibDir(CATUnicodeString&)
- Gets value of "RCSDATA$LIB" parameter.
- o
GetRRS2ConnectDownloadersInfo(CATSettingInfo*)
- Gets information on "RRS2ConnectDownloaders" parameter.
- o
GetRRS2ConnectDownloaders(CATUnicodeString&)
- Gets value of "RRS2ConnectDownloaders" parameter.
- o
GetRRS2ConsistencyCmdDownloadersInfo(CATSettingInfo*)
- Gets information on "RRS2ConsistencyCmdDownloaders" parameter.
- o
GetRRS2ConsistencyCmdDownloaders(CATUnicodeString&)
- Gets value of "RRS2ConsistencyCmdDownloaders" parameter.
- o
GetRRS2ControllerIdentifierAttributes(CATUnicodeString&,CATUnicodeString&,CATUnicodeString&,CATUnicodeString&,CATBoolean&,CATBoolean&,CATBoolean&,CATBoolean&)
- Gets various controller identifier-specific attributes associated
with a given controller identifier.
- o
GetRRS2ControllerIdentifiersInfo(CATSettingInfo*)
- Gets information on "RRS2ControllerIdentifiers" parameter.
- o
GetRRS2ControllerIdentifiers(CATUnicodeString&)
- Gets value of "RRS2ControllerIdentifiers" parameter.
- o
GetRRS2DeleteAutoDownloadFilesAfterXferInfo(CATSettingInfo*)
- Gets information on "RRS2DeleteAutoDownloadFilesAfterXfer" parameter.
- o
GetRRS2DeleteAutoDownloadFilesAfterXfer(CATBoolean&)
- Gets value of "RRS2DeleteAutoDownloadFilesAfterXfer" parameter.
- o
GetRRS2DfltControllerIdentifierInfo(CATSettingInfo*)
- Gets information on "RRS2DfltControllerIdentifier" parameter.
- o
GetRRS2DfltControllerIdentifier(CATUnicodeString&)
- Gets value of "RRS2DfltControllerIdentifier" parameter.
- o
GetRRS2DownloadDuringConnectInfo(CATSettingInfo*)
- Gets information on "RRS2DownloadDuringConnect" parameter.
- o
GetRRS2DownloadDuringConnect(CATUnicodeString&)
- Gets value of "RRS2DownloadDuringConnect" parameter.
- o
GetRRS2DownloadDuringSimRunInfo(CATSettingInfo*)
- Gets information on "RRS2DownloadDuringSimRun" parameter.
- o
GetRRS2DownloadDuringSimRun(CATUnicodeString&)
- Gets value of "RRS2DownloadDuringSimRun" parameter.
- o
GetRRS2DownloadInPartCoordinatesInfo(CATSettingInfo*)
- Gets information on "RRS2DownloadInPartCoordinates" parameter.
- o
GetRRS2DownloadInPartCoordinates(CATUnicodeString&)
- Gets value of "RRS2DownloadInPartCoordinates" parameter.
- o
GetRRS2DownloadLogFileNameInfo(CATSettingInfo*)
- Gets information on "RRS2DownloadLogFileName" parameter.
- o
GetRRS2DownloadLogFileName(CATUnicodeString&)
- Gets value of "RRS2DownloadLogFileName" parameter.
- o
GetRRS2FreePlaySimStepSizeInfo(CATSettingInfo*)
- Gets information on "RRS2FreePlaySimStepSize" parameter.
- o
GetRRS2FreePlaySimStepSize(float&)
- Gets value of "RRS2FreePlaySimStepSize" parameter.
- o
GetRRS2MainTaskProcessingInfo(CATSettingInfo*)
- Gets information on "RRS2MainTaskProcessing" parameter.
- o
GetRRS2MainTaskProcessing(CATBoolean&)
- Gets value of "RRS2MainTaskProcessing" parameter.
- o
GetRRS2MotionPlannerActiveDuringTeachOLPInfo(CATSettingInfo*)
- Gets information on "RRS2MotionPlannerActiveDuringTeachOLP" parameter.
- o
GetRRS2MotionPlannerActiveDuringTeachOLP(CATBoolean&)
- Gets value of "RRS2MotionPlannerActiveDuringTeachOLP" parameter.
- o
GetRRS2SimRunDownloadersInfo(CATSettingInfo*)
- Gets information on "RRS2SimRunDownloaders" parameter.
- o
GetRRS2SimRunDownloaders(CATUnicodeString&)
- Gets value of "RRS2SimRunDownloaders" parameter.
- o
GetRRS2StopVRCWhenSimStopsInfo(CATSettingInfo*)
- Gets information on "RRS2StopVRCWhenSimStops" parameter.
- o
GetRRS2StopVRCWhenSimStops(CATBoolean&)
- Gets value of "RRS2StopVRCWhenSimStops" parameter.
- o
GetRRS2UpdateProgramOnDownloadInfo(CATSettingInfo*)
- Gets information on "RRS2UpdateProgramOnDownloads" parameter.
- o
GetRRS2UpdateProgramOnDownload(CATUnicodeString&)
- Gets value of "RRS2UpdateProgramOnDownloads" parameter.
- o
GetRRS2UseVRCInverseKinematicsInfo(CATSettingInfo*)
- Gets information on "RRS2UseVRCInverseKinematics" parameter.
- o
GetRRS2UseVRCInverseKinematics(CATBoolean&)
- Gets value of "RRS2UseVRCInverseKinematics" parameter.
- o
GetRRS2UseVRCTurnLimitsInfo(CATSettingInfo*)
- Gets information on "RRS2UseVRCTurnLimits" parameter.
- o
GetRRS2UseVRCTurnLimits(CATBoolean&)
- Gets value of "RRS2UseVRCTurnLimits" parameter.
- o
GetRRSLibDirInfo(CATSettingInfo*)
- Gets information on "RRS$LIB" parameter.
- o
GetRRSLibDir(CATUnicodeString&)
- Gets value of "RRS$LIB" parameter.
- o
GetRRSServerFileInfo(CATSettingInfo*)
- Gets information on "RRS Servers File" parameter.
- o
GetRRSServerFile(CATUnicodeString&)
- Gets value of "RRS Servers File" parameter.
- o
SetRCSDataLibDirLock(unsigned char)
- Locks or unlocks the "RCSDATA$LIB" parameter.
- o
SetRCSDataLibDir(CATUnicodeString&)
- Sets value of "RCSDATA$LIB" parameter.
- o
SetRRS2ConnectDownloadersLock(unsigned char)
- Locks or unlocks the "RRS2ConnectDownloaders" parameter.
- o
SetRRS2ConnectDownloaders(CATUnicodeString&)
- Sets value of "RRS2ConnectDownloaders" parameter.
- o
SetRRS2ConsistencyCmdDownloadersLock(unsigned char)
- Locks or unlocks the "RRS2ConsistencyCmdDownloaders" parameter.
- o
SetRRS2ConsistencyCmdDownloaders(CATUnicodeString&)
- Sets value of "RRS2ConsistencyCmdDownloaders" parameter.
- o
SetRRS2ControllerIdentifiersLock(unsigned char)
- Locks or unlocks the "RRS2ControllerIdentifiers" parameter.
- o
SetRRS2ControllerIdentifiers(CATUnicodeString&)
- Sets value of "RRS2ControllerIdentifiers" parameter.
- o
SetRRS2DeleteAutoDownloadFilesAfterXferLock(unsigned char)
- Locks or unlocks the "RRS2DeleteAutoDownloadFilesAfterXfer" parameter.
- o
SetRRS2DeleteAutoDownloadFilesAfterXfer(CATBoolean)
- Sets value of "RRS2DeleteAutoDownloadFilesAfterXfer" parameter.
- o
SetRRS2DfltControllerIdentifierLock(unsigned char)
- Locks or unlocks the "RRS2DfltControllerIdentifier" parameter.
- o
SetRRS2DfltControllerIdentifier(CATUnicodeString&)
- Sets value of "RRS2DfltControllerIdentifier" parameter.
- o
SetRRS2DownloadDuringConnectLock(unsigned char)
- Locks or unlocks the "RRS2DownloadDuringConnect" parameter.
- o
SetRRS2DownloadDuringConnect(CATUnicodeString&)
- Sets value of "RRS2DownloadDuringConnect" parameter.
- o
SetRRS2DownloadDuringSimRunLock(unsigned char)
- Locks or unlocks the "RRS2DownloadDuringSimRun" parameter.
- o
SetRRS2DownloadDuringSimRun(CATUnicodeString&)
- Sets value of "RRS2DownloadDuringSimRun" parameter.
- o
SetRRS2DownloadInPartCoordinatesLock(unsigned char)
- Locks or unlocks the "RRS2DownloadInPartCoordinates" parameter.
- o
SetRRS2DownloadInPartCoordinates(CATUnicodeString&)
- Sets value of "RRS2DownloadInPartCoordinates" parameter.
- o
SetRRS2DownloadLogFileNameLock(unsigned char)
- Locks or unlocks the "RRS2DownloadLogFileName" parameter.
- o
SetRRS2DownloadLogFileName(CATUnicodeString&)
- Sets value of "RRS2DownloadLogFileName" parameter.
- o
SetRRS2FreePlaySimStepSizeLock(unsigned char)
- Locks or unlocks the "RRS2FreePlaySimStepSize" parameter.
- o
SetRRS2FreePlaySimStepSize(float)
- Sets value of "RRS2FreePlaySimStepSize" parameter.
- o
SetRRS2MainTaskProcessingLock(unsigned char)
- Locks or unlocks the "RRS2MainTaskProcessing" parameter.
- o
SetRRS2MainTaskProcessing(CATBoolean)
- Sets value of "RRS2MainTaskProcessing" parameter.
- o
SetRRS2MotionPlannerActiveDuringTeachOLPLock(unsigned char)
- Locks or unlocks the "RRS2MotionPlannerActiveDuringTeachOLP" parameter.
- o
SetRRS2MotionPlannerActiveDuringTeachOLP(CATBoolean)
- Sets value of "RRS2MotionPlannerActiveDuringTeachOLP" parameter.
- o
SetRRS2SimRunDownloadersLock(unsigned char)
- Locks or unlocks the "RRS2SimRunDownloaders" parameter.
- o
SetRRS2SimRunDownloaders(CATUnicodeString&)
- Sets value of "RRS2SimRunDownloaders" parameter.
- o
SetRRS2StopVRCWhenSimStopsLock(unsigned char)
- Locks or unlocks the "RRS2StopVRCWhenSimStops" parameter.
- o
SetRRS2StopVRCWhenSimStops(CATBoolean)
- Sets value of "RRS2StopVRCWhenSimStops" parameter.
- o
SetRRS2UpdateProgramOnDownloadLock(unsigned char)
- Locks or unlocks the "RRS2UpdateProgramOnDownloads" parameter.
- o
SetRRS2UpdateProgramOnDownload(CATUnicodeString&)
- Sets value of "RRS2UpdateProgramOnDownloads" parameter.
- o
SetRRS2UseVRCInverseKinematicsLock(unsigned char)
- Locks or unlocks the "RRS2UseVRCInverseKinematics" parameter.
- o
SetRRS2UseVRCInverseKinematics(CATBoolean)
- Sets value of "RRS2UseVRCInverseKinematics" parameter.
- o
SetRRS2UseVRCTurnLimitsLock(unsigned char)
- Locks or unlocks the "RRS2UseVRCTurnLimits" parameter.
- o
SetRRS2UseVRCTurnLimits(CATBoolean)
- Sets value of "RRS2UseVRCTurnLimits" parameter.
- o
SetRRSLibDirLock(unsigned char)
- Locks or unlocks the "RRS$LIB" parameter.
- o
SetRRSLibDir(CATUnicodeString&)
- Sets value of "RRS$LIB" parameter.
- o
SetRRSServerFileLock(unsigned char)
- Locks or unlocks the "RRS Servers File" parameter.
- o
SetRRSServerFile(CATUnicodeString&)
- Sets value of "RRS Servers File" parameter.
Methods
o AddNewRRS2ControllerIdentifier
| public virtual AddNewRRS2ControllerIdentifier( | | 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 GetRCSDataLibDirInfo
| public virtual GetRCSDataLibDirInfo( | | oInfo) |
-
Gets information on "RCSDATA$LIB" parameter.
Role: Gets information on "RCSDATA$LIB" parameter
- Parameters:
-
- oInfo
- Variable to return information in.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on Failure
o GetRCSDataLibDir
| public virtual GetRCSDataLibDir( | | oDataDir) |
-
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 GetRRS2ConnectDownloadersInfo
| public virtual GetRRS2ConnectDownloadersInfo( | | oInfo) |
-
Gets information on "RRS2ConnectDownloaders" parameter.
Role: Gets information on "RRS2ConnectDownloaders" parameter.
- Parameters:
-
- oInfo
- Variable to return information in.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on Failure
o GetRRS2ConnectDownloaders
| public virtual GetRRS2ConnectDownloaders( | | oRRS2ConnectDownloaders) |
-
Gets value of "RRS2ConnectDownloaders" parameter.
Role: Gets value of "RRS2ConnectDownloaders" parameter.
Each element corresponds to the controller at the
same position in the "RRS2ControllersIdentifiers" list.
- 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 GetRRS2ConsistencyCmdDownloadersInfo
| public virtual GetRRS2ConsistencyCmdDownloadersInfo( | | oInfo) |
-
Gets information on "RRS2ConsistencyCmdDownloaders" parameter.
Role: Gets information on "RRS2ConsistencyCmdDownloaders" parameter.
- Parameters:
-
- oInfo
- Variable to return information in.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on Failure
o GetRRS2ConsistencyCmdDownloaders
| public virtual GetRRS2ConsistencyCmdDownloaders( | | oRRS2ConsistencyCmdDownloaders) |
-
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
"RRS2ControllersIdentifiers" list.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on Failure
o GetRRS2ControllerIdentifierAttributes
| public virtual GetRRS2ControllerIdentifierAttributes( | | iControllerIdentifier, |
| | oRRS2ConnectDownloader, |
| | oRRS2SimRunDownloader, |
| | oRRS2ConsistencyCmdDownloader, |
| | oRRS2DownloadDuringConnect, |
| | oRRS2DownloadDuringSimRun, |
| | oRRS2UpdateProgramOnDownload, |
| | 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 GetRRS2ControllerIdentifiersInfo
| public virtual GetRRS2ControllerIdentifiersInfo( | | oInfo) |
-
Gets information on "RRS2ControllerIdentifiers" parameter.
Role: Gets information on "RRS2ControllerIdentifiers" parameter.
- Parameters:
-
- oInfo
- Variable to return information in.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on Failure
o GetRRS2ControllerIdentifiers
| public virtual GetRRS2ControllerIdentifiers( | | oRRS2ControllerIdentifiers) |
-
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 GetRRS2DeleteAutoDownloadFilesAfterXferInfo
| public virtual GetRRS2DeleteAutoDownloadFilesAfterXferInfo( | | oInfo) |
-
Gets information on "RRS2DeleteAutoDownloadFilesAfterXfer" parameter.
Role: Gets information on "RRS2DeleteAutoDownloadFilesAfterXfer" parameter.
- Parameters:
-
- oInfo
- Variable to return information in.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on Failure
o GetRRS2DeleteAutoDownloadFilesAfterXfer
| public virtual GetRRS2DeleteAutoDownloadFilesAfterXfer( | | oRRS2DeleteAutoDownloadFilesAfterXfer) |
-
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 GetRRS2DfltControllerIdentifierInfo
| public virtual GetRRS2DfltControllerIdentifierInfo( | | oInfo) |
-
Gets information on "RRS2DfltControllerIdentifier" parameter.
Role: Gets information on "RRS2DfltControllerIdentifier" parameter.
- Parameters:
-
- oInfo
- Variable to return information in.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on Failure
o GetRRS2DfltControllerIdentifier
| public virtual GetRRS2DfltControllerIdentifier( | | oRRS2DfltControllerIdentifier) |
-
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 GetRRS2DownloadDuringConnectInfo
| public virtual GetRRS2DownloadDuringConnectInfo( | | oInfo) |
-
Gets information on "RRS2DownloadDuringConnect" parameter.
Role: Gets information on "RRS2DownloadDuringConnect" parameter.
- Parameters:
-
- oInfo
- Variable to return information in.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on Failure
o GetRRS2DownloadDuringConnect
| public virtual GetRRS2DownloadDuringConnect( | | oRRS2DownloadDuringConnect) |
-
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 GetRRS2DownloadDuringSimRunInfo
| public virtual GetRRS2DownloadDuringSimRunInfo( | | oInfo) |
-
Gets information on "RRS2DownloadDuringSimRun" parameter.
Role: Gets information on "RRS2DownloadDuringSimRun" parameter.
- Parameters:
-
- oInfo
- Variable to return information in.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on Failure
o GetRRS2DownloadDuringSimRun
| public virtual GetRRS2DownloadDuringSimRun( | | oRRS2DownloadDuringSimRun) |
-
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 GetRRS2DownloadInPartCoordinatesInfo
| public virtual GetRRS2DownloadInPartCoordinatesInfo( | | oInfo) |
-
Gets information on "RRS2DownloadInPartCoordinates" parameter.
Role: Gets information on "RRS2DownloadInPartCoordinates" parameter.
- Parameters:
-
- oInfo
- Variable to return information in.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on Failure
o GetRRS2DownloadInPartCoordinates
| public virtual GetRRS2DownloadInPartCoordinates( | | oRRS2DownloadInPartCoordinates) |
-
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 GetRRS2DownloadLogFileNameInfo
| public virtual GetRRS2DownloadLogFileNameInfo( | | oInfo) |
-
Gets information on "RRS2DownloadLogFileName" parameter.
Role: Gets information on "RRS2DownloadLogFileName" parameter.
- Parameters:
-
- oInfo
- Variable to return information in.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on Failure
o GetRRS2DownloadLogFileName
| public virtual GetRRS2DownloadLogFileName( | | oRRS2DownloadLogFileName) |
-
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 GetRRS2FreePlaySimStepSizeInfo
| public virtual GetRRS2FreePlaySimStepSizeInfo( | | oInfo) |
-
Gets information on "RRS2FreePlaySimStepSize" parameter.
Role: Gets information on "RRS2FreePlaySimStepSize" parameter.
- Parameters:
-
- oInfo
- Variable to return information in.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on Failure
o GetRRS2FreePlaySimStepSize
| public virtual GetRRS2FreePlaySimStepSize( | | oRRS2FreePlaySimStepSize) |
-
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 GetRRS2MainTaskProcessingInfo
| public virtual GetRRS2MainTaskProcessingInfo( | | oInfo) |
-
Gets information on "RRS2MainTaskProcessing" parameter.
Role: Gets information on "RRS2MainTaskProcessing" parameter.
- Parameters:
-
- oInfo
- Variable to return information in.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on Failure
o GetRRS2MainTaskProcessing
| public virtual GetRRS2MainTaskProcessing( | | oRRS2MainTaskProcessing) |
-
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 GetRRS2MotionPlannerActiveDuringTeachOLPInfo
| public virtual GetRRS2MotionPlannerActiveDuringTeachOLPInfo( | | oInfo) |
-
Gets information on "RRS2MotionPlannerActiveDuringTeachOLP" parameter.
Role: Gets information on
"RRS2MotionPlannerActiveDuringTeachOLP" parameter.
- Parameters:
-
- oInfo
- Variable to return information in.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on Failure
o GetRRS2MotionPlannerActiveDuringTeachOLP
| public virtual GetRRS2MotionPlannerActiveDuringTeachOLP( | | oRRS2MotionPlannerActiveDuringTeachOLP) |
-
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 GetRRS2SimRunDownloadersInfo
| public virtual GetRRS2SimRunDownloadersInfo( | | oInfo) |
-
Gets information on "RRS2SimRunDownloaders" parameter.
Role: Gets information on "RRS2SimRunDownloaders" parameter.
- Parameters:
-
- oInfo
- Variable to return information in.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on Failure
o GetRRS2SimRunDownloaders
| public virtual GetRRS2SimRunDownloaders( | | oRRS2SimRunDownloaders) |
-
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 GetRRS2StopVRCWhenSimStopsInfo
| public virtual GetRRS2StopVRCWhenSimStopsInfo( | | oInfo) |
-
Gets information on "RRS2StopVRCWhenSimStops" parameter.
Role: Gets information on "RRS2StopVRCWhenSimStops" parameter.
- Parameters:
-
- oInfo
- Variable to return information in.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on Failure
o GetRRS2StopVRCWhenSimStops
| public virtual GetRRS2StopVRCWhenSimStops( | | oRRS2StopVRCWhenSimStops) |
-
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 GetRRS2UpdateProgramOnDownloadInfo
| public virtual GetRRS2UpdateProgramOnDownloadInfo( | | oInfo) |
-
Gets information on "RRS2UpdateProgramOnDownloads" parameter.
Role: Gets information on "RRS2UpdateProgramOnDownloads" parameter.
- Parameters:
-
- oInfo
- Variable to return information in.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on Failure
o GetRRS2UpdateProgramOnDownload
| public virtual GetRRS2UpdateProgramOnDownload( | | oRRS2UpdateProgramOnDownloads) |
-
Gets value of "RRS2UpdateProgramOnDownloads" parameter.
Role: Gets value of "RRS2UpdateProgramOnDownloads" parameter.
- Parameters:
-
- oRRS2UpdateProgramOnDownloads
- 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 GetRRS2UseVRCInverseKinematicsInfo
| public virtual GetRRS2UseVRCInverseKinematicsInfo( | | oInfo) |
-
Gets information on "RRS2UseVRCInverseKinematics" parameter.
Role: Gets information on "RRS2UseVRCInverseKinematics" parameter.
- Parameters:
-
- oInfo
- Variable to return information in.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on Failure
o GetRRS2UseVRCInverseKinematics
| public virtual GetRRS2UseVRCInverseKinematics( | | oRRS2UseVRCInverseKinematics) |
-
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 GetRRS2UseVRCTurnLimitsInfo
| public virtual GetRRS2UseVRCTurnLimitsInfo( | | oInfo) |
-
Gets information on "RRS2UseVRCTurnLimits" parameter.
Role: Gets information on "RRS2UseVRCTurnLimits" parameter.
- Parameters:
-
- oInfo
- Variable to return information in.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on Failure
o GetRRS2UseVRCTurnLimits
| public virtual GetRRS2UseVRCTurnLimits( | | oRRS2UseVRCTurnLimits) |
-
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 GetRRSLibDirInfo
| public virtual GetRRSLibDirInfo( | | oInfo) |
-
Gets information on "RRS$LIB" parameter.
Role: Gets information on "RRS$LIB" parameter
- Parameters:
-
- oInfo
- Variable to return information in.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on Failure
o GetRRSLibDir
| public virtual GetRRSLibDir( | | oLibDir) |
-
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 GetRRSServerFileInfo
| public virtual GetRRSServerFileInfo( | | oInfo) |
-
Gets information on "RRS Servers File" parameter.
Role: Gets information on "RRS Servers File" parameter
- Parameters:
-
- oInfo
- Variable to return information in.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on Failure
o GetRRSServerFile
| public virtual GetRRSServerFile( | | oServerFile) |
-
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
o SetRCSDataLibDirLock
| public virtual SetRCSDataLibDirLock( | | 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 SetRCSDataLibDir
| public virtual SetRCSDataLibDir( | | iDataDir) |
-
Sets value of "RCSDATA$LIB" parameter.
Role: Sets value of "RCSDATA$LIB" parameter
- Parameters:
-
- iDataDir
- New value.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on Failure
o SetRRS2ConnectDownloadersLock
| public virtual SetRRS2ConnectDownloadersLock( | | 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 SetRRS2ConnectDownloaders
| public virtual SetRRS2ConnectDownloaders( | | iRRS2ConnectDownloaders) |
-
Sets value of "RRS2ConnectDownloaders" parameter.
Role: Sets value of "RRS2ConnectDownloaders" parameter.
Each element corresponds to the controller at the
same position in the "RRS2ControllersIdentifiers" list.
- Parameters:
-
- iRRS2ConnectDownloaders
- New value. 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 SetRRS2ConsistencyCmdDownloadersLock
| public virtual SetRRS2ConsistencyCmdDownloadersLock( | | 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 SetRRS2ConsistencyCmdDownloaders
| public virtual SetRRS2ConsistencyCmdDownloaders( | | iRRS2ConsistencyCmdDownloaders) |
-
Sets value of "RRS2ConsistencyCmdDownloaders" parameter.
Role: Sets value of "RRS2ConsistencyCmdDownloaders" parameter.
- Parameters:
-
- iRRS2ConsistencyCmdDownloaders
- New value. 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 SetRRS2ControllerIdentifiersLock
| public virtual SetRRS2ControllerIdentifiersLock( | | 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 SetRRS2ControllerIdentifiers
| public virtual SetRRS2ControllerIdentifiers( | | iRRS2ControllerIdentifiers) |
-
Sets value of "RRS2ControllerIdentifiers" parameter.
Role: Sets value of "RRS2ControllerIdentifiers" parameter.
- Parameters:
-
- iRRS2ControllerIdentifiers
- New value. Formatted as an array of
elements separated by ";".
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on Failure
o SetRRS2DeleteAutoDownloadFilesAfterXferLock
| public virtual SetRRS2DeleteAutoDownloadFilesAfterXferLock( | | 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 SetRRS2DeleteAutoDownloadFilesAfterXfer
| public virtual SetRRS2DeleteAutoDownloadFilesAfterXfer( | | iRRS2DeleteAutoDownloadFilesAfterXfer) |
-
Sets value of "RRS2DeleteAutoDownloadFilesAfterXfer" parameter.
Role: Sets value of "RRS2DeleteAutoDownloadFilesAfterXfer" parameter.
- Parameters:
-
- iRRS2DeleteAutoDownloadFilesAfterXfer
- New value.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on Failure
o SetRRS2DfltControllerIdentifierLock
| public virtual SetRRS2DfltControllerIdentifierLock( | | 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 SetRRS2DfltControllerIdentifier
| public virtual SetRRS2DfltControllerIdentifier( | | iRRS2DfltControllerIdentifier) |
-
Sets value of "RRS2DfltControllerIdentifier" parameter.
Role: Sets value of "RRS2DfltControllerIdentifier" parameter.
- Parameters:
-
- iRRS2DfltControllerIdentifier
- New value.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on Failure
o SetRRS2DownloadDuringConnectLock
| public virtual SetRRS2DownloadDuringConnectLock( | | 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 SetRRS2DownloadDuringConnect
| public virtual SetRRS2DownloadDuringConnect( | | iRRS2DownloadDuringConnect) |
-
Sets value of "RRS2DownloadDuringConnect" parameter.
Role: Sets value of "RRS2DownloadDuringConnect" parameter.
- Parameters:
-
- iRRS2DownloadDuringConnect
- New value. 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 SetRRS2DownloadDuringSimRunLock
| public virtual SetRRS2DownloadDuringSimRunLock( | | 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 SetRRS2DownloadDuringSimRun
| public virtual SetRRS2DownloadDuringSimRun( | | iRRS2DownloadDuringSimRun) |
-
Sets value of "RRS2DownloadDuringSimRun" parameter.
Role: Sets value of "RRS2DownloadDuringSimRun" parameter.
- Parameters:
-
- iRRS2DownloadDuringSimRun
- New value. 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 SetRRS2DownloadInPartCoordinatesLock
| public virtual SetRRS2DownloadInPartCoordinatesLock( | | 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 SetRRS2DownloadInPartCoordinates
| public virtual SetRRS2DownloadInPartCoordinates( | | iRRS2DownloadInPartCoordinates) |
-
Sets value of "RRS2DownloadInPartCoordinates" parameter.
Role: Sets value of "RRS2DownloadInPartCoordinates" parameter.
- Parameters:
-
- iRRS2DownloadInPartCoordinates
- New value. 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 SetRRS2DownloadLogFileNameLock
| public virtual SetRRS2DownloadLogFileNameLock( | | 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 SetRRS2DownloadLogFileName
| public virtual SetRRS2DownloadLogFileName( | | iRRS2DownloadLogFileName) |
-
Sets value of "RRS2DownloadLogFileName" parameter.
Role: Sets value of "RRS2DownloadLogFileName" parameter.
- Parameters:
-
- iRRS2DownloadLogFileName
- New value.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on Failure
o SetRRS2FreePlaySimStepSizeLock
| public virtual SetRRS2FreePlaySimStepSizeLock( | | 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 SetRRS2FreePlaySimStepSize
| public virtual SetRRS2FreePlaySimStepSize( | | iRRS2FreePlaySimStepSize) |
-
Sets value of "RRS2FreePlaySimStepSize" parameter.
Role: Sets value of "RRS2FreePlaySimStepSize" parameter.
- Parameters:
-
- iRRS2FreePlaySimStepSize
- New value in seconds.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on Failure
o SetRRS2MainTaskProcessingLock
| public virtual SetRRS2MainTaskProcessingLock( | | 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 SetRRS2MainTaskProcessing
| public virtual SetRRS2MainTaskProcessing( | | iRRS2MainTaskProcessing) |
-
Sets value of "RRS2MainTaskProcessing" parameter.
Role: Sets value of "RRS2MainTaskProcessing" parameter.
- Parameters:
-
- iRRS2MainTaskProcessing
- New value.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on Failure
o SetRRS2MotionPlannerActiveDuringTeachOLPLock
| public virtual SetRRS2MotionPlannerActiveDuringTeachOLPLock( | | 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 SetRRS2MotionPlannerActiveDuringTeachOLP
| public virtual SetRRS2MotionPlannerActiveDuringTeachOLP( | | iRRS2MotionPlannerActiveDuringTeachOLP) |
-
Sets value of "RRS2MotionPlannerActiveDuringTeachOLP" parameter.
Role: Sets value of "RRS2MotionPlannerActiveDuringTeachOLP"
parameter.
- Parameters:
-
- iRRS2MotionPlannerActiveDuringTeachOLP
- New value.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on Failure
o SetRRS2SimRunDownloadersLock
| public virtual SetRRS2SimRunDownloadersLock( | | 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 SetRRS2SimRunDownloaders
| public virtual SetRRS2SimRunDownloaders( | | iRRS2SimRunDownloaders) |
-
Sets value of "RRS2SimRunDownloaders" parameter.
Role: Sets value of "RRS2SimRunDownloaders" parameter.
- Parameters:
-
- iRRS2SimRunDownloaders
- New value. 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 SetRRS2StopVRCWhenSimStopsLock
| public virtual SetRRS2StopVRCWhenSimStopsLock( | | 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 SetRRS2StopVRCWhenSimStops
| public virtual SetRRS2StopVRCWhenSimStops( | | iRRS2StopVRCWhenSimStops) |
-
Sets value of "RRS2StopVRCWhenSimStops" parameter.
Role: Sets value of "RRS2StopVRCWhenSimStops" parameter.
- Parameters:
-
- iRRS2StopVRCWhenSimStops
- New value.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on Failure
o SetRRS2UpdateProgramOnDownloadLock
| public virtual SetRRS2UpdateProgramOnDownloadLock( | | iLocked) |
-
Locks or unlocks the "RRS2UpdateProgramOnDownloads" parameter.
Role: Locks or unlocks the "RRS2UpdateProgramOnDownloads"
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 SetRRS2UpdateProgramOnDownload
| public virtual SetRRS2UpdateProgramOnDownload( | | iRRS2UpdateProgramOnDownloads) |
-
Sets value of "RRS2UpdateProgramOnDownloads" parameter.
Role: Sets value of "RRS2UpdateProgramOnDownloads" parameter.
- Parameters:
-
- iRRS2UpdateProgramOnDownloads
- New value. 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 SetRRS2UseVRCInverseKinematicsLock
| public virtual SetRRS2UseVRCInverseKinematicsLock( | | 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 SetRRS2UseVRCInverseKinematics
| public virtual SetRRS2UseVRCInverseKinematics( | | iRRS2UseVRCInverseKinematics) |
-
Sets value of "RRS2UseVRCInverseKinematics" parameter.
Role: Sets value of "RRS2UseVRCInverseKinematics" parameter.
- Parameters:
-
- iRRS2UseVRCInverseKinematics
- New value.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on Failure
o SetRRS2UseVRCTurnLimitsLock
| public virtual SetRRS2UseVRCTurnLimitsLock( | | 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 SetRRS2UseVRCTurnLimits
| public virtual SetRRS2UseVRCTurnLimits( | | iRRS2UseVRCTurnLimits) |
-
Sets value of "RRS2UseVRCTurnLimits" parameter.
Role: Sets value of "RRS2UseVRCTurnLimits" parameter.
- Parameters:
-
- iRRS2MotionPlannerActiveDuringTeachOLP
- New value.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on Failure
o SetRRSLibDirLock
| public virtual SetRRSLibDirLock( | | iLocked) |
-
Locks or unlocks the "RRS$LIB" parameter.
Role: Locks or unlocks the "RRS$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 SetRRSLibDir
| public virtual SetRRSLibDir( | const | iLibDir) |
-
Sets value of "RRS$LIB" parameter.
Role: Sets value of "RRS$LIB" parameter
- Parameters:
-
- iLibDir
- New value.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on Failure
o SetRRSServerFileLock
| public virtual SetRRSServerFileLock( | | iLocked) |
-
Locks or unlocks the "RRS Servers File" parameter.
Role: Locks or unlocks the "RRS Servers File" 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 SetRRSServerFile
| public virtual SetRRSServerFile( | | iServerFile) |
-
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
This object is included in the file: DNBIRobRRSSettingAtt.h
If needed, your Imakefile.mk should include the module: DNBRobotItf