NodalForceReportBuilder Class¶
-
class
NXOpen.CAE.
NodalForceReportBuilder
¶ Bases:
NXOpen.Builder
Nodal Force Report Builder
An instance of this class can not be obtained
New in version NX12.0.0.
Properties¶
Property | Description |
---|---|
AddAllForcesAndMoments | Returns or sets the add all forces and moments |
AllElems | Returns or sets the all elems |
AllNodes | Returns or sets the all nodes |
CSysType | Returns or sets the csys type |
CalculateMomentAboutPoint | Returns or sets the calculate moment about a point option |
Csys | Returns or sets the csys |
Deformation | Returns or sets the deformation |
ElemRefs | Returns the select elements |
ForceType | Returns or sets the force type |
GridPointAppliedForce | Returns or sets the grid point applied force |
GridPointForce | Returns or sets the grid point force |
GridPointReactionForce | Returns or sets the grid point reaction force |
GridPointReactionForceMPC | Returns or sets the grid point reaction force mpc |
LoadCaseIndex | Returns or sets the loadcase index |
LoadCaseType | Returns or sets the loadcase setting |
NfrName | Returns or sets the nfr name |
NodeRefs | Returns the select nodes |
RefPoint | Returns or sets the reference point |
Tag | Returns the Tag for this object. |
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¶
NodalForceReportBuilderCSType Enumeration | CSys type definition |
NodalForceReportBuilderForce Enumeration | Force type definition |
NodalForceReportBuilderLoadcaseSelection Enumeration | Loadcase definition method |
Property Detail¶
AddAllForcesAndMoments¶
-
NodalForceReportBuilder.
AddAllForcesAndMoments
¶ Returns or sets the add all forces and moments
-------------------------------------
Getter Method
Signature
AddAllForcesAndMoments
Returns: Return type: bool New in version NX11.0.2.
License requirements: None.
-------------------------------------
Setter Method
Signature
AddAllForcesAndMoments
Parameters: addAllForcesAndMoments (bool) – New in version NX11.0.2.
License requirements: None.
AllElems¶
-
NodalForceReportBuilder.
AllElems
¶ Returns or sets the all elems
-------------------------------------
Getter Method
Signature
AllElems
Returns: Return type: bool New in version NX11.0.2.
License requirements: None.
-------------------------------------
Setter Method
Signature
AllElems
Parameters: allElems (bool) – New in version NX11.0.2.
License requirements: None.
AllNodes¶
-
NodalForceReportBuilder.
AllNodes
¶ Returns or sets the all nodes
-------------------------------------
Getter Method
Signature
AllNodes
Returns: Return type: bool New in version NX11.0.2.
License requirements: None.
-------------------------------------
Setter Method
Signature
AllNodes
Parameters: allNodes (bool) – New in version NX11.0.2.
License requirements: None.
CSysType¶
-
NodalForceReportBuilder.
CSysType
¶ Returns or sets the csys type
-------------------------------------
Getter Method
Signature
CSysType
Returns: Return type: NXOpen.CAE.NodalForceReportBuilderCSType
New in version NX11.0.2.
License requirements: None.
-------------------------------------
Setter Method
Signature
CSysType
Parameters: cSysType ( NXOpen.CAE.NodalForceReportBuilderCSType
) –New in version NX11.0.2.
License requirements: None.
CalculateMomentAboutPoint¶
-
NodalForceReportBuilder.
CalculateMomentAboutPoint
¶ Returns or sets the calculate moment about a point option
-------------------------------------
Getter Method
Signature
CalculateMomentAboutPoint
Returns: Return type: bool New in version NX12.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
CalculateMomentAboutPoint
Parameters: calculateMomentAboutPoint (bool) – New in version NX11.0.2.
License requirements: None.
Csys¶
-
NodalForceReportBuilder.
Csys
¶ Returns or sets the csys
-------------------------------------
Getter Method
Signature
Csys
Returns: Return type: NXOpen.CoordinateSystem
New in version NX11.0.2.
License requirements: None.
-------------------------------------
Setter Method
Signature
Csys
Parameters: csys ( NXOpen.CoordinateSystem
) –New in version NX11.0.2.
License requirements: None.
Deformation¶
-
NodalForceReportBuilder.
Deformation
¶ Returns or sets the deformation
-------------------------------------
Getter Method
Signature
Deformation
Returns: Return type: bool New in version NX11.0.2.
License requirements: None.
-------------------------------------
Setter Method
Signature
Deformation
Parameters: deformation (bool) – New in version NX11.0.2.
License requirements: None.
ElemRefs¶
-
NodalForceReportBuilder.
ElemRefs
¶ Returns the select elements
-------------------------------------
Getter Method
Signature
ElemRefs
Returns: Return type: NXOpen.CAE.SelectElementsBuilder
New in version NX11.0.2.
License requirements: None.
ForceType¶
-
NodalForceReportBuilder.
ForceType
¶ Returns or sets the force type
-------------------------------------
Getter Method
Signature
ForceType
Returns: Return type: NXOpen.CAE.NodalForceReportBuilderForce
New in version NX11.0.2.
License requirements: None.
-------------------------------------
Setter Method
Signature
ForceType
Parameters: forceType ( NXOpen.CAE.NodalForceReportBuilderForce
) –New in version NX11.0.2.
License requirements: None.
GridPointAppliedForce¶
-
NodalForceReportBuilder.
GridPointAppliedForce
¶ Returns or sets the grid point applied force
-------------------------------------
Getter Method
Signature
GridPointAppliedForce
Returns: Return type: bool New in version NX11.0.2.
License requirements: None.
-------------------------------------
Setter Method
Signature
GridPointAppliedForce
Parameters: gridPointAppliedForce (bool) – New in version NX11.0.2.
License requirements: None.
GridPointForce¶
-
NodalForceReportBuilder.
GridPointForce
¶ Returns or sets the grid point force
-------------------------------------
Getter Method
Signature
GridPointForce
Returns: Return type: bool New in version NX11.0.2.
License requirements: None.
-------------------------------------
Setter Method
Signature
GridPointForce
Parameters: gridPointForce (bool) – New in version NX11.0.2.
License requirements: None.
GridPointReactionForce¶
-
NodalForceReportBuilder.
GridPointReactionForce
¶ Returns or sets the grid point reaction force
-------------------------------------
Getter Method
Signature
GridPointReactionForce
Returns: Return type: bool New in version NX11.0.2.
License requirements: None.
-------------------------------------
Setter Method
Signature
GridPointReactionForce
Parameters: gridPointReactionForce (bool) – New in version NX11.0.2.
License requirements: None.
GridPointReactionForceMPC¶
-
NodalForceReportBuilder.
GridPointReactionForceMPC
¶ Returns or sets the grid point reaction force mpc
-------------------------------------
Getter Method
Signature
GridPointReactionForceMPC
Returns: Return type: bool New in version NX11.0.2.
License requirements: None.
-------------------------------------
Setter Method
Signature
GridPointReactionForceMPC
Parameters: gridPointReactionForceMPC (bool) – New in version NX11.0.2.
License requirements: None.
LoadCaseIndex¶
-
NodalForceReportBuilder.
LoadCaseIndex
¶ Returns or sets the loadcase index
-------------------------------------
Getter Method
Signature
LoadCaseIndex
Returns: Return type: int New in version NX11.0.2.
License requirements: None.
-------------------------------------
Setter Method
Signature
LoadCaseIndex
Parameters: loadcaseIndex (int) – New in version NX11.0.2.
License requirements: None.
LoadCaseType¶
-
NodalForceReportBuilder.
LoadCaseType
¶ Returns or sets the loadcase setting
-------------------------------------
Getter Method
Signature
LoadCaseType
Returns: Return type: NXOpen.CAE.NodalForceReportBuilderLoadcaseSelection
New in version NX11.0.2.
License requirements: None.
-------------------------------------
Setter Method
Signature
LoadCaseType
Parameters: loadcaseSetting ( NXOpen.CAE.NodalForceReportBuilderLoadcaseSelection
) –New in version NX11.0.2.
License requirements: None.
NfrName¶
-
NodalForceReportBuilder.
NfrName
¶ Returns or sets the nfr name
-------------------------------------
Getter Method
Signature
NfrName
Returns: Return type: str New in version NX11.0.2.
License requirements: None.
-------------------------------------
Setter Method
Signature
NfrName
Parameters: nfrName (str) – New in version NX11.0.2.
License requirements: None.
NodeRefs¶
-
NodalForceReportBuilder.
NodeRefs
¶ Returns the select nodes
-------------------------------------
Getter Method
Signature
NodeRefs
Returns: Return type: NXOpen.CAE.SelectFENodeList
New in version NX11.0.2.
License requirements: None.
RefPoint¶
-
NodalForceReportBuilder.
RefPoint
¶ Returns or sets the reference point
-------------------------------------
Getter Method
Signature
RefPoint
Returns: Return type: NXOpen.Point
New in version NX11.0.2.
License requirements: None.
-------------------------------------
Setter Method
Signature
RefPoint
Parameters: refPoint ( NXOpen.Point
) –New in version NX11.0.2.
License requirements: None.
Method Detail¶
Validate¶
-
NodalForceReportBuilder.
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.