Indexes

AMPTag (Object)

This interface provides the methods to handle the feature AMPTag.

DESCRIPTION :
AMP generates finally a RobotTask with Operations/RobotMotions( having attributes ) and a set of tags( seam ). RobotTask with Operations/RobotMotions( having attributes ) and the set of tags have information. For example each tag has the information regarding XYZYPR values. RobotMotions have information regarding weld speed etc. The current implementation of AMP is such that these information are first populated in AMPTags. The list of AMPTags is put in an AMPPath. When AMP is nearing its’ end of execution, tags and RobotTask with appropriate Operations/RobotMotions are created and populated with these information by retrieving it from the AMPTags( For each Operation/RobotMotion and tag there is a corresponding AMPTag from which these information are retrieved ). AMPTags are non-persistent and they are just intermediate buffers for holding these information. Through the ability of executing VB script file by embedding the call to it through the “Execute” keyword, these AMPTags are made available to the user for further customization of these information. “Execute” keyword facilitates calling the VB script file’s CATMain method by passing it the AMPPath object as the single argument.

USAGE :
This interface can be used only during AMP primitive file execution and not in a stand alone VB script file. This interface can only be used in conjunction with AMPPath interface. Please see the usage instructions in the AMPPath interface.

Method Index

AddAttributeReal
Function to add real attribute on the given AMPTag.
AddAttributeString
Function to add string attribute on the given AMPTag.
AddAuxAttribute
Function to add an auxilliary attribute to the given AMPTag.
GetAttributeValueReal
Function to get the value of the given real attribute on the given AMPTag.
GetAttributeValueString
Function to get the value of the given string attribute on the given AMPTag.
GetAuxAttributeNum
Function to get the number of auxilliary attributes of the given AMPTag.
GetAuxAttribute
Function to get an auxilliary attribute value of the given AMPTag.
GetAuxAxesValues
Function to get the auxilliary axes values of the given AMPTag.
GetConfig
Function to get the config value of the given AMPTag.
GetOpType
Function to get the operation type of the given AMPTag.
GetPosition
Function to get the position( array of doubles; X, Y, Z, Yaw, Roll, Pitch values ) of the given AMPTag.
GetType
Function to get the type of the given AMPTag.
GetVia
Function to get the via status of the given AMPTag.
GetWeldSpeed
Function to get the weld speed of the given AMPTag.
RemoveAttribute
Function to remove an existing attribute on the given AMPTag.
RemoveAuxAttribute
Function to remove an auxilliary attribute of the given AMPTag.
SetAttributeValueReal
Function to set the value of the given real attribute on the given AMPTag.
SetAttributeValueString
Function to set the value of the given string attribute on the given AMPTag.
SetAuxAxesValues
Function to set the auxilliary axes values of the given AMPTag.
SetConfig
Function to set the config value of the given AMPTag.
SetOpType
Function to set the operation type of the given AMPTag.
SetPosition
Function to set the position( array of doubles; X, Y, Z, Yaw, Roll, Pitch values ) of the given AMPTag.
SetType
Function to set the type of the given AMPTag.
SetVia
Function to set the via status of the given AMPTag.
SetWeldSpeed
Function to set the weld speed of the given AMPTag.

Methods


o Sub AddAttributeReal( Name,
Value)
Function to add real attribute on the given AMPTag.
Parameters:
Name
Name of the attribute to be added.
Value
Value of the added attribute.
Returns:
an HRESULT value.
Legal values:
  • S_OK if the operation succeeds
  • E_FAIL otherwise
    • .
o Sub AddAttributeString( Name,
Value)
Function to add string attribute on the given AMPTag.
Parameters:
Name
Name of the attribute to be added.
Value
Value of the added attribute.
Returns:
an HRESULT value.
Legal values:
  • S_OK if the operation succeeds
  • E_FAIL otherwise
    • .
o Sub AddAuxAttribute( iName,
iValue)
Function to add an auxilliary attribute to the given AMPTag.
Parameters:
iName
The name of the auxilliary attribute.
iValue
The value of the auxilliary attribute.
Returns:
an HRESULT value.
Legal values:
  • S_OK if the operation succeeds
  • E_FAIL otherwise
    • .
o Sub GetAttributeValueReal( Name,
oValue)
Function to get the value of the given real attribute on the given AMPTag.
Parameters:
Name
Name of the attribute whose value has to be obtained.
Value
Value of the attribute.
Returns:
an HRESULT value.
Legal values:
  • S_OK if the operation succeeds
  • E_FAIL otherwise
    • .
o Sub GetAttributeValueString( Name,
Value)
Function to get the value of the given string attribute on the given AMPTag.
Parameters:
Name
Name of the attribute whose value has to be obtained.
Value
Value of the attribute.
Returns:
an HRESULT value.
Legal values:
  • S_OK if the operation succeeds
  • E_FAIL otherwise
    • .
o Sub GetAuxAttributeNum( oNum)
Function to get the number of auxilliary attributes of the given AMPTag.
Parameters:
oNum
The number of auxilliary attributes of the given AMPTag.
Returns:
an HRESULT value.
Legal values:
  • S_OK if the operation succeeds
  • E_FAIL otherwise
    • .
o Sub GetAuxAttribute( iIndex,
oName,
oValue)
Function to get an auxilliary attribute value of the given AMPTag.
Parameters:
iIndex
The index of the auxilliary attribute.
oName
The name of the auxilliary attribute.
oValue
The value of the auxilliary attribute.
Returns:
an HRESULT value.
Legal values:
  • S_OK if the operation succeeds
  • E_FAIL otherwise
    • .
o Sub GetAuxAxesValues( oAuxillaryAxisValues)
Function to get the auxilliary axes values of the given AMPTag.
Parameters:
oAuxillaryAxisValues
The auxilliary axes values of the given AMPTag.
Returns:
an HRESULT value.
Legal values:
  • S_OK if the operation succeeds
  • E_FAIL otherwise
    • .
o Sub GetConfig( oconfig)
Function to get the config value of the given AMPTag.
Parameters:
oconfig
The config value of the given AMPTag.
Returns:
an HRESULT value.
Legal values:
  • S_OK if the operation succeeds
  • E_FAIL otherwise
    • .
o Sub GetOpType( oOpType)
Function to get the operation type of the given AMPTag.
Parameters:
oOpType
The operation type of the given AMPTag.
Returns:
an HRESULT value.
Legal values:
  • S_OK if the operation succeeds
  • E_FAIL otherwise
    • .
o Sub GetPosition( oTransform)
Function to get the position( array of doubles; X, Y, Z, Yaw, Roll, Pitch values ) of the given AMPTag.
Parameters:
oTransform
Array containing X, Y, Z, Yaw, Roll, Pitch values in sequence.
Returns:
an HRESULT value.
Legal values:
  • S_OK if the operation succeeds
  • E_FAIL otherwise
    • .
o Sub GetType( oTagType)
Function to get the type of the given AMPTag.
Parameters:
oTagType
The type of the given AMPTag.
Returns:
an HRESULT value.
Legal values:
  • S_OK if the operation succeeds
  • E_FAIL otherwise
    • .
o Sub GetVia( oViaStatus)
Function to get the via status of the given AMPTag.
Parameters:
oViaStatus
The via status of the given AMPTag.
Returns:
an HRESULT value.
Legal values:
  • S_OK if the operation succeeds
  • E_FAIL otherwise
    • .
o Sub GetWeldSpeed( oSpeed)
Function to get the weld speed of the given AMPTag.
Parameters:
oSpeed
The weld speed of the given AMPTag.
Returns:
an HRESULT value.
Legal values:
  • S_OK if the operation succeeds
  • E_FAIL otherwise
    • .
o Sub RemoveAttribute( Name)
Function to remove an existing attribute on the given AMPTag.
Parameters:
Name
Name of the attribute to be removed.
Returns:
an HRESULT value.
Legal values:
  • S_OK if the operation succeeds
  • E_FAIL otherwise
    • .
o Sub RemoveAuxAttribute( iIndex)
Function to remove an auxilliary attribute of the given AMPTag.
Parameters:
iIndex
The index of the auxilliary attribute.
Returns:
an HRESULT value.
Legal values:
  • S_OK if the operation succeeds
  • E_FAIL otherwise
    • .
o Sub SetAttributeValueReal( Name,
Value)
Function to set the value of the given real attribute on the given AMPTag.
Parameters:
Name
Name of the attribute whose value has to be set.
Value
The Value to be set.
Returns:
an HRESULT value.
Legal values:
  • S_OK if the operation succeeds
  • E_FAIL otherwise
    • .
o Sub SetAttributeValueString( Name,
Value)
Function to set the value of the given string attribute on the given AMPTag.
Parameters:
Name
Name of the attribute whose value has to be set.
Value
The Value to be set.
Returns:
an HRESULT value.
Legal values:
  • S_OK if the operation succeeds
  • E_FAIL otherwise
    • .
o Sub SetAuxAxesValues( iAuxillaryAxisValues)
Function to set the auxilliary axes values of the given AMPTag.
Parameters:
iAuxillaryAxisValues
The auxilliary axes values of the given AMPTag.
Returns:
an HRESULT value.
Legal values:
  • S_OK if the operation succeeds
  • E_FAIL otherwise
    • .
o Sub SetConfig( iconfig)
Function to set the config value of the given AMPTag.
Parameters:
iconfig
The config value of the given AMPTag.
Returns:
an HRESULT value.
Legal values:
  • S_OK if the operation succeeds
  • E_FAIL otherwise
    • .
o Sub SetOpType( iOpType)
Function to set the operation type of the given AMPTag.
Parameters:
iOpType
The operation type to be set for the given AMPTag.
Returns:
an HRESULT value.
Legal values:
  • S_OK if the operation succeeds
  • E_FAIL otherwise
    • .
o Sub SetPosition( iTransform)
Function to set the position( array of doubles; X, Y, Z, Yaw, Roll, Pitch values ) of the given AMPTag.
Parameters:
iTransform
Array containing X, Y, Z, Yaw, Roll, Pitch values in sequence.
Returns:
an HRESULT value.
Legal values:
  • S_OK if the operation succeeds
  • E_FAIL otherwise
    • .
o Sub SetType( iTagType)
Function to set the type of the given AMPTag.
Parameters:
iTagType
The type to be set for the given AMPTag.
Returns:
an HRESULT value.
Legal values:
  • S_OK if the operation succeeds
  • E_FAIL otherwise
    • .
o Sub SetVia( iViaStatus)
Function to set the via status of the given AMPTag.
Parameters:
iViaStatus
The via status of the given AMPTag.
Returns:
an HRESULT value.
Legal values:
  • S_OK if the operation succeeds
  • E_FAIL otherwise
    • .
o Sub SetWeldSpeed( iSpeed)
Function to set the weld speed of the given AMPTag.
Parameters:
iSpeed
The weld speed to be set for the given AMPTag.
Returns:
an HRESULT value.
Legal values:
  • S_OK if the operation succeeds
  • E_FAIL otherwise
    • .

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