pycatia.abq_automation_interfaces.abq_concentrated_force

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_concentrated_force.ABQConcentratedForce(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.ABQLoad
ABQConcentratedForce

Represents an Abaqus concentrated force object
(ABQConcentratedForce).
Role: Access an Abaqus concentrated force object or determine its
properties.
property apply_user_subroutine: bool

Note

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

Sets or returns the user subroutine flag.

Returns:
A boolean specifying whether a user subroutine will be
applied.
Return type:

bool

property cf1: float

Note

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

Sets or returns the concentrated force component in the
1-direction.

Returns:
The concentrated force component in the 1-direction.
Return type:

float

property cf2: float

Note

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

Sets or returns the concentrated force component in the
2-direction.

Returns:
The concentrated force component in the 2-direction.
Return type:

float

property cf3: float

Note

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

Sets or returns the concentrated force component in the
3-direction.

Returns:
The concentrated force component in the 3-direction.
Return type:

float

property cm1: float

Note

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

Sets or returns the concentrated moment component in the
1-direction.

Returns:
The concentrated moment component in the 1-direction.
Return type:

float

property cm2: float

Note

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

Sets or returns the concentrated moment component in the
2-direction.

Returns:
The concentrated moment component in the 2-direction.
Return type:

float

property cm3: float

Note

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

Sets or returns the concentrated moment component in the
3-direction.

Returns:
The concentrated moment component in the 3-direction.
Return type:

float

property follow_nodal_rotation: bool

Note

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

Sets or returns the follow nodal rotation flag.
Return type:

bool

get_handler(o_product: Reference, o_ref: Reference) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub GetHandler(Reference oProduct,
Reference oRef)

Returns the handler for the distributed load.

Parameters:

oProduct
The product for the handler.
oRef
The reference to the handler.
Parameters:
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 concentrated
force.

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, ABQ_CYLINDRICAL, ABQ_SPHERICAL,
ABQ_DEFAULTAXIS
Return type:

enum abq_local_csys_type

Return type:

int

property load_type: int

Note

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

Sets or returns the load type whether Point Load, Distributed Load or Load
Density.

Returns:
The load type.

Legal values:

POINTLOAD
DISTRIBUTEDLOAD
LOADDENSITY
Returns:

enum abq_conc_force_load_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 concentrated
force.

Returns:
The local coordinate system.
Return type:

AxisSystem

set_handler(i_product: Reference, i_ref: Reference) → None

Note

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

Sets the handler for the distributed load. Any previously set handler will
be replaced with this new value.

Parameters:

iProduct
The product for the handler.
iRef
The reference to the handler.
Parameters:
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 concentrated
force.

Returns:
Fails if the publication is not an 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, ABQ_CYLINDRICAL, ABQ_SPHERICAL,
ABQ_DEFAULTAXIS
Parameters:

i_csystem_type (int) – enum abq_local_csys_type

Return type:

None

property uselocal_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 Conc force

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

bool