pycatia.abq_automation_interfaces.abq_damper_connection_property

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_damper_connection_property.ABQDamperConnectionProperty(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

ABQAutomationItf.ABQProperty

ABQDamperConnectionProperty

Represents an Abaqus Damper connection property (ABQDamper)

object.

Role:Access an Abaqus Damper connection property object or determine its

properties.

add_support_from_reference(i_reference: Reference, i_support: Reference) → None

Note

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

o Sub AddSupportFromReference(Reference iReference,

Reference iSupport)

Adds support to the Damper connection property.

Parameters:

iReference

The CATIA Reference specifying the region to which the Damper

connection property is applied.

iSupport

The CATIA Reference specifying the region to which the Damper

connection property is applied.

Refer: CATIAReference

Parameters:

• i_reference (Reference) –

• i_support (Reference) –

Return type:

None

property axis_sys: AxisSystem

Note

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

o Property Axis_sys() As AxisSystem

Sets or returns the axis system in the Damper connection

property.

Returns:

The object of axis system.

Return type:

AxisSystem

property damper_def: int

Note

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

o Property DamperDef() As SpringDef_Type

Sets or returns the definition of Damper.

Returns:

the Definition of Damper.

Legal values:

ABQ_LINE

ABQ_NON_LINEAR

Returns:

enum spring_def_type

Return type:

int

property damper_type: int

Note

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

o Property DamperType() As SpringType_Type

Sets or returns the type of Damper.

Returns:

The type of Damper.

Legal values:

AXIAL

GENERAL

Returns:

enum spring_type_type

Return type:

int

get_linear_damping(i_dof: int) → float

Note

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

o Func GetLinearDamping(SpringDof_Type iDof) As double

Gets the linear damping value of the Damper given the degree of

freedom.

Parameters:

iDof

The degree of freedom for which damping is asked.

Legal values:

U1_DOF

U2_DOF

U3_DOF

UR1_DOF

UR2_DOF

UR3_DOF

oDampingValue

The Dampingvalue.

Parameters:

i_dof (int) – enum spring_dof_type

Return type:

float

get_non_linear_damping(i_dof: int, o_force_array: tuple, o_velocity_array: tuple) → None

Note

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

o Sub GetNonLinearDamping(SpringDof_Type iDof,

CATSafeArrayVariant oForceArray,

CATSafeArrayVariant oVelocityArray)

Gets the non-linear damping value of the Damper in the form of array, given

the degree of freedom.

Parameters:

iDof

The degree of freedom for which damping is asked.

Legal values:

U1_DOF

U2_DOF

U3_DOF

UR1_DOF

UR2_DOF

UR3_DOF

oForceArray

The array of force values.

oVelocityArray

The array of velocity values.

Refer: CATSafeArrayVariant

Parameters:

• i_dof (int) – enum spring_dof_type

• o_force_array (tuple) –

• o_velocity_array (tuple) –

Return type:

None

read_damping_data_from_file(i_dof: int, i_file_name: str) → None

Note

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

o Sub ReadDampingDataFromFile(SpringDof_Type iDof,

CATBSTR iFileName)

Reads damping data from a text file for a damper connection

property.

Parameters:

iDof

The degree of freedom for which damping data is

asked.

Legal values:

U1_DOF

U2_DOF

U3_DOF

UR1_DOF

UR2_DOF

UR3_DOF

iFileName

The complete path of the text file which contains the damping

data.

Parameters:

• i_dof (int) – enum spring_dof_type

• i_file_name (str) –

Return type:

None

remove_axis_system() → None

Note

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

o Sub RemoveAxisSystem()

Return type:

None

remove_dof(i_dof: int) → None

Note

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

o Sub RemoveDof(SpringDof_Type iDof)

Unsets the linear damping value of the Damper for given degree of

freedom.

Parameters:

iDof

The degree of freedom for which damping is set.

Legal values:

U1_DOF

U2_DOF

U3_DOF

UR1_DOF

UR2_DOF

UR3_DOF

Parameters:

i_dof (int) – enum spring_dof_type

Return type:

None

set_linear_damping(i_dof: int, i_damping_value: float) → None

Note

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

o Sub SetLinearDamping(SpringDof_Type iDof,

double iDampingValue)

Sets the linear damping value of the Damper given the degree of

freedom.

Parameters:

iDof

The degree of freedom for which damping is set.

Legal values:

U1_DOF

U2_DOF

U3_DOF

UR1_DOF

UR2_DOF

UR3_DOF

iDampingValue

The Dampingvalue.

Parameters:

• i_dof (int) – enum spring_dof_type

• i_damping_value (float) –

Return type:

None

set_non_linear_damping(i_dof: int, i_force_array: tuple, i_velocity_array: tuple) → None

Note

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

o Sub SetNonLinearDamping(SpringDof_Type iDof,

CATSafeArrayVariant iForceArray,

CATSafeArrayVariant iVelocityArray)

Sets the non-linear damping value of the Damper in the form of array, given

the degree of freedom.

Parameters:

iDof

The degree of freedom for which damping is asked.

Legal values:

U1_DOF

U2_DOF

U3_DOF

UR1_DOF

UR2_DOF

UR3_DOF

iForceArray

The array of force values.

iVelocityArray

The array of displacement values.

The value in velocity array must be greater than previous value

.

Refer: CATSafeArrayVariant

Parameters:

• i_dof (int) – enum spring_dof_type

• i_force_array (tuple) –

• i_velocity_array (tuple) –

Return type:

None