ModelSetupCheckBuilder Class¶
-
class
NXOpen.CAE.ModelCheck.
ModelSetupCheckBuilder
¶ Bases:
NXOpen.Builder
Represents a
NXOpen.CAE.ModelCheck.ModelSetupCheckBuilder
which can be used to check if the activeNXOpen.CAE.SimSolution
contains all the necessary items for the analysis, including elements, loads, constraints and materials.Also it could check label conficts and component connect status.
Builder.Commit()
performs the check. The check result is written into a report file or listed in a separate information window, along with an error summary for each topic To create a new instance of this class, useNXOpen.CAE.ModelCheckManager.CreateModelSetupCheckBuilder()
New in version NX8.5.0.
Properties¶
Property | Description |
---|---|
CheckAllComponents | Returns or sets the value indicating whether to check all components associated with the assembly FEM in the model check, regardless of load status. |
CheckLabelConflicts | Returns or sets the value indicating whether to check labeling conflicts for node, element and coordindate system across component FEMS and reports the label range in which the conflict occurs |
CheckUnconnectedComponent | Returns or sets the option specifying whether to check for component FEMs that are not connected |
IsDetailedMessage | Returns or sets the value indicating whether to list comprehensive descriptions of any problems and suggest possible remedies. |
ReportFileName | Returns or sets the full name of the report file. |
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. |
DoCheck | Performs model setup check |
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. |
Property Detail¶
CheckAllComponents¶
-
ModelSetupCheckBuilder.
CheckAllComponents
¶ Returns or sets the value indicating whether to check all components associated with the assembly FEM in the model check, regardless of load status.
If false, only the fully loaded components are included in the check
-------------------------------------
Getter Method
Signature
CheckAllComponents
Returns: Return type: bool New in version NX8.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
CheckAllComponents
Parameters: checkAllComponents (bool) – New in version NX8.5.0.
License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)
CheckLabelConflicts¶
-
ModelSetupCheckBuilder.
CheckLabelConflicts
¶ Returns or sets the value indicating whether to check labeling conflicts for node, element and coordindate system across component FEMS and reports the label range in which the conflict occurs
-------------------------------------
Getter Method
Signature
CheckLabelConflicts
Returns: Return type: bool New in version NX8.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
CheckLabelConflicts
Parameters: checkLabelConflicts (bool) – New in version NX8.5.0.
License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)
CheckUnconnectedComponent¶
-
ModelSetupCheckBuilder.
CheckUnconnectedComponent
¶ Returns or sets the option specifying whether to check for component FEMs that are not connected
-------------------------------------
Getter Method
Signature
CheckUnconnectedComponent
Returns: Return type: bool New in version NX8.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
CheckUnconnectedComponent
Parameters: checkUnconnectedComponent (bool) – New in version NX8.5.0.
License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)
IsDetailedMessage¶
-
ModelSetupCheckBuilder.
IsDetailedMessage
¶ Returns or sets the value indicating whether to list comprehensive descriptions of any problems and suggest possible remedies.
If false, only the simple descriptions of problems are listed
-------------------------------------
Getter Method
Signature
IsDetailedMessage
Returns: Return type: bool New in version NX8.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
IsDetailedMessage
Parameters: isDetailedMessage (bool) – New in version NX8.5.0.
License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)
ReportFileName¶
-
ModelSetupCheckBuilder.
ReportFileName
¶ Returns or sets the full name of the report file.
If NULL, the report is listed in a separate listing window
-------------------------------------
Getter Method
Signature
ReportFileName
Returns: Return type: str New in version NX8.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ReportFileName
Parameters: reportFileName (str) – New in version NX8.5.0.
License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)
Method Detail¶
DoCheck¶
-
ModelSetupCheckBuilder.
DoCheck
¶ Performs model setup check
Signature
DoCheck()
Returns: Model setup checking result. Zero indicates the checking is successful Return type: int New in version NX11.0.0.
License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)
Validate¶
-
ModelSetupCheckBuilder.
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.