pycatia.abq_automation_interfaces.abq_mass_scaling

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.abq_automation_interfaces.abq_mass_scaling.ABQMassScaling(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
ABQMassScaling

Represents an Abaqus Mass Scaling entity.

Role: Used to access the properties of a Mass Scaling entity.
add_support_for_body(i_product: Product, i_body: Body) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub AddSupportForBody(Product iProduct,
Body iBody)

Adds the specified body as a support.

Parameters:

iProduct
The CATIAProduct specifying the positioning object.

iBody
The CATIABody to serve as the support.
Refer: CATIABody , CATIAProduct
Parameters:
Return type:

None

add_support_from_product(i_product: Product, i_support: Reference) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub AddSupportFromProduct(Product iProduct,
Reference iSupport)

Adds the specified product reference as a support. If the support already
exists then it is removed.

Parameters:

iProduct
The CATIAProduct specifying the positioning object.

iSupport
The CATIAReference to serve as the support.
Parameters:
Return type:

None

add_support_from_publication(i_product: Product, i_publication: Publication) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub AddSupportFromPublication(Product iProduct,
Publication iPublication)

Adds a support from the publication. If the support already exists, it is
removed.

Parameters:

iProduct
The CATIA Product specifying the object to which the mass scaling
is applied.
iPublication
The CATIA Publication specifying the region to which the mass
scaling is applied.

Refer: CATIAPublication
Parameters:
Return type:

None

clear_supports() → None

Note

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

Clear the list of supports.
Return type:

None

property frequency_increment: int

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property FrequencyIncrement() As long

Sets or returns the scaling frequency increment. Applies only when
FrequencyType is ABQ_INCREMENT.
Return type:

int

property frequency_interval: int

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property FrequencyInterval() As long

Sets or returns the scaling frequency interval. Applies only when
FrequencyType is ABQ_INTERVAL.
Return type:

int

property frequency_type: int

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property FrequencyType() As AbqMsFrequencyType

Sets or returns the scaling frequency type.
Returns:

enum abq_ms_frequency_type

Return type:

int

get_supports(o_products: tuple, o_supports: tuple) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub GetSupports(CATSafeArrayVariant oProducts,
CATSafeArrayVariant oSupports)

Gets the supports that define the mass scaling region(s).

Parameters:

oProducts
Returned safe array of products for the supports, as
CATIAReferences. This array has a one-to-one mapping with the supports array.

oSupports
Returned safe array of supports, as CATIAReferences. This array has
a one-to-one mapping with the products array.
Parameters:

  • o_products (tuple) –

  • o_supports (tuple) –

Return type:

None

property global_: bool

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property Global() As boolean

Sets or returns whether the mass scaling is global.
Return type:

bool

property num_supports: int

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property NumSupports() As long (Read Only)

Retrieves the number of supports.
Return type:

int

property scale_factor: float

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property ScaleFactor() As double

Sets or returns the scale factor.
Return type:

float

property scale_factor_on: bool

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property ScaleFactorOn() As boolean

Sets or returns whether the scale factor is active.
Return type:

bool

set_supports(i_products: tuple, i_supports: tuple) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub SetSupports(CATSafeArrayVariant iProducts,
CATSafeArrayVariant iSupports)

Sets the supports that define the mass scaling region(s). Any previously
set support regions will be replaced with this new list. The list must contain
at least one item.

Parameters:

iProducts
Safe array of products for the supports as CATIAReferences. This
array has a one-to-one mapping with the supports array.

iSupports
Safe array of supports as CATIAReferences. This array has a
one-to-one mapping with the products array.
Parameters:

  • i_products (tuple) –

  • i_supports (tuple) –

Return type:

None

property target_method: int

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property TargetMethod() As AbqMsTargetMethod

Sets or returns the target time scaling method. Applies only when target
time is active.
Returns:

enum abq_ms_target_method

Return type:

int

property target_time: float

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property TargetTime() As double

Sets or returns the scaling target time.
Return type:

float

property target_time_on: bool

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property TargetTimeOn() As boolean

Sets or returns whether the target time scaling is active.
Return type:

bool

property variable: bool

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property Variable() As boolean

Sets or returns whether the mass scaling is variable.
Return type:

bool