All Frameworks  Object Hierarchy  This Framework  Indexes

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.

Method Index

GetController
Retrieves controller owning the profile.
GetName
Gets name of the Object frame Profile.
GetObjectFrame
Retrieve the underlying x,y,z, roll, pitch, yaw of the Object Frame.
SetName
Set name of the Object frame Profile.
SetObjectFrame
Set the underlying x,y,z, roll, pitch, yaw of the Object Frame.

Methods


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

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