NX Open C++ Reference Guide
Public Types | Public Member Functions
NXOpen::CAE::SimSolution Class Reference

Represents a solution in the .sim files. More...

Inheritance diagram for NXOpen::CAE::SimSolution:
NXOpen::CAE::SimGroupContainer NXOpen::NXObject NXOpen::TaggedObject NXOpen::INXObject

List of all members.

Public Types

enum  SetupCheckOption { SetupCheckOptionDoNotCheck, SetupCheckOptionCheckAndStopAtFirstError, SetupCheckOptionCompleteCheckAndOutputErrors }
 Model Setup Check Options. More...
enum  SolveOption {
  SolveOptionSolve, SolveOptionWriteSolverInputFile, SolveOptionSolveInputFile, SolveOptionWriteEditAndSolveInputFile,
  SolveOptionEditSolverInputFile
}
 Solve Options. More...

Public Member Functions

NXOpen::CAE::SimSolutionStepActiveStep ()
 Returns the active step
Created in NX4.0.0.
void AddBc (NXOpen::CAE::SimBC *bc)
 Add the bc to the solution.
void AddStep (NXOpen::CAE::SimSolutionStep *step)
 Adds a step to the solution.
int AllowedStepTypeCount ()
 Returns the count of allowable step types.
NXString AnalysisType ()
 Returns the analysis type.
void ApplySolverLanguageExportOptions (NXOpen::CAE::CaeDataContainer *propertyList)
 Stores the solver language export options to the specified solution.
NXOpen::CAE::CompanionResultCollectionCompanionResults ()
 Returns the CAE Companion Results collection belonging to this Solution
Created in NX7.5.0.
int ConflictingConstraintsCount ()
 Returns the number of conflicting constraint pairs in this solution
Created in NX8.0.0.
NXOpen::CAE::CorrelAlignmentBuilderCreateAlignmentBuilder ()
 Creates the builder object for test and imported solution alignment dialog.
NXOpen::CAE::ConstraintResolutionBuilderCreateConstraintResolutionBuilder (NXOpen::CAE::SimGroupContainer *tStep, NXOpen::CAE::SimConstraint *tConstraint1, NXOpen::CAE::SimConstraint *tConstraint2)
 Creates a constraint resolution builder for this input pair of constraints.
NXOpen::CAE::SimSolutionStepCreateStep (int stepType, const NXString &stepName)
 Creates a step and add to the solution.
void DeleteStep (NXOpen::CAE::SimSolutionStep *step)
 Removes a step from the solution.
void GetConflictingConstraintPairByIndex (int index, NXOpen::CAE::SimConstraint **tConstrain1, NXOpen::CAE::SimConstraint **tConstrain2, bool *ignored)
 Returns the nth conflicting constraint pair, where the index is between 0 and CAE::SimSolution::ConflictingConstraintsCount - 1
Created in NX8.0.0.
NXOpen::CAE::SimSolutionStepGetStepByIndex (int stepIndex)
 Returns the step at the index passed.
NXOpen::CAE::PropertyTablePropertyTable ()
 Returns the property table associated with the solution object
Created in NX4.0.0.
void RemoveBc (NXOpen::CAE::SimBC *bc)
 Remove the bc from the solution.
void Rename (const NXString &name, bool renameResults)
 Rename Solution and optionally rename associated results files
Created in NX6.0.2.
void ResolveConstraintConflicts ()
 Runs the Assisted Conflict Check Mechanism for all constraints CAE::SimConstraint in an active solution CAE::SimSolution and/or in an active step CAE::SimSolutionStep , generating new constraints CAE::SimConstraint if there is any conflcit between the constraints.
void SetActiveStep (NXOpen::CAE::SimSolutionStep *activeStep)
 Sets the active step
Created in NX4.0.0.
NXString SolutionType ()
 Returns the solution type.
void Solve (NXOpen::CAE::SimSolution::SolveOption solveOption, NXOpen::CAE::SimSolution::SetupCheckOption setupCheckOption)
 Solves the solution.
NXOpen::CAE::PropertyTableSolverOptionsPropertyTable ()
 Returns the property table associated with the solution's solver options
Created in NX6.0.2.
NXString SolverType ()
 Returns the solver type.
int StepCount ()
 Returns the number of steps.

Detailed Description

Represents a solution in the .sim files.

For more information, refer to the Solver language documentation in the Solver language documentation .


To create a new instance of this class, use CAE::SimSimulation::CreateSolution

Created in NX4.0.0.


Member Enumeration Documentation

Model Setup Check Options.

Enumerator:
SetupCheckOptionDoNotCheck 

do perform any set up checks

SetupCheckOptionCheckAndStopAtFirstError 

perform set up checks but stop at first error

SetupCheckOptionCompleteCheckAndOutputErrors 

perform all set up checks and report all errors

Solve Options.

Enumerator:
SolveOptionSolve 

write solver input file and launch solve

SolveOptionWriteSolverInputFile 

write solver input file only

SolveOptionSolveInputFile 

launch solve with existing solver input file

SolveOptionWriteEditAndSolveInputFile 

write solver input file, allow edit and then launch solve

SolveOptionEditSolverInputFile 

edit existing solver input file


Member Function Documentation

Returns the active step
Created in NX4.0.0.



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

Add the bc to the solution.


Created in NX4.0.0.

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

Parameters:
bcthe bc to be added

Adds a step to the solution.


Created in NX4.0.0.

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

Parameters:
stepsolution step to be added

Returns the count of allowable step types.


Created in NX4.0.0.

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

Returns the analysis type.


Created in NX4.0.0.

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

Stores the solver language export options to the specified solution.


Created in NX8.0.0.

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

Parameters:
propertyListthe export option parameters. See CAE::CaeSession::GetDataContainer .

Returns the CAE Companion Results collection belonging to this Solution
Created in NX7.5.0.


Returns the number of conflicting constraint pairs in this solution
Created in NX8.0.0.



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

Creates the builder object for test and imported solution alignment dialog.

Returns:

Created in NX7.5.0.

License requirements : nx_correl_base ("FE Correlation")

Creates a constraint resolution builder for this input pair of constraints.

Returns:

Created in NX8.0.0.

License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")
Parameters:
tStepsolution step. can be same as solution
tConstraint1first constraint in conflict
tConstraint2second constraint in conflict

Creates a step and add to the solution.

Returns:
step CAE::SimSolutionStep to be added
Created in NX4.0.0.

License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")
Parameters:
stepTypeindex of the step type
stepNamename of the step
NOTE: The full Unicode character set is not supported for this parameter.

Removes a step from the solution.


Created in NX4.0.0.

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

Parameters:
stepstep CAE::SimSolutionStep to be added
void NXOpen::CAE::SimSolution::GetConflictingConstraintPairByIndex ( int  index,
NXOpen::CAE::SimConstraint **  tConstrain1,
NXOpen::CAE::SimConstraint **  tConstrain2,
bool *  ignored 
)

Returns the nth conflicting constraint pair, where the index is between 0 and CAE::SimSolution::ConflictingConstraintsCount - 1
Created in NX8.0.0.



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

Parameters:
indexindex of the conflicting constraint pair, which is between 0 and CAE::SimSolution::ConflictingConstraintsCount - 1
tConstrain1constraint1 for this constraint pair
tConstrain2constraint2 for this constraint pair
ignoredindicates that this conflict pair was previously resolved using the CAE::ConstraintResolutionBuilder::RuleIgnoreConflict

Returns the step at the index passed.

Returns:
step CAE::SimSolutionStep at the index
Created in NX4.0.0.

License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")
Parameters:
stepIndexindex of the step

Returns the property table associated with the solution object
Created in NX4.0.0.



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

Remove the bc from the solution.


Created in NX4.0.0.

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

Parameters:
bcthe bc to be removed
void NXOpen::CAE::SimSolution::Rename ( const NXString name,
bool  renameResults 
)

Rename Solution and optionally rename associated results files
Created in NX6.0.2.



License requirements : None

Parameters:
namenew solution name
NOTE: The full Unicode character set is not supported for this parameter.
renameResultstrue if you what associated results files to be renamed as well

Runs the Assisted Conflict Check Mechanism for all constraints CAE::SimConstraint in an active solution CAE::SimSolution and/or in an active step CAE::SimSolutionStep , generating new constraints CAE::SimConstraint if there is any conflcit between the constraints.


Created in NX6.0.0.

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

Sets the active step
Created in NX4.0.0.



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

Parameters:
activeStepactive step CAE::SimSolutionStep

Returns the solution type.


Created in NX4.0.0.

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

Solves the solution.


Created in NX6.0.2.

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

Parameters:
solveOptionsolve option
setupCheckOptionsetup check option

Returns the property table associated with the solution's solver options
Created in NX6.0.2.



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

Returns the solver type.


Created in NX4.0.0.

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

Returns the number of steps.


Created in NX4.0.0.

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


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