GenericObjFrameProfile (Object)

Interface to manage Generic Object frame Profile of Robot controller.

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

Methods


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 GetName( oName)
Gets name of the Object frame Profile.
Parameters:
oName
Name of the required Object frame Profile.
Returns:
an HRESULT value.
Legal values:
  • S_OK if the operation succeeds
  • E_FAIL otherwise
    • .
Sub GetObjectFrame( x, y, z, roll, pitch, yaw)
Retrieve the underlying x,y,z, roll, pitch, yaw of the Object Frame.
Parameters:
x,
The X Coordinate.
y,
The Y Coordinate.
z,
The Z Coordinate.
roll,
The roll Coordinate.
pitch,
The pitch Coordinate.
yaw,
The yaw Coordinate.
Returns:
an HRESULT value.
Legal values:
  • S_OK if the operation succeeds
  • E_FAIL otherwise
    • .
Sub SetName( iName)
Set name of the Object frame Profile.
Parameters:
iName
Name of the Object frame Profile to be set.
Returns:
an HRESULT value.
Legal values:
  • S_OK if the operation succeeds
  • E_FAIL otherwise
    • .
Sub SetObjectFrame( x, y, z, roll, pitch, yaw)
Set the underlying x,y,z, roll, pitch, yaw of the Object Frame.
Parameters:
x,
The X Coordinate.
y,
The Y Coordinate.
z,
The Z Coordinate.
roll,
The roll Coordinate.
pitch,
The pitch Coordinate.
yaw,
The yaw Coordinate.
Returns:
an HRESULT value.
Legal values:
  • S_OK if the operation succeeds
  • E_FAIL otherwise
    • .