pycatia.smt_interfaces.vibration_volumes

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.smt_interfaces.vibration_volumes.VibrationVolumes(com_object)

Note

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

System.IUnknown
System.IDispatch
System.CATBaseUnknown
System.CATBaseDispatch
System.Collection
VibrationVolumes

Interface to compute vibration volumes
clean_up() → None

Note

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

Cleans up.
Return type:

None

compute_vibration_volume(group_of_selected_products: Group, positions_file_path: str, i_accuracy: float, i_simplif_accuracy: float) → Document

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func ComputeVibrationVolume(Group GroupOfSelectedProducts,
CATBSTR PositionsFilePath,
double iAccuracy,
double iSimplifAccuracy) As Document

Computes a vibration volume, from a position input file.

Parameters:

GroupOfSelectedProducts
Selection of products to make vibrate.
PositionsFilePath
Positions file path.
iAccuracy
Grain for wrapping.
iSimplifAccuracy
Accuracy for simplification. A non positive value makes the
simplification inactive.

Returns:
VibrationVolumeDocument: Document containing the result.
Parameters:

  • group_of_selected_products (Group) –

  • positions_file_path (str) –

  • i_accuracy (float) –

  • i_simplif_accuracy (float) –

Return type:

Document

compute_vibration_volume_from_track(group_of_selected_products: Group, i_swept_able: AnyObject, i_accuracy: float, i_simplify_accuracy: float) → Document

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func ComputeVibrationVolumeFromTrack(Group
GroupOfSelectedProducts,
CATBaseDispatch iSweptAble,
double iAccuracy,
double iSimplifAccuracy) As Document

Computes a vibration volume, from a track.

Parameters:

GroupOfSelectedProducts
Selection of products to make vibrate.
iSweptAble
Track containing the positions.
iAccuracy
Grain for wrapping.
iSimplifAccuracy
Accuracy for simplification. A non positive value makes the
simplification inactive.

Returns:
VibrationVolumeDocument: Document containing the result.
Parameters:

  • group_of_selected_products (Group) –

  • i_swept_able (AnyObject) –

  • i_accuracy (float) –

  • i_simplify_accuracy (float) –

Return type:

Document

compute_vibration_volume_from_track_with_a_reference(group_of_selected_products: Group, i_reference_product: Product, i_swept_able: AnyObject, i_accuracy: float, i_simplify_accuracy: float) → Document

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func ComputeVibrationVolumeFromTrackWithAReference(Group
GroupOfSelectedProducts,
Product iReferenceProduct,
CATBaseDispatch iSweptAble,
double iAccuracy,
double iSimplifAccuracy) As Document

Computes a vibration volume, from a track, according to a reference
product.

Parameters:

GroupOfSelectedProducts
Selection of products to make vibrate.
iReferenceProduct
Product taken as a reference.
iSweptAble
Track containing the positions.
iAccuracy
Grain for wrapping.
iSimplifAccuracy
Accuracy for simplification. A non positive value makes the
simplification inactive.

Returns:
VibrationVolumeDocument: Document containing the result.
Parameters:

  • group_of_selected_products (Group) –

  • i_reference_product (Product) –

  • i_swept_able (AnyObject) –

  • i_accuracy (float) –

  • i_simplify_accuracy (float) –

Return type:

Document

compute_vibration_volume_with_a_reference(i_group_of_selected_products: Group, i_reference_product: Product, positions_file_path: str, i_accuracy: float, i_simplify_accuracy: float) → Document

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func ComputeVibrationVolumeWithAReference(Group
iGroupOfSelectedProducts,
Product iReferenceProduct,
CATBSTR PositionsFilePath,
double iAccuracy,
double iSimplifAccuracy) As Document

Computes a vibration volume, from a position input file, according to a
reference product.

Parameters:

iGroupOfSelectedProducts
Selection of products to make vibrate.
iReferenceProduct
Product taken as a reference.
PositionsFilePath
Positions file path.
iAccuracy
Grain for wrapping.
iSimplifAccuracy
Accuracy for simplification. A non positive value makes the
simplification inactive.

Returns:
VibrationVolumeDocument: Document containing the result.
Parameters:

  • i_group_of_selected_products (Group) –

  • i_reference_product (Product) –

  • positions_file_path (str) –

  • i_accuracy (float) –

  • i_simplify_accuracy (float) –

Return type:

Document

vibration_volume_shape_name() → str

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func VibrationVolumeShapeName() As CATBSTR

Returns the name of the associated shape.
Return type:

str