pycatia.abq_automation_interfaces.abq_displacement_bc

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_displacement_bc.ABQDisplacementBC(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.ABQBoundaryCondition
ABQDisplacementBC

Represents an Abaqus displacement boundary condition (ABQDisplacementBC)
object.
Role: Access an Abaqus displacement boundary condition object or determine its
properties.
get_dof_activation(i_dof: int, o_flag: bool) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub GetDOFActivation(long iDOF,
boolean oFlag)

Gets the activation of a DOF for Displacement BC

Parameters:

iDOF
The DOF number from 1 to 6, in order U1 = 1,…., UR3 = 6.
oFlag
DOF activation status true or false.
Parameters:

  • i_dof (int) –

  • o_flag (bool) –

Return type:

None

get_local_csys_from_publication(o_product: Product, o_pub_axis_system: AxisSystem) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub GetLocalCsysFromPublication(Product oProduct,
AxisSystem oPubAxisSystem)

Gets the published local coordinate system of the Displacement
BC.

Parameters:

oProduct
The CATIA Product specifying the local coordinate system
publication.
oPubAxisSystem
The CATIA Axis system.

Refer: CATIAAxisSystem
Parameters:
Return type:

None

get_use_coordinate_system_type() → int

Note

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

Get the user coordinate system type.

Parameters:

oCsystemType
e.g. ABQ_CARTESIAN (for Cartesian coordinate system),
ABQ_CYLINDRICAL (for Cylindrical coordinate system), ABQ_SPHERICAL (for
Spherical coordinate system),
Returns:

enum abq_local_csys_type

Return type:

int

property local_csys: AxisSystem

Note

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

Sets or returns the local coordinate system of the boundary condition’s
degrees of freedom.

Returns:
The local coordinate system.
Return type:

AxisSystem

set_dof_activation(i_dof: int, i_flag: bool) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub SetDOFActivation(long iDOF,
boolean iFlag)

Sets the activation of a DOF for Displacement BC

Parameters:

iDOF
The DOF number from 1 to 6, in order U1 = 1,…., UR3 = 6.
iFlag
DOF activation status true or false.
Parameters:

  • i_dof (int) –

  • i_flag (bool) –

Return type:

None

set_local_csys_from_publication(i_product: Product, i_pub_axis_system: Publication) → None

Note

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

Sets the published local coordinate system of the Displacement
BC.

Returns:
Fails if the publication is not on the axis system.
Parameters:

iProduct
The CATIA Product specifying the local coordinate system
publication.
iPublication
The CATIA Publication on the axis system.

Refer: CATIAPublication
Parameters:
Return type:

None

set_use_coordinate_system_type(i_csystem_type: int) → None

Note

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

Set the user coordinate system type.

Parameters:

iCsystemType
e.g. ABQ_CARTESIAN (for Cartesian coordinate system),
ABQ_CYLINDRICAL (for Cylindrical coordinate system), ABQ_SPHERICAL (for
Spherical coordinate system),
Parameters:

i_csystem_type (int) – enum abq_local_csys_type

Return type:

None

property u1: float

Note

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

Sets or returns the first translational component.

Returns:
The first translational component.
Return type:

float

property u2: float

Note

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

Sets or returns the second translational component.

Returns:
The second translational component.
Return type:

float

property u3: float

Note

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

Sets or returns the third translational component.

Returns:
The third translational component.
Return type:

float

property ur1: float

Note

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

Sets or returns the first rotational component.

Returns:
The second rotational component.
Return type:

float

property ur2: float

Note

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

Sets or returns the second rotational component.

Returns:
The second rotational component.
Return type:

float

property ur3: float

Note

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

Sets or returns the third rotational component.

Returns:
The third rotational component.
Return type:

float

property use_local_csys: bool

Note

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

Sets or returns a boolean indicating whether local coordinate system is
used in Displacement BC

Returns:
boolean specifying whether local csys is active.
Return type:

bool