GenericAccuracyProfile (Object)

Interface to manage Generic Accuracy Profile of Robot controller.

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

Methods


Sub GetAccuracyType( accuracy)
Get the accuracy type for the profile.
Parameters:
accurancy
accurancy type to get, could be ACCURACY_TYPE_DISTANCE / ACCURACY_TYPE_SPEED
Returns:
An HRESULT.
Legal values:
  • S_OK if the operation succeeds
  • E_FAIL otherwise
  • .
Sub GetAccuracyValue( value)
Retrieves accuracy value of the profile.
Parameters:
value
This parameter contains accuracy value.
Returns:
An HRESULT.
Legal values:
  • S_OK if the operation succeeds
  • E_FAIL otherwise
  • .
Sub GetController( oController)
Retrieves controller owning the profile.
Parameters:
oController
This parameter contains pointer to controller.
Returns:
An HRESULT.
Legal values:
  • S_OK if the operation succeeds
  • E_FAIL otherwise
  • .
Sub GetFlyByMode( oMode)
Gets On/Off status of Flyby mode.
Parameters:
oMode
mode indicating On/Off status.
Returns:
an HRESULT value.
Legal values:
  • S_OK if the operation succeeds
  • E_FAIL otherwise
  • .
Sub GetName( oName)
Gets name of the Accuracy Profile.
Parameters:
oName
Name of the required Accuracy Profile.
Returns:
an HRESULT value.
Legal values:
  • S_OK if the operation succeeds
  • E_FAIL otherwise
  • .
Sub SetAccuracyType( accuracy)
Set the accuracy type for the profile.
Parameters:
accurancy
accurancy type to set, could be ACCURACY_TYPE_DISTANCE / ACCURACY_TYPE_SPEED
Returns:
An HRESULT.
Legal values:
  • S_OK if the operation succeeds
  • E_FAIL otherwise
  • .
Sub SetAccuracyValue( value)
Set accuracy value of the profile.
Parameters:
value
This parameter is percentage or absolute value, depending on accurancy type.
Returns:
An HRESULT.
Legal values:
  • S_OK if the operation succeeds
  • E_FAIL otherwise
  • .
Sub SetFlyByMode( iMode)
Switch On/Off Flyby mode.
Parameters:
iMode
mode indicating On/Off status.
Returns:
an HRESULT value.
Legal values:
  • S_OK if the operation succeeds
  • E_FAIL otherwise
  • .
Sub SetName( iName)
Set name of the Accuracy Profile.
Parameters:
iName
Name of the Accuracy Profile to be set.
Returns:
an HRESULT value.
Legal values:
  • S_OK if the operation succeeds
  • E_FAIL otherwise
  • .