FlexBodyBuilder Class¶
-
class
NXOpen.Motion.
FlexBodyBuilder
¶ Bases:
NXOpen.Motion.MotionBuilder
Represents a
NXOpen.Motion.FlexBody
builderTo create a new instance of this class, use
NXOpen.Motion.FlexBodyCollection.CreateFlexBodyBuilder()
Default values.
Property Value PositioningType AbsoluteOrigin New in version NX7.5.0.
Properties¶
Property | Description |
---|---|
CutoffDamping | Returns the damping |
CutoffFrequencyIncrement | Returns the cutoff frequency increment |
CutoffLowerFrequency | Returns the cutoff lower frequency |
CutoffUpperFrequency | Returns the cutoff upper frequency |
DisplayScale | Returns or sets the icon display scale |
FileTceName | Returns or sets the TCE RFI file name |
GroupName | Returns or sets the group name |
GroupType | Returns or sets the group type |
MassMatrix0 | Returns or sets the mass 0rd matrix option |
MassMatrix1 | Returns or sets the mass 1st matrix option |
MassMatrix2 | Returns or sets the mass 2nd matrix option |
MassMatrix3 | Returns or sets the mass 3rd matrix option |
MassMatrix4 | Returns or sets the mass 4th matrix option |
MassScalar0 | Returns or sets the mass 0rd scalar option |
MassScalar1 | Returns or sets the mass 1st scalar option |
MassScalar2 | Returns or sets the mass 2nd scalar option |
MassVector0 | Returns or sets the mass 0rd vector option |
MassVector1 | Returns or sets the mass 1st vector option |
MassVector2 | Returns or sets the mass 2nd vector option |
MassVector3 | Returns or sets the mass 3rd vector option |
MassVector4 | Returns or sets the mass 4th vector option |
Name | Returns or sets the flexible body object name |
NativeRfiFileName | Returns or sets the native RFI file name |
NodeTolerance | Returns the tolerance between marker and node coordinate |
PositioningType | Returns or sets the positioning type |
SelectionLink | Returns the selection link |
SourceOption | Returns or sets the file type |
Tag | Returns the Tag for this object. |
TransientTime | Returns the transient time |
TreatAsRigid | Returns or sets the treat as rigid option |
UnitSystem | Returns or sets the unit system ID |
UseFrequencyFiltering | Returns or sets the use frequency filtering option |
UseTransientDamping | Returns or sets the use transient damping option |
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. |
ExportRfiRelatedResults | Export rfi related results in manager mode |
GetCommittedObjects | For builders that create more than one object, this method returns the objects that are created by commit. |
GetMarkerItems | Gets marker to node list Items |
GetObject | Returns the object currently being edited by this builder. |
GetOffsetOrientations | Gets the offset orientations |
GetOffsetPoints | Gets the offset points |
NewListMarkerToNode | Creates a new list item |
SetMarkerItems | Sets marker to node list Items |
SetOffsetOrientations | Sets the offset orientations |
SetOffsetPoints | Sets the offset points |
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¶
FlexBodyBuilderPositioning Enumeration | Represents positioning type of flexible body |
FlexBodyBuilderSourceType Enumeration | Represents rfi file type of flexible body |
FlexBodyBuilderUnitSystemType Enumeration | Represents unit system |
Property Detail¶
CutoffDamping¶
-
FlexBodyBuilder.
CutoffDamping
¶ Returns the damping
-------------------------------------
Getter Method
Signature
CutoffDamping
Returns: Return type: NXOpen.Expression
New in version NX11.0.0.
License requirements: None.
CutoffFrequencyIncrement¶
-
FlexBodyBuilder.
CutoffFrequencyIncrement
¶ Returns the cutoff frequency increment
-------------------------------------
Getter Method
Signature
CutoffFrequencyIncrement
Returns: Return type: NXOpen.Expression
New in version NX11.0.0.
License requirements: None.
CutoffLowerFrequency¶
-
FlexBodyBuilder.
CutoffLowerFrequency
¶ Returns the cutoff lower frequency
-------------------------------------
Getter Method
Signature
CutoffLowerFrequency
Returns: Return type: NXOpen.Expression
New in version NX11.0.0.
License requirements: None.
CutoffUpperFrequency¶
-
FlexBodyBuilder.
CutoffUpperFrequency
¶ Returns the cutoff upper frequency
-------------------------------------
Getter Method
Signature
CutoffUpperFrequency
Returns: Return type: NXOpen.Expression
New in version NX11.0.0.
License requirements: None.
FileTceName¶
-
FlexBodyBuilder.
FileTceName
¶ Returns or sets the TCE RFI file name
-------------------------------------
Getter Method
Signature
FileTceName
Returns: Return type: str New in version NX7.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
FileTceName
Parameters: fileTceName (str) – New in version NX7.5.0.
License requirements: mechanisms (“MECHANISMS”)
MassMatrix0¶
-
FlexBodyBuilder.
MassMatrix0
¶ Returns or sets the mass 0rd matrix option
-------------------------------------
Getter Method
Signature
MassMatrix0
Returns: Return type: bool New in version NX11.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
MassMatrix0
Parameters: massMatrix0 (bool) – New in version NX11.0.0.
License requirements: mechanisms (“MECHANISMS”)
MassMatrix1¶
-
FlexBodyBuilder.
MassMatrix1
¶ Returns or sets the mass 1st matrix option
-------------------------------------
Getter Method
Signature
MassMatrix1
Returns: Return type: bool New in version NX11.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
MassMatrix1
Parameters: massMatrix1 (bool) – New in version NX11.0.0.
License requirements: mechanisms (“MECHANISMS”)
MassMatrix2¶
-
FlexBodyBuilder.
MassMatrix2
¶ Returns or sets the mass 2nd matrix option
-------------------------------------
Getter Method
Signature
MassMatrix2
Returns: Return type: bool New in version NX11.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
MassMatrix2
Parameters: massMatrix2 (bool) – New in version NX11.0.0.
License requirements: mechanisms (“MECHANISMS”)
MassMatrix3¶
-
FlexBodyBuilder.
MassMatrix3
¶ Returns or sets the mass 3rd matrix option
-------------------------------------
Getter Method
Signature
MassMatrix3
Returns: Return type: bool New in version NX11.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
MassMatrix3
Parameters: massMatrix3 (bool) – New in version NX11.0.0.
License requirements: mechanisms (“MECHANISMS”)
MassMatrix4¶
-
FlexBodyBuilder.
MassMatrix4
¶ Returns or sets the mass 4th matrix option
-------------------------------------
Getter Method
Signature
MassMatrix4
Returns: Return type: bool New in version NX11.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
MassMatrix4
Parameters: massMatrix4 (bool) – New in version NX11.0.0.
License requirements: mechanisms (“MECHANISMS”)
MassScalar0¶
-
FlexBodyBuilder.
MassScalar0
¶ Returns or sets the mass 0rd scalar option
-------------------------------------
Getter Method
Signature
MassScalar0
Returns: Return type: bool New in version NX11.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
MassScalar0
Parameters: massScalar0 (bool) – New in version NX11.0.0.
License requirements: mechanisms (“MECHANISMS”)
MassScalar1¶
-
FlexBodyBuilder.
MassScalar1
¶ Returns or sets the mass 1st scalar option
-------------------------------------
Getter Method
Signature
MassScalar1
Returns: Return type: bool New in version NX11.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
MassScalar1
Parameters: massScalar1 (bool) – New in version NX11.0.0.
License requirements: mechanisms (“MECHANISMS”)
MassScalar2¶
-
FlexBodyBuilder.
MassScalar2
¶ Returns or sets the mass 2nd scalar option
-------------------------------------
Getter Method
Signature
MassScalar2
Returns: Return type: bool New in version NX11.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
MassScalar2
Parameters: massScalar2 (bool) – New in version NX11.0.0.
License requirements: mechanisms (“MECHANISMS”)
MassVector0¶
-
FlexBodyBuilder.
MassVector0
¶ Returns or sets the mass 0rd vector option
-------------------------------------
Getter Method
Signature
MassVector0
Returns: Return type: bool New in version NX11.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
MassVector0
Parameters: massVector0 (bool) – New in version NX11.0.0.
License requirements: mechanisms (“MECHANISMS”)
MassVector1¶
-
FlexBodyBuilder.
MassVector1
¶ Returns or sets the mass 1st vector option
-------------------------------------
Getter Method
Signature
MassVector1
Returns: Return type: bool New in version NX11.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
MassVector1
Parameters: massVector1 (bool) – New in version NX11.0.0.
License requirements: mechanisms (“MECHANISMS”)
MassVector2¶
-
FlexBodyBuilder.
MassVector2
¶ Returns or sets the mass 2nd vector option
-------------------------------------
Getter Method
Signature
MassVector2
Returns: Return type: bool New in version NX11.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
MassVector2
Parameters: massVector2 (bool) – New in version NX11.0.0.
License requirements: mechanisms (“MECHANISMS”)
MassVector3¶
-
FlexBodyBuilder.
MassVector3
¶ Returns or sets the mass 3rd vector option
-------------------------------------
Getter Method
Signature
MassVector3
Returns: Return type: bool New in version NX11.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
MassVector3
Parameters: massVector3 (bool) – New in version NX11.0.0.
License requirements: mechanisms (“MECHANISMS”)
MassVector4¶
-
FlexBodyBuilder.
MassVector4
¶ Returns or sets the mass 4th vector option
-------------------------------------
Getter Method
Signature
MassVector4
Returns: Return type: bool New in version NX11.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
MassVector4
Parameters: massVector4 (bool) – New in version NX11.0.0.
License requirements: mechanisms (“MECHANISMS”)
Name¶
-
FlexBodyBuilder.
Name
¶ Returns or sets the flexible body object name
-------------------------------------
Getter Method
Signature
Name
Returns: Return type: str New in version NX7.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
Name
Parameters: name (str) – New in version NX7.5.0.
License requirements: mechanisms (“MECHANISMS”)
NativeRfiFileName¶
-
FlexBodyBuilder.
NativeRfiFileName
¶ Returns or sets the native RFI file name
-------------------------------------
Getter Method
Signature
NativeRfiFileName
Returns: Return type: str New in version NX7.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
NativeRfiFileName
Parameters: nativeRfiFileName (str) – New in version NX7.5.0.
License requirements: mechanisms (“MECHANISMS”)
NodeTolerance¶
-
FlexBodyBuilder.
NodeTolerance
¶ Returns the tolerance between marker and node coordinate
-------------------------------------
Getter Method
Signature
NodeTolerance
Returns: Return type: NXOpen.Expression
New in version NX11.0.0.
License requirements: mechanisms (“MECHANISMS”)
PositioningType¶
-
FlexBodyBuilder.
PositioningType
¶ Returns or sets the positioning type
-------------------------------------
Getter Method
Signature
PositioningType
Returns: Return type: NXOpen.Motion.FlexBodyBuilderPositioning
New in version NX7.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
PositioningType
Parameters: positioningType ( NXOpen.Motion.FlexBodyBuilderPositioning
) –New in version NX7.5.0.
License requirements: mechanisms (“MECHANISMS”)
SelectionLink¶
-
FlexBodyBuilder.
SelectionLink
¶ Returns the selection link
-------------------------------------
Getter Method
Signature
SelectionLink
Returns: Return type: NXOpen.Motion.SelectLink
New in version NX7.5.0.
License requirements: None.
SourceOption¶
-
FlexBodyBuilder.
SourceOption
¶ Returns or sets the file type
-------------------------------------
Getter Method
Signature
SourceOption
Returns: Return type: NXOpen.Motion.FlexBodyBuilderSourceType
New in version NX7.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
SourceOption
Parameters: sourceOption ( NXOpen.Motion.FlexBodyBuilderSourceType
) –New in version NX7.5.0.
License requirements: mechanisms (“MECHANISMS”)
TransientTime¶
-
FlexBodyBuilder.
TransientTime
¶ Returns the transient time
-------------------------------------
Getter Method
Signature
TransientTime
Returns: Return type: NXOpen.Expression
New in version NX11.0.0.
License requirements: None.
TreatAsRigid¶
-
FlexBodyBuilder.
TreatAsRigid
¶ Returns or sets the treat as rigid option
-------------------------------------
Getter Method
Signature
TreatAsRigid
Returns: Return type: bool New in version NX11.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
TreatAsRigid
Parameters: treatAsRigid (bool) – New in version NX11.0.0.
License requirements: mechanisms (“MECHANISMS”)
UnitSystem¶
-
FlexBodyBuilder.
UnitSystem
¶ Returns or sets the unit system ID
-------------------------------------
Getter Method
Signature
UnitSystem
Returns: Return type: NXOpen.Motion.FlexBodyBuilderUnitSystemType
New in version NX11.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
UnitSystem
Parameters: unitSystemID ( NXOpen.Motion.FlexBodyBuilderUnitSystemType
) –New in version NX11.0.0.
License requirements: mechanisms (“MECHANISMS”)
UseFrequencyFiltering¶
-
FlexBodyBuilder.
UseFrequencyFiltering
¶ Returns or sets the use frequency filtering option
-------------------------------------
Getter Method
Signature
UseFrequencyFiltering
Returns: Return type: bool New in version NX11.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
UseFrequencyFiltering
Parameters: useFrequencyFiltering (bool) – New in version NX11.0.0.
License requirements: mechanisms (“MECHANISMS”)
UseTransientDamping¶
-
FlexBodyBuilder.
UseTransientDamping
¶ Returns or sets the use transient damping option
-------------------------------------
Getter Method
Signature
UseTransientDamping
Returns: Return type: bool New in version NX11.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
UseTransientDamping
Parameters: useTransientDamping (bool) – New in version NX11.0.0.
License requirements: mechanisms (“MECHANISMS”)
Method Detail¶
GetMarkerItems¶
-
FlexBodyBuilder.
GetMarkerItems
¶ Gets marker to node list Items
Signature
GetMarkerItems()
Returns: Return type: list of NXOpen.Motion.MarkerToNodeData
New in version NX7.5.0.
License requirements: mechanisms (“MECHANISMS”)
GetOffsetOrientations¶
-
FlexBodyBuilder.
GetOffsetOrientations
¶ Gets the offset orientations
Signature
GetOffsetOrientations()
Returns: Return type: list of float New in version NX7.5.0.
License requirements: mechanisms (“MECHANISMS”)
GetOffsetPoints¶
-
FlexBodyBuilder.
GetOffsetPoints
¶ Gets the offset points
Signature
GetOffsetPoints()
Returns: Return type: list of float New in version NX7.5.0.
License requirements: mechanisms (“MECHANISMS”)
NewListMarkerToNode¶
-
FlexBodyBuilder.
NewListMarkerToNode
¶ Creates a new list item
Signature
NewListMarkerToNode(marker, markerPosition, nodeID, move, nodeLocationX, nodeLocationY, nodeLocationZ)
Parameters: - marker (
NXOpen.NXObject
) – The marker tag - markerPosition (int) – The i or j marker identity
- nodeID (int) – The node ID
- move (bool) – Whether to move the node
- nodeLocationX (float) – The node location X coordinate
- nodeLocationY (float) – The node location Y coordinate
- nodeLocationZ (float) – The node location Z coordinate
Returns: Return type: New in version NX7.5.0.
License requirements: mechanisms (“MECHANISMS”)
- marker (
SetMarkerItems¶
-
FlexBodyBuilder.
SetMarkerItems
¶ Sets marker to node list Items
Signature
SetMarkerItems(markerToNodeListItem)
Parameters: markerToNodeListItem (list of NXOpen.Motion.MarkerToNodeData
) –New in version NX7.5.0.
License requirements: mechanisms (“MECHANISMS”)
SetOffsetOrientations¶
-
FlexBodyBuilder.
SetOffsetOrientations
¶ Sets the offset orientations
Signature
SetOffsetOrientations(offsetOrientations)
Parameters: offsetOrientations (list of float) – New in version NX7.5.0.
License requirements: mechanisms (“MECHANISMS”)
SetOffsetPoints¶
-
FlexBodyBuilder.
SetOffsetPoints
¶ Sets the offset points
Signature
SetOffsetPoints(offsetPoints)
Parameters: offsetPoints (list of float) – New in version NX7.5.0.
License requirements: mechanisms (“MECHANISMS”)
Validate¶
-
FlexBodyBuilder.
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.