BeamForceBuilder Class¶
-
class
NXOpen.Motion.
BeamForceBuilder
¶ Bases:
NXOpen.Motion.MotionBuilder
Represents a
Motion.BeamForceBuilder
builderTo create a new instance of this class, use
NXOpen.Motion.BeamForceCollection.CreateBeamForceBuilder()
Default values.
Property Value Area.Value 100 CustomizedMaterial.Density.Value 7.8e-6 (millimeters part), 7.3e-4 (inches part) CustomizedMaterial.PoissonRatio.Value 0.3 CustomizedMaterial.YoungModulus.Value 2e+8 (millimeters part), 2.9e+7 (inches part) DampingType Viscous New in version NX12.0.0.
Properties¶
Property | Description |
---|---|
ActionLink | Returns the action link object |
ActionPoint | Returns or sets the action point. |
Area | Returns the area |
AsyTimoshenkoCorrection | Returns the ASY Timoshenko correction |
AszTimoshenkoCorrection | Returns the ASZ Timoshenko correction |
BaseLink | Returns the base link object |
BasePoint | Returns or sets the base point. |
CustomizedMaterial | Returns the customized material |
DampingRatio | Returns the damping ratio |
DampingType | Returns or sets the damping method |
Direction | Returns or sets the direction |
DisplayScale | Returns or sets the icon display scale |
FreeLength | Returns the free length |
GroupName | Returns or sets the group name |
GroupType | Returns or sets the group type |
InertiaIyy | Returns the inertia Iyy |
InertiaIzz | Returns the inertia Izz |
InertiaK | Returns the inertia K |
IsBeamCrossDamping | Returns or sets the beam cross damping flag |
Name | Returns or sets the name of the beam force object |
Tag | Returns the Tag for this object. |
VectorType | Returns or sets the orientation of beam force |
Methods¶
Method | Description |
---|---|
Commit | Commits any edits that have been applied to the builder. |
Destroy | Deletes the builder, and cleans up any objects created by the builder. |
GetCommittedObjects | For builders that create more than one object, this method returns the objects that are created by commit. |
GetObject | Returns the object currently being edited by this builder. |
ShowResults | Updates the model to reflect the result of an edit to the model for all builders that support showing results. |
Validate | Validate whether the inputs to the component are sufficient for commit to be called. |
Enumerations¶
BeamForceBuilderDampingTypes Enumeration | the damping type |
BeamForceBuilderVectorTypes Enumeration | the vector direction of the beam force |
Property Detail¶
ActionLink¶
-
BeamForceBuilder.
ActionLink
¶ Returns the action link object
-------------------------------------
Getter Method
Signature
ActionLink
Returns: Return type: NXOpen.Motion.SelectLink
New in version NX12.0.0.
License requirements: mechanisms (“MECHANISMS”)
ActionPoint¶
-
BeamForceBuilder.
ActionPoint
¶ Returns or sets the action point.
-------------------------------------
Getter Method
Signature
ActionPoint
Returns: Return type: NXOpen.Point
New in version NX12.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ActionPoint
Parameters: actionPoint ( NXOpen.Point
) –New in version NX12.0.0.
License requirements: mechanisms (“MECHANISMS”)
Area¶
-
BeamForceBuilder.
Area
¶ Returns the area
-------------------------------------
Getter Method
Signature
Area
Returns: Return type: NXOpen.Expression
New in version NX12.0.0.
License requirements: mechanisms (“MECHANISMS”)
AsyTimoshenkoCorrection¶
-
BeamForceBuilder.
AsyTimoshenkoCorrection
¶ Returns the ASY Timoshenko correction
-------------------------------------
Getter Method
Signature
AsyTimoshenkoCorrection
Returns: Return type: NXOpen.Expression
New in version NX12.0.0.
License requirements: mechanisms (“MECHANISMS”)
AszTimoshenkoCorrection¶
-
BeamForceBuilder.
AszTimoshenkoCorrection
¶ Returns the ASZ Timoshenko correction
-------------------------------------
Getter Method
Signature
AszTimoshenkoCorrection
Returns: Return type: NXOpen.Expression
New in version NX12.0.0.
License requirements: mechanisms (“MECHANISMS”)
BaseLink¶
-
BeamForceBuilder.
BaseLink
¶ Returns the base link object
-------------------------------------
Getter Method
Signature
BaseLink
Returns: Return type: NXOpen.Motion.SelectLink
New in version NX12.0.0.
License requirements: mechanisms (“MECHANISMS”)
BasePoint¶
-
BeamForceBuilder.
BasePoint
¶ Returns or sets the base point.
-------------------------------------
Getter Method
Signature
BasePoint
Returns: Return type: NXOpen.Point
New in version NX12.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
BasePoint
Parameters: basePoint ( NXOpen.Point
) –New in version NX12.0.0.
License requirements: mechanisms (“MECHANISMS”)
CustomizedMaterial¶
-
BeamForceBuilder.
CustomizedMaterial
¶ Returns the customized material
-------------------------------------
Getter Method
Signature
CustomizedMaterial
Returns: Return type: NXOpen.Motion.CustomizedMaterialBuilder
New in version NX12.0.0.
License requirements: mechanisms (“MECHANISMS”)
DampingRatio¶
-
BeamForceBuilder.
DampingRatio
¶ Returns the damping ratio
-------------------------------------
Getter Method
Signature
DampingRatio
Returns: Return type: NXOpen.Expression
New in version NX12.0.0.
License requirements: mechanisms (“MECHANISMS”)
DampingType¶
-
BeamForceBuilder.
DampingType
¶ Returns or sets the damping method
-------------------------------------
Getter Method
Signature
DampingType
Returns: Return type: NXOpen.Motion.BeamForceBuilderDampingTypes
New in version NX12.0.0.
License requirements: mechanisms (“MECHANISMS”)
-------------------------------------
Setter Method
Signature
DampingType
Parameters: type ( NXOpen.Motion.BeamForceBuilderDampingTypes
) –New in version NX12.0.0.
License requirements: mechanisms (“MECHANISMS”)
Direction¶
-
BeamForceBuilder.
Direction
¶ Returns or sets the direction
-------------------------------------
Getter Method
Signature
Direction
Returns: Return type: NXOpen.Direction
New in version NX12.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
Direction
Parameters: direction ( NXOpen.Direction
) –New in version NX12.0.0.
License requirements: mechanisms (“MECHANISMS”)
FreeLength¶
-
BeamForceBuilder.
FreeLength
¶ Returns the free length
-------------------------------------
Getter Method
Signature
FreeLength
Returns: Return type: NXOpen.Expression
New in version NX12.0.0.
License requirements: mechanisms (“MECHANISMS”)
InertiaIyy¶
-
BeamForceBuilder.
InertiaIyy
¶ Returns the inertia Iyy
-------------------------------------
Getter Method
Signature
InertiaIyy
Returns: Return type: NXOpen.Expression
New in version NX12.0.0.
License requirements: mechanisms (“MECHANISMS”)
InertiaIzz¶
-
BeamForceBuilder.
InertiaIzz
¶ Returns the inertia Izz
-------------------------------------
Getter Method
Signature
InertiaIzz
Returns: Return type: NXOpen.Expression
New in version NX12.0.0.
License requirements: mechanisms (“MECHANISMS”)
InertiaK¶
-
BeamForceBuilder.
InertiaK
¶ Returns the inertia K
-------------------------------------
Getter Method
Signature
InertiaK
Returns: Return type: NXOpen.Expression
New in version NX12.0.0.
License requirements: mechanisms (“MECHANISMS”)
IsBeamCrossDamping¶
-
BeamForceBuilder.
IsBeamCrossDamping
¶ Returns or sets the beam cross damping flag
-------------------------------------
Getter Method
Signature
IsBeamCrossDamping
Returns: Return type: bool New in version NX12.0.0.
License requirements: mechanisms (“MECHANISMS”)
-------------------------------------
Setter Method
Signature
IsBeamCrossDamping
Parameters: type (bool) – New in version NX12.0.0.
License requirements: mechanisms (“MECHANISMS”)
Name¶
-
BeamForceBuilder.
Name
¶ Returns or sets the name of the beam force object
-------------------------------------
Getter Method
Signature
Name
Returns: Return type: str New in version NX12.0.0.
License requirements: mechanisms (“MECHANISMS”)
-------------------------------------
Setter Method
Signature
Name
Parameters: name (str) – New in version NX12.0.0.
License requirements: mechanisms (“MECHANISMS”)
VectorType¶
-
BeamForceBuilder.
VectorType
¶ Returns or sets the orientation of beam force
-------------------------------------
Getter Method
Signature
VectorType
Returns: Return type: NXOpen.Motion.BeamForceBuilderVectorTypes
New in version NX12.0.0.
License requirements: mechanisms (“MECHANISMS”)
-------------------------------------
Setter Method
Signature
VectorType
Parameters: vectorType ( NXOpen.Motion.BeamForceBuilderVectorTypes
) –New in version NX12.0.0.
License requirements: mechanisms (“MECHANISMS”)
Method Detail¶
Validate¶
-
BeamForceBuilder.
Validate
¶ Validate whether the inputs to the component are sufficient for commit to be called.
If the component is not in a state to commit then an exception is thrown. For example, if the component requires you to set some property, this method will throw an exception if you haven’t set it. This method throws a not-yet-implemented NXException for some components.
Signature
Validate()
Returns: Was self validation successful Return type: bool New in version NX3.0.1.
License requirements: None.