All Frameworks  Object Hierarchy  This Framework  Indexes

AMPPath (Object)

This interface provides the methods to handle the feature AMPPath which is a list of AMPTags.

USAGE :
This interface can be used only during AMP primitive file execution and not in a stand alone VB script file. In the AMP primitive file, use the AMP "Execute" keyword to execute a VB script file. For example:

Execute FREE path_name_of_the_VB_script_file
( Example tutorial file: \intel_a\startup\ARW\PRIMITIVES\AMPPath_AMPTag_Interfaces_Usage )

The entry point in the VB script file is the CATMain method which takes a single argument of type "AMPPath".
( For more details, please refer to the following sample VB script file: \intel_a\startup\ARW\PRIMITIVES\AMPPath_AMPTag_Interfaces_Usage.CATScript )

Method Index

CreateTagWithReference
Function to create an AMPTag with reference to an already existing AMPTag.
CreateTag
Function to create an AMPTag.
GetAllTags
Function to get the list of AMPTags by name.
GetNumTags
Function to get the number of AMPTags in the given AMPPath.
GetScriptVarValue
Function to get the value of system variable, "ScriptVar".
GetTargetDevice
Function to get the target device of the AMPPath.
InsertAt
Function to insert an AMPTag at a given index of the AMPPath.
RemoveFrom
Function to remove an AMPTag at a given index of the AMPPath.

Methods


o Sub CreateTagWithReference( iRefTag,
iLocation,
oTag)
Function to create an AMPTag with reference to an already existing AMPTag.
Parameters:
iRefTag
The AMPTag which is taken as the reference.
iLocation
The location (with respect to iRefTag as the reference frame) at which the AMPTag has to be created.
oTag
The newly created AMPTag.
Returns:
an HRESULT value.
Legal values:
  • S_OK if the operation succeeds
  • E_FAIL otherwise
    • .
o Sub CreateTag( iLocation,
oTag)
Function to create an AMPTag.
Parameters:
iLocation
The location (with respect to world reference frame) at which the AMPTag has to be created.
oTag
The newly created AMPTag.
Returns:
an HRESULT value.
Legal values:
  • S_OK if the operation succeeds
  • E_FAIL otherwise
    • .
o Sub GetAllTags( ioTagList)
Function to get the list of AMPTags by name.
Parameters:
ioTagList
Underlying list of AMPTag names.
Returns:
an HRESULT value.
Legal values:
  • S_OK if the operation succeeds
  • E_FAIL otherwise
    • .
o Sub GetNumTags( otagListSize)
Function to get the number of AMPTags in the given AMPPath.
Usage:
'Array of AMPTags; No size specified as size is not known
Dim objAMPTags() As AMPTag

'Size of the array objAMPTags is determined
Dim count As Integer
iAMPPath.GetNumTags count

'Set the size of array objAMPTags
ReDim objAMPTags(count)
Parameters:
otagListSize
Number of AMPTags.
Returns:
an HRESULT value.
Legal values:
  • S_OK if the operation succeeds
  • E_FAIL otherwise
    • .
o Sub GetScriptVarValue( oValue)
Function to get the value of system variable, "ScriptVar".
Usage:
Dim myScriptVar As String
iAMPPath.GetScriptVarValue myScriptVar
Parameters:
oValue
Value of the system variable, "ScriptVar".
Returns:
an HRESULT value.
Legal values:
  • S_OK if the operation succeeds
  • E_FAIL otherwise
    • .
o Sub GetTargetDevice( oDevice)
Function to get the target device of the AMPPath.
Parameters:
oDevice
The target device of the AMPPath.
Returns:
an HRESULT value.
Legal values:
  • S_OK if the operation succeeds
  • E_FAIL otherwise
    • .
o Sub InsertAt( iIndex,
iTag)
Function to insert an AMPTag at a given index of the AMPPath.
Parameters:
iIndex
The index of AMPPath at which the AMPTag has to be inserted.
iTag
The AMPTag that has to be inserted.
Returns:
an HRESULT value.
Legal values:
  • S_OK if the operation succeeds
  • E_FAIL otherwise
    • .
o Sub RemoveFrom( iIndex)
Function to remove an AMPTag at a given index of the AMPPath.
Parameters:
iIndex
The index of AMPPath at which the AMPTag has to be removed.
Returns:
an HRESULT value.
Legal values:
  • S_OK if the operation succeeds
  • E_FAIL otherwise
    • .

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