NX Open C++ Reference Guide
Public Member Functions | List of all members
NXOpen::CAE::ModelCheck::ModelSetupCheckBuilder Class Reference

Represents a NXOpen::CAE::ModelCheck::ModelSetupCheckBuilder which can be used to check if the active NXOpen::CAE::SimSolution contains all the necessary items for the analysis, including elements, loads, constraints and materials. More...

Inheritance diagram for NXOpen::CAE::ModelCheck::ModelSetupCheckBuilder:
NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Member Functions

bool CheckAllComponents ()
 Returns the value indicating whether to check all components associated with the assembly FEM in the model check, regardless of load status. More...
 
bool CheckLabelConflicts ()
 Returns 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
Created in NX8.5.0. More...
 
bool CheckUnconnectedComponent ()
 Returns the option specifying whether to check for component FEMs that are not connected
Created in NX8.5.0. More...
 
int DoCheck ()
 Performs model setup check. More...
 
bool IsDetailedMessage ()
 Returns the value indicating whether to list comprehensive descriptions of any problems and suggest possible remedies. More...
 
NXString ReportFileName ()
 Returns the full name of the report file. More...
 
void SetCheckAllComponents (bool checkAllComponents)
 Sets the value indicating whether to check all components associated with the assembly FEM in the model check, regardless of load status. More...
 
void SetCheckLabelConflicts (bool checkLabelConflicts)
 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
Created in NX8.5.0. More...
 
void SetCheckUnconnectedComponent (bool checkUnconnectedComponent)
 Sets the option specifying whether to check for component FEMs that are not connected
Created in NX8.5.0. More...
 
void SetDetailedMessage (bool isDetailedMessage)
 Sets the value indicating whether to list comprehensive descriptions of any problems and suggest possible remedies. More...
 
void SetReportFileName (const NXString &reportFileName)
 Sets the full name of the report file. More...
 
void SetReportFileName (const char *reportFileName)
 Sets the full name of the report file. More...
 
- Public Member Functions inherited from NXOpen::Builder
NXOpen::NXObjectCommit ()
 Commits any edits that have been applied to the builder. More...
 
void Destroy ()
 Deletes the builder, and cleans up any objects created by the builder. More...
 
std::vector< NXOpen::NXObject * > GetCommittedObjects ()
 For builders that create more than one object, this method returns the objects that are created by commit. More...
 
NXOpen::NXObjectGetObject ()
 Returns the object currently being edited by this builder. More...
 
void ShowResults ()
 Updates the model to reflect the result of an edit to the model for all builders that support showing results. More...
 
virtual bool Validate ()
 Validate whether the inputs to the component are sufficient for commit to be called. More...
 
- Public Member Functions inherited from NXOpen::TaggedObject
tag_t Tag () const
 Returns the tag of this object. More...
 

Detailed Description

Represents a NXOpen::CAE::ModelCheck::ModelSetupCheckBuilder which can be used to check if the active NXOpen::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, use NXOpen::CAE::ModelCheckManager::CreateModelSetupCheckBuilder

Created in NX8.5.0.

Member Function Documentation

bool NXOpen::CAE::ModelCheck::ModelSetupCheckBuilder::CheckAllComponents ( )

Returns 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
Created in NX8.5.0.

License requirements : None

bool NXOpen::CAE::ModelCheck::ModelSetupCheckBuilder::CheckLabelConflicts ( )

Returns 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
Created in NX8.5.0.



License requirements : None

bool NXOpen::CAE::ModelCheck::ModelSetupCheckBuilder::CheckUnconnectedComponent ( )

Returns the option specifying whether to check for component FEMs that are not connected
Created in NX8.5.0.



License requirements : None

int NXOpen::CAE::ModelCheck::ModelSetupCheckBuilder::DoCheck ( )

Performs model setup check.

Returns
Model setup checking result. Zero indicates the checking is successful
Created in NX11.0.0.

License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")
bool NXOpen::CAE::ModelCheck::ModelSetupCheckBuilder::IsDetailedMessage ( )

Returns 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
Created in NX8.5.0.

License requirements : None

NXString NXOpen::CAE::ModelCheck::ModelSetupCheckBuilder::ReportFileName ( )

Returns the full name of the report file.

If NULL, the report is listed in a separate listing window
Created in NX8.5.0.

License requirements : None

void NXOpen::CAE::ModelCheck::ModelSetupCheckBuilder::SetCheckAllComponents ( bool  checkAllComponents)

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
Created in NX8.5.0.

License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")

Parameters
checkAllComponentscheckallcomponents
void NXOpen::CAE::ModelCheck::ModelSetupCheckBuilder::SetCheckLabelConflicts ( bool  checkLabelConflicts)

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
Created in NX8.5.0.



License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")

Parameters
checkLabelConflictschecklabelconflicts
void NXOpen::CAE::ModelCheck::ModelSetupCheckBuilder::SetCheckUnconnectedComponent ( bool  checkUnconnectedComponent)

Sets the option specifying whether to check for component FEMs that are not connected
Created in NX8.5.0.



License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")

Parameters
checkUnconnectedComponentcheckunconnectedcomponent
void NXOpen::CAE::ModelCheck::ModelSetupCheckBuilder::SetDetailedMessage ( bool  isDetailedMessage)

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
Created in NX8.5.0.

License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")

Parameters
isDetailedMessageisdetailedmessage
void NXOpen::CAE::ModelCheck::ModelSetupCheckBuilder::SetReportFileName ( const NXString reportFileName)

Sets the full name of the report file.

If NULL, the report is listed in a separate listing window
Created in NX8.5.0.

License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")

Parameters
reportFileNamereportfilename
void NXOpen::CAE::ModelCheck::ModelSetupCheckBuilder::SetReportFileName ( const char *  reportFileName)

Sets the full name of the report file.

If NULL, the report is listed in a separate listing window
Created in NX8.5.0.

License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")

Parameters
reportFileNamereportfilename

The documentation for this class was generated from the following file:
Copyright 2017 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.