pycatia.dnb_igp_arc_commands.amp_tag¶

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

AMPTag

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.

add_attribute_real(name: str, value: float) → None¶

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)): o Sub AddAttributeReal(CATBSTR Name,

double 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

.

Parameters:

name (str) –
value (float) –

Return type:

None

add_attribute_string(name: str, value: str) → None¶

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)): o Sub AddAttributeString(CATBSTR Name,

CATBSTR 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

.

Parameters:

name (str) –
value (str) –

Return type:

None

add_aux_attribute(i_name: str, i_value: str) → None¶

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)): o Sub AddAuxAttribute(CATBSTR iName,

CATBSTR 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

Parameters:

i_name (str) –
i_value (str) –

Return type:

None

get_attribute_value_real(name: str, o_value: float) → None¶

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)): o Sub GetAttributeValueReal(CATBSTR Name,

double 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

Parameters:

name (str) –
o_value (float) –

Return type:

None

get_attribute_value_string(name: str, value: str) → None¶

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)): o Sub GetAttributeValueString(CATBSTR Name,

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

Parameters:

name (str) –
value (str) –

Return type:

None

get_aux_attribute(i_index: int, o_name: str, o_value: str) → None¶

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)): o Sub GetAuxAttribute(short iIndex,

CATBSTR oName,

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

Parameters:

i_index (int) –
o_name (str) –
o_value (str) –

Return type:

None

get_aux_attribute_num(o_num: int) → None¶

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)): o Sub GetAuxAttributeNum(short 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.

Parameters:: o_num (int) –
Return type:: None

get_aux_axes_values(o_auxillary_axis_values: tuple) → None¶

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)): o Sub GetAuxAxesValues(CATSafeArrayVariant

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.

Parameters:: o_auxillary_axis_values (tuple) –
Return type:: None

get_config(oconfig: int) → None¶

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)): o Sub GetConfig(short 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.

Parameters:: oconfig (int) –
Return type:: None

get_op_type(o_op_type: int) → None¶

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)): o Sub GetOpType(short 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.

Parameters:: o_op_type (int) –
Return type:: None

get_position(o_transform: tuple) → None¶

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)): o Sub GetPosition(CATSafeArrayVariant 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.

Parameters:: o_transform (tuple) –
Return type:: None

get_type(o_tag_type: str) → None¶

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)): o Sub GetType(CATBSTR 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.

Parameters:: o_tag_type (str) –
Return type:: None

get_via(o_via_status: int) → None¶

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)): o Sub GetVia(short 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.

Parameters:: o_via_status (int) –
Return type:: None

get_weld_speed(o_speed: float) → None¶

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)): o Sub GetWeldSpeed(double 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.

Parameters:: o_speed (float) –
Return type:: None

remove_attribute(name: str) → None¶

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)): o Sub RemoveAttribute(CATBSTR 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.

Parameters:: name (str) –
Return type:: None

remove_aux_attribute(i_index: int) → None¶

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)): o Sub RemoveAuxAttribute(short 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.

Parameters:: i_index (int) –
Return type:: None

set_attribute_value_real(name: str, value: float) → None¶

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)): o Sub SetAttributeValueReal(CATBSTR Name,

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

Parameters:

name (str) –
value (float) –

Return type:

None

set_attribute_value_string(name: str, value: str) → None¶

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)): o Sub SetAttributeValueString(CATBSTR Name,

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

Parameters:

name (str) –
value (str) –

Return type:

None

set_aux_axes_values(i_auxillary_axis_values: tuple) → None¶

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)): o Sub SetAuxAxesValues(CATSafeArrayVariant

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.

Parameters:: i_auxillary_axis_values (tuple) –
Return type:: None

set_config(iconfig: int) → None¶

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)): o Sub SetConfig(short 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.

Parameters:: iconfig (int) –
Return type:: None

set_op_type(i_op_type: int) → None¶

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)): o Sub SetOpType(short 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.

Parameters:: i_op_type (int) –
Return type:: None

set_position(i_transform: tuple) → None¶

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)): o Sub SetPosition(CATSafeArrayVariant 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.

Parameters:: i_transform (tuple) –
Return type:: None

set_type(i_tag_type: str) → None¶

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)): o Sub SetType(CATBSTR 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.

Parameters:: i_tag_type (str) –
Return type:: None

set_via(i_via_status: int) → None¶

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)): o Sub SetVia(short 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.

Parameters:: i_via_status (int) –
Return type:: None

set_weld_speed(i_speed: float) → None¶

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)): o Sub SetWeldSpeed(double 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.

Parameters:: i_speed (float) –
Return type:: None

pycatia.dnb_igp_arc_commands.amp_tag¶

Navigation

Related Topics