Role: This interface is used to work with ARCTag.
The following code snippet can be used to obtain a Tag from a selected Product
Set ParentObject = CATIA.ActiveDocument.Selection.FindObject("CATIAProduct")
Set objTag = ParentObject.GetTechnologicalObject("Tag")
Methods
- Sub GetARCTagGroup( oARCTagGroup)
-
Function to get the parent ARC TagGroup of the ARC tag.
- Parameters:
-
- oARCTagGroup
- the parent ARCTagGroup.
- Returns:
- an HRESULT value.
Legal values:- S_OK if the operation succeeds
- E_FAIL otherwise .
- Sub GetAuxAxesValues( ioAuxAxesValuesList)
-
Function to get the aux axes values associated with the ARC tag.
- Parameters:
-
- ioAuxAxesValuesList
- the aux axes values( array of double values ) associated with the ARC tag.
- Returns:
- an HRESULT value.
Legal values:- S_OK if the operation succeeds
- E_FAIL otherwise .
- Sub GetBaseSurfaceNormal( oBaseVec)
-
Function to get the Base Surface Normal associated with the ARC tag.
- Parameters:
-
- oWallVec
- Base surface normal vector( array of 3 real values ).
- Returns:
- an HRESULT value.
Legal values:- S_OK if the operation succeeds
- E_FAIL otherwise .
- Sub GetIndex( oIndex)
-
Function to get the index of the ARC tag in it's parent ARC TagGroup.
- Parameters:
-
- oIndex
- the index of the ARC tag in it's parent ARC TagGroup.
- Returns:
- an HRESULT value.
Legal values:- S_OK if the operation succeeds
- E_FAIL otherwise .
- Sub GetTag( oTag)
-
Function to get the underlying basic Tag.
- Parameters:
-
- oTag
- the underlying basic Tag.
- Returns:
- an HRESULT value.
Legal values:- S_OK if the operation succeeds
- E_FAIL otherwise .
- Sub GetTagParam( iParamName, oVal)
-
Function to get the value of a given ARC tag parameter.
- Parameters:
-
- iParamName
- the name of the ARC tag parameter. Values of following ARC tag parameters can be gotten: "WireAngle", "FlareAngle", "RakeAngle", "WireRollAngle", "BaseTangentOffset", "WallTangentOffset", "ShiftDistance", "FlareLength", "StickOut", "TCPStickOut", "NearDistance"
- oVal
- the value of the ARC tag parameter.
- Returns:
- an HRESULT value.
Legal values:- S_OK if the operation succeeds
- E_FAIL otherwise .
- Sub GetWallSurfaceNormal( oWallVec)
-
Function to get the Wall Surface Normal associated with the ARC tag.
- Parameters:
-
- oWallVec
- Wall surface normal vector( array of 3 real values ).
- Returns:
- an HRESULT value.
Legal values:- S_OK if the operation succeeds
- E_FAIL otherwise .
- Sub GetWeldGeometry( bStatus)
-
Function to find whether wall/base normals are available for the ARC tag.
- Parameters:
-
- bStatus
- Boolean flag indicating whether wall/base normals are set for the ARC tag.
- Returns:
- an HRESULT value.
Legal values:- S_OK if the operation succeeds
- E_FAIL otherwise .
- Sub Rotate( iAngle, iDirVector)
-
Function to Rotate the ARC tag about a given direction vector as the axis of rotation.
- Parameters:
-
- iAngle
- the angle by which the ARC tag should be rotated about the given direction vector as the axis of rotation.
- iDirVector
- the given direction vector( array of 3 real values; axis of rotation ) about which the ARC tag has to be rotated.
- Returns:
- an HRESULT value.
Legal values:- S_OK if the operation succeeds
- E_FAIL otherwise .
- Sub RotateX( iAngle)
-
Function to rotate the ARC tag about it's x-axis.
- Parameters:
-
- iAngle
- the angle by which the ARC tag should be rotated about it's x-axis.
- Returns:
- an HRESULT value.
Legal values:- S_OK if the operation succeeds
- E_FAIL otherwise .
- Sub RotateY( iAngle)
-
Function to rotate the ARC tag about it's y-axis.
- Parameters:
-
- iAngle
- the angle by which the ARC tag should be rotated about it's y-axis.
- Returns:
- an HRESULT value.
Legal values:- S_OK if the operation succeeds
- E_FAIL otherwise .
- Sub RotateZ( iAngle)
-
Function to rotate the ARC tag about it's z-axis.
- Parameters:
-
- iAngle
- the angle by which the ARC tag should be rotated about it's z-axis.
- Returns:
- an HRESULT value.
Legal values:- S_OK if the operation succeeds
- E_FAIL otherwise .
- Sub SetBaseSurfaceNormal( iBaseVec)
-
Function to set the Base Surface Normal associated with the ARC tag.
- Parameters:
-
- iBaseVec
- Base surface normal vector( array of 3 real values ).
- Returns:
- an HRESULT value.
Legal values:- S_OK if the operation succeeds
- E_FAIL otherwise .
- Sub SetTagParam( iParamName, iVal)
-
Function to set the value of a given ARC tag parameter.
- Parameters:
-
- iParamName
- the name of the ARC tag parameter. Following ARC tag parameters can be set: "WireAngle", "FlareAngle", "RakeAngle", "WireRollAngle", "BaseTangentOffset", "WallTangentOffset", "ShiftDistance", "FlareLength", "StickOut", "TCPStickOut", "NearDistance"
- iVal
- the value of the ARC tag parameter.
- Returns:
- an HRESULT value.
Legal values:- S_OK if the operation succeeds
- E_FAIL otherwise .
- Sub SetWallSurfaceNormal( iWallVec)
-
Function to set the Wall Surface Normal associated with the ARC tag.
- Parameters:
-
- iWallVec
- Wall surface normal vector( array of 3 real values ).
- Returns:
- an HRESULT value.
Legal values:- S_OK if the operation succeeds
- E_FAIL otherwise .
- Sub SetWeldGeometry( bStatus)
-
Function to set the flag for the availability of wall/base normals for the ARC tag.
- Parameters:
-
- bStatus
- Boolean flag indicating whether wall/base normals should be available for the ARC tag.
- Returns:
- an HRESULT value.
Legal values:- S_OK if the operation succeeds
- E_FAIL otherwise .
- Sub Translate( iDistance, iDirVector)
-
Function to translate the ARC tag along a given direction vector.
- Parameters:
-
- iDistance
- the distance by which the ARC tag should be translated along the given direction vector.
- iDirVector
- the given direction vector( array of 3 real values ) along which the ARC tag has to be translated.
- Returns:
- an HRESULT value.
Legal values:- S_OK if the operation succeeds
- E_FAIL otherwise .
- Sub TranslateAlongSeam( iDistance)
-
Function to translate the ARC tag along the seam.
- Parameters:
-
- iDistance
- the distance by which the ARC tag should be translated along the seam.
- Returns:
- an HRESULT value.
Legal values:- S_OK if the operation succeeds
- E_FAIL otherwise .