pycatia.abq_automation_interfaces.abq_spring_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_spring_connection_property.ABQSpringConnectionProperty(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

ABQSpringConnectionProperty

Represents an Abaqus spring connection property (ABQSpring)

object.

Role:Access an Abaqus spring 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 spring connection property.

Parameters:

iReference

The CATIA Reference specifying the region to which the spring

connection property is applied.

iSupport

The CATIA Reference specifying the region to which the spring

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 spring connection

property.

Returns:

The object of axis system.

Return type:

AxisSystem

get_linear_stiffness(i_dof: int) → float

Note

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

o Func GetLinearStiffness(SpringDof_Type iDof) As double

Gets the linear stiffness of the spring given the degree of

freedom.

Parameters:

iDof

The degree of freedom for which stiffness is

asked.

Legal values:

U1_DOF

U2_DOF

U3_DOF

UR1_DOF

UR2_DOF

UR3_DOF

oStiffnessValue

The stiffnessvalue.

Parameters:

i_dof (int) – enum spring_dof_type

Return type:

float

get_non_linear_stiffness(i_dof: int, o_force_array: tuple, o_disp_array: tuple) → None

Note

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

o Sub GetNonLinearStiffness(SpringDof_Type iDof,

CATSafeArrayVariant oForceArray,

CATSafeArrayVariant oDispArray)

Gets the non-linear stiffness of the spring in the form of array, given the

degree of freedom.

Parameters:

iDof

The degree of freedom for which stiffness is

asked.

Legal values:

U1_DOF

U2_DOF

U3_DOF

UR1_DOF

UR2_DOF

UR3_DOF

oForceArray

The array of force values.

oDispArray

The array of displacement values.

Refer: CATSafeArrayVariant

Parameters:

• i_dof (int) – enum spring_dof_type

• o_force_array (tuple) –

• o_disp_array (tuple) –

Return type:

None

read_stiffness_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 ReadStiffnessDataFromFile(SpringDof_Type iDof,

CATBSTR iFileName)

Reads stiffness data from a text file for a spring connection

property.

Parameters:

iDof

The degree of freedom for which stiffness 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 stiffness

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 stiffness of the spring for given degree of

freedom.

Parameters:

iDof

The degree of freedom for which stiffness 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_stiffness(i_dof: int, i_stiffness_value: float) → None

Note

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

o Sub SetLinearStiffness(SpringDof_Type iDof,

double iStiffnessValue)

Sets the linear stiffness of the spring given the degree of

freedom.

Parameters:

iDof

The degree of freedom for which stiffness is set.

Legal values:

U1_DOF

U2_DOF

U3_DOF

UR1_DOF

UR2_DOF

UR3_DOF

iStiffnessValue

The stiffnessvalue.

Parameters:

• i_dof (int) – enum spring_dof_type

• i_stiffness_value (float) –

Return type:

None

set_non_linear_stiffness(i_dof: int, i_force_array: tuple, i_disp_array: tuple) → None

Note

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

o Sub SetNonLinearStiffness(SpringDof_Type iDof,

CATSafeArrayVariant iForceArray,

CATSafeArrayVariant iDispArray)

Sets the non-linear stiffness of the spring in the form of array, given the

degree of freedom.

Parameters:

iDof

The degree of freedom for which stiffness is

asked.

Legal values:

U1_DOF

U2_DOF

U3_DOF

UR1_DOF

UR2_DOF

UR3_DOF

iForceArray

The array of force values.

iDispArray

The array of displacement values.

The value in displacement array must be greater than previous value.

Refer: CATSafeArrayVariant

Parameters:

• i_dof (int) – enum spring_dof_type

• i_force_array (tuple) –

• i_disp_array (tuple) –

Return type:

None

property spring_definition: int

Note

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

o Property SpringDef() As SpringDef_Type

Sets or returns the definition of spring.

Returns:

the Definition of spring.

Legal values:

ABQ_LINE

ABQ_NON_LINEAR

Return type:

int

property spring_type: int

Note

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

o Property SpringType() As SpringType_Type

Sets or returns the type of spring.

Returns:

The type of spring.

Legal values:

AXIAL

GENERAL

Returns:

enum spring_type_type

Return type:

int