pycatia.dnb_igp_arc_commands.amp_path

Module initially auto generated using V5Automation files from CATIA V5 R28 on 2020-09-25 14:34:21.593357

Warning

The notes denoted “CAA V5 Visual Basic Help” are to be used as reference only. They are there as a guide as to how the visual basic / catscript functions work and thus help debugging in pycatia.

class pycatia.dnb_igp_arc_commands.amp_path.AMPPath(com_object)

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)

System.IUnknown

System.IDispatch

System.CATBaseUnknown

System.CATBaseDispatch

System.AnyObject

AMPPath

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

)

create_tag(i_location: tuple, o_tag: AMPTag) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))

o Sub CreateTag(CATSafeArrayVariant iLocation,

AMPTag 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

.

Parameters:

• i_location (tuple) –

• o_tag (AMPTag) –

Return type:

None

create_tag_with_reference(i_ref_tag: AMPTag, i_location: tuple, o_tag: AMPTag) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))

o Sub CreateTagWithReference(AMPTag iRefTag,

CATSafeArrayVariant iLocation,

AMPTag 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

.

Parameters:

• i_ref_tag (AMPTag) –

• i_location (tuple) –

• o_tag (AMPTag) –

Return type:

None

get_all_tags(io_tag_list: tuple) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))

o Sub GetAllTags(CATSafeArrayVariant 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

.

Parameters:

io_tag_list (tuple) –

Return type:

None

get_num_tags(otag_list_size: int) → AMPTag

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))

o Sub GetNumTags(short 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

.

Parameters:

otag_list_size (int) –

Return type:

AMPTag

get_script_var_value(o_value: str) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))

o Sub GetScriptVarValue(CATBSTR 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.

Parameters:

o_value (str) –

Return type:

None

get_target_device(o_device: AnyObject) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))

o Sub GetTargetDevice(AnyObject 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

.

Parameters:

o_device (AnyObject) –

Return type:

None

insert_at(i_index: int, i_tag: AMPTag) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))

o Sub InsertAt(short iIndex,

AMPTag 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.

Parameters:

• i_index (int) –

• i_tag (AMPTag) –

Return type:

None

remove_from(i_index: int) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))

o Sub RemoveFrom(short 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

.

Parameters:

i_index (int) –

Return type:

None