All Frameworks  Object Hierarchy  This Framework  Indexes

RobGenericController (Object)

INTERFACE : DNBIARobGenericController
DESCRIPTION This allows add/remove and get/set of controller profiles

Method Index

AddAccuracyProfile
Add a new Accuracy Profile into controller.
AddMotionProfile
Add a new Motion Profile into controller.
AddObjFrameProfile
Add a new ObjFrame Profile into controller.
AddToolProfile
Add a new Tool Profile into controller.
GetAccuracyProfileCount
Get number of Accuracy profiles in controller.
GetAccuracyProfile
Get Accuracy profile given name.
GetAccuracyProfiles
Get Accuracy profiles list in controller.
GetCurrentAccuracyProfile
Get current Accuracy profile name used in controller.
GetCurrentMotionProfile
Get current Motion profile name used in controller.
GetCurrentObjFrameProfile
Get current ObjFrame profile name used in controller.
GetCurrentToolProfile
Get current tool profile name used in controller.
GetMotionProfileCount
Get number of Motion profiles in controller.
GetMotionProfile
Get Motion profile given name.
GetMotionProfiles
Get Motion profiles list in controller.
GetName
Retreives name of the generic controller.
GetObjFrameProfileCount
Get number of ObjFrame profiles in controller.
GetObjFrameProfile
Get ObjFrame profile given name.
GetObjFrameProfiles
Get ObjFrame profiles list in controller.
GetToolProfileCount
Get number of tool profiles in controller.
GetToolProfile
Get tool profile given name.
GetToolProfiles
Get tool profiles list in controller.
HasAccuracyProfile
Check whether given tool profile exists.
HasMotionProfile
Check whether given Motion profile exists.
HasObjFrameProfile
Check whether given ObjFrame profile exists.
HasToolProfile
Check whether given tool profile exists.
RemoveAccuracyProfile
Remove Accuracy profile given name in controller.
RemoveMotionProfile
Remove Motion profile given name in controller.
RemoveObjFrameProfile
Remove ObjFrame profile given name in controller.
RemoveToolProfile
Remove tool profile given name in controller.
SetCurrentAccuracyProfile
Make Accuracy profile with given name as current tool profile being used by controller.
SetCurrentMotionProfile
Make Motion profile with given name as current tool profile being used by controller.
SetCurrentObjFrameProfile
Make ObjFrame profile with given name as current ObjFrame profile being used by controller.
SetCurrentToolProfile
Make tool profile with given name as current tool profile being used by controller.
SetName
Set name of the generic controller.

Methods


o Sub AddAccuracyProfile( profile)
Add a new Accuracy Profile into controller.
Parameters:
profile
interface pointer to Accuracy profile
Returns:
an HRESULT value.
Legal values:
  • S_OK if the operation succeeds
  • E_FAIL otherwise
    • .
o Sub AddMotionProfile( profile)
Add a new Motion Profile into controller.
Parameters:
profile
interface pointer to Motion profile
Returns:
an HRESULT value.
Legal values:
  • S_OK if the operation succeeds
  • E_FAIL otherwise
    • .
o Sub AddObjFrameProfile( profile)
Add a new ObjFrame Profile into controller.
Parameters:
profile
interface pointer to ObjFrame profile
Returns:
an HRESULT value.
Legal values:
  • S_OK if the operation succeeds
  • E_FAIL otherwise
    • .
o Sub AddToolProfile( iProfile)
Add a new Tool Profile into controller.
Parameters:
profile
interface pointer to tool profile
Returns:
an HRESULT value.
Legal values:
  • S_OK if the operation succeeds
  • E_FAIL otherwise
    • .
o Sub GetAccuracyProfileCount( count)
Get number of Accuracy profiles in controller.
Parameters:
count
This outer parameter contains number of Accuracy profiles.
Returns:
an HRESULT value.
Legal values:
  • S_OK if the operation succeeds
  • E_FAIL otherwise
    • .
o Sub GetAccuracyProfile( name,
profile)
Get Accuracy profile given name.
Parameters:
name
This parameter contains name of the Accuracy profile.
profile
This outer parameter contains interface pointer to Accuracy profile.
Returns:
an HRESULT value.
Legal values:
  • S_OK if the operation succeeds
  • E_FAIL otherwise
    • .
o Sub GetAccuracyProfiles( profiles)
Get Accuracy profiles list in controller.
Parameters:
profiles
This outer parameter contains Accuracy profile list.
Returns:
an HRESULT value.
Legal values:
  • S_OK if the operation succeeds
  • E_FAIL otherwise
    • .
o Sub GetCurrentAccuracyProfile( profile)
Get current Accuracy profile name used in controller.
Parameters:
profile
This outer parameter contains Accuracy profile name.
Returns:
an HRESULT value.
Legal values:
  • S_OK if the operation succeeds
  • E_FAIL otherwise
    • .
o Sub GetCurrentMotionProfile( profile)
Get current Motion profile name used in controller.
Parameters:
profile
This outer parameter contains Motion profile name.
Returns:
an HRESULT value.
Legal values:
  • S_OK if the operation succeeds
  • E_FAIL otherwise
    • .
o Sub GetCurrentObjFrameProfile( profile)
Get current ObjFrame profile name used in controller.
Parameters:
profile
This outer parameter contains ObjFrame profile name.
Returns:
an HRESULT value.
Legal values:
  • S_OK if the operation succeeds
  • E_FAIL otherwise
    • .
o Sub GetCurrentToolProfile( profile)
Get current tool profile name used in controller.
Parameters:
profile
This outer parameter contains tool profile name.
Returns:
an HRESULT value.
Legal values:
  • S_OK if the operation succeeds
  • E_FAIL otherwise
    • .
o Sub GetMotionProfileCount( count)
Get number of Motion profiles in controller.
Parameters:
count
This outer parameter contains number of Motion profiles.
Returns:
an HRESULT value.
Legal values:
  • S_OK if the operation succeeds
  • E_FAIL otherwise
    • .
o Sub GetMotionProfile( name,
profile)
Get Motion profile given name.
Parameters:
name
This parameter contains name of the Motion profile.
profile
This outer parameter contains interface pointer to Motion profile.
Returns:
an HRESULT value.
Legal values:
  • S_OK if the operation succeeds
  • E_FAIL otherwise
    • .
o Sub GetMotionProfiles( profiles)
Get Motion profiles list in controller.
Parameters:
profiles
This outer parameter contains Motion profile list.
Returns:
an HRESULT value.
Legal values:
  • S_OK if the operation succeeds
  • E_FAIL otherwise
    • .
o Sub GetName( oName)
Retreives name of the generic controller.
Parameters:
name
name of the controller to be set.
Returns:
an HRESULT value.
Legal values:
  • S_OK if the operation succeeds
  • E_FAIL otherwise
    • .
o Sub GetObjFrameProfileCount( count)
Get number of ObjFrame profiles in controller.
Parameters:
count
This outer parameter contains number of ObjFrame profiles.
Returns:
an HRESULT value.
Legal values:
  • S_OK if the operation succeeds
  • E_FAIL otherwise
    • .
o Sub GetObjFrameProfile( name,
profile)
Get ObjFrame profile given name.
Parameters:
name
This parameter contains name of the ObjFrame profile.
profile
This outer parameter contains interface pointer to ObjFrame profile.
Returns:
an HRESULT value.
Legal values:
  • S_OK if the operation succeeds
  • E_FAIL otherwise
    • .
o Sub GetObjFrameProfiles( profiles)
Get ObjFrame profiles list in controller.
Parameters:
profiles
This outer parameter contains ObjFrame profile list.
Returns:
an HRESULT value.
Legal values:
  • S_OK if the operation succeeds
  • E_FAIL otherwise
    • .
o Sub GetToolProfileCount( count)
Get number of tool profiles in controller.
Parameters:
count
This outer parameter contains number of tool profiles.
Returns:
an HRESULT value.
Legal values:
  • S_OK if the operation succeeds
  • E_FAIL otherwise
    • .
o Sub GetToolProfile( name,
profile)
Get tool profile given name.
Parameters:
name
This parameter contains name of the tool profile.
profile
This outer parameter contains interface pointer to tool profile.
Returns:
an HRESULT value.
Legal values:
  • S_OK if the operation succeeds
  • E_FAIL otherwise
    • .
o Sub GetToolProfiles( profiles)
Get tool profiles list in controller.
Parameters:
profiles
This outer parameter contains tool profile list.
Returns:
an HRESULT value.
Legal values:
  • S_OK if the operation succeeds
  • E_FAIL otherwise
    • .
o Sub HasAccuracyProfile( name,
flag)
Check whether given tool profile exists.
Parameters:
name
This parameter contains name of the Accuracy profile.
flag
This outer parameter contains whether Accuracy profile exists.
Returns:
an HRESULT value.
Legal values:
  • S_OK if the operation succeeds
  • E_FAIL otherwise
    • .
o Sub HasMotionProfile( name,
flag)
Check whether given Motion profile exists.
Parameters:
name
This parameter contains name of the Motion profile.
flag
This outer parameter contains whether Motion profile exists.
Returns:
an HRESULT value.
Legal values:
  • S_OK if the operation succeeds
  • E_FAIL otherwise
    • .
o Sub HasObjFrameProfile( name,
flag)
Check whether given ObjFrame profile exists.
Parameters:
name
This parameter contains name of the ObjFrame profile.
flag
This outer parameter contains whether ObjFrame profile exists.
Returns:
an HRESULT value.
Legal values:
  • S_OK if the operation succeeds
  • E_FAIL otherwise
    • .
o Sub HasToolProfile( name,
flag)
Check whether given tool profile exists.
Parameters:
name
This parameter contains name of the tool profile.
flag
This outer parameter contains whether tool profile exists.
Returns:
an HRESULT value.
Legal values:
  • S_OK if the operation succeeds
  • E_FAIL otherwise
    • .
o Sub RemoveAccuracyProfile( name)
Remove Accuracy profile given name in controller.
Parameters:
name
This parameter contains Accuracy profile name.
Returns:
an HRESULT value.
Legal values:
  • S_OK if the operation succeeds
  • E_FAIL otherwise
    • .
o Sub RemoveMotionProfile( name)
Remove Motion profile given name in controller.
Parameters:
name
This parameter contains Motion profile name.
Returns:
an HRESULT value.
Legal values:
  • S_OK if the operation succeeds
  • E_FAIL otherwise
    • .
o Sub RemoveObjFrameProfile( name)
Remove ObjFrame profile given name in controller.
Parameters:
name
This parameter contains ObjFrame profile name.
Returns:
an HRESULT value.
Legal values:
  • S_OK if the operation succeeds
  • E_FAIL otherwise
    • .
o Sub RemoveToolProfile( name)
Remove tool profile given name in controller.
Parameters:
name
This parameter contains tool profile name.
Returns:
an HRESULT value.
Legal values:
  • S_OK if the operation succeeds
  • E_FAIL otherwise
    • .
o Sub SetCurrentAccuracyProfile( profile)
Make Accuracy profile with given name as current tool profile being used by controller.
Parameters:
profile
This parameter contains Accuracy profile name.
Returns:
an HRESULT value.
Legal values:
  • S_OK if the operation succeeds
  • E_FAIL otherwise
    • .
o Sub SetCurrentMotionProfile( profile)
Make Motion profile with given name as current tool profile being used by controller.
Parameters:
profile
This parameter contains Motion profile name.
Returns:
an HRESULT value.
Legal values:
  • S_OK if the operation succeeds
  • E_FAIL otherwise
    • .
o Sub SetCurrentObjFrameProfile( profile)
Make ObjFrame profile with given name as current ObjFrame profile being used by controller.
Parameters:
profile
This parameter contains ObjFrame profile name.
Returns:
an HRESULT value.
Legal values:
  • S_OK if the operation succeeds
  • E_FAIL otherwise
    • .
o Sub SetCurrentToolProfile( profile)
Make tool profile with given name as current tool profile being used by controller.
Parameters:
profile
This parameter contains tool profile name.
Returns:
an HRESULT value.
Legal values:
  • S_OK if the operation succeeds
  • E_FAIL otherwise
    • .
o Sub SetName( name)
Set name of the generic controller.
Parameters:
name
name of the controller to be set.
Returns:
an HRESULT value.
Legal values:
  • S_OK if the operation succeeds
  • E_FAIL otherwise
    • .

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