NX Open C++ Reference Guide
Public Member Functions
NXOpen::CAE::SimSimulation Class Reference

This is the root object in a .sim file. More...

Inheritance diagram for NXOpen::CAE::SimSimulation:
NXOpen::NXObject NXOpen::TaggedObject NXOpen::INXObject

List of all members.

Public Member Functions

NXOpen::CAE::SimSolutionActiveSolution ()
 Returns the active solution.
void AddBc (NXOpen::CAE::SimBC *bc, NXOpen::CAE::SimSolution *solution, NXOpen::CAE::SimSolutionStep *solutionStep)
 Adds the boundary condition to the step in the solution passed.
NXOpen::CAE::CaeDOFSetCollectionCaeDOFSets ()
 Returns the CAE DOFSet collection belonging to this sim part
Created in NX7.5.0.
NXOpen::CAE::CaeRegionCollectionCaeRegions ()
 Returns the CAE region collection belonging to this sim part
Created in NX7.5.0.
NXOpen::CAE::SimSolutionCloneSolution (NXOpen::CAE::SimSolution *oldSolution, const NXString &suggestedName)
 Clone the solution.
NXOpen::CAE::SimConstraintCollectionConstraints ()
 Returns the constraint collection belonging to this sim part
Created in NX3.0.0.
NXOpen::CAE::CorrelManagerCorrelManager ()
 Returns the correl manager belonging to this sim part
Created in NX3.0.0.
NXOpen::CAE::AutoBCBuilderCreateAutoBcBuilder (const NXString &pcBCDescName)
 Creates a CAE::AutoBCBuilder.
NXOpen::CAE::AutoBCBuilderCreateAutoBcBuilder (const NXString &pcBCDescName, const NXString &pcRecipeName)
 Creates a CAE::AutoBCBuilder.
NXOpen::CAE::AutoPairsBuilderCreateAutoPairsBuilder (const NXString &pcBCDescName)
 Creates a CAE::AutoPairsBuilder.
NXOpen::CAE::SimBCBuilderCreateBcBuilderForBc (NXOpen::CAE::SimBC *bc)
 Creates a BC builder for the BC passed.
NXOpen::CAE::SimBCBuilderCreateBcBuilderForConstraintDescriptor (const NXString &bcDescName, const NXString &bcName)
 Creates a BC builder for the constraint descriptor passed.
NXOpen::CAE::SimBCBuilderCreateBcBuilderForConstraintDescriptor (const NXString &bcDescName, const NXString &bcName, int label)
 Creates a BC builder for the constraint descriptor passed.
NXOpen::CAE::SimBCBuilderCreateBcBuilderForLoadDescriptor (const NXString &bcDescName, const NXString &bcName)
 Creates a BC builder for the load descriptor passed.
NXOpen::CAE::SimBCBuilderCreateBcBuilderForLoadDescriptor (const NXString &bcDescName, const NXString &bcName, int label)
 Creates a BC builder for the load descriptor passed.
NXOpen::CAE::SimBCBuilderCreateBcBuilderForSimulationObjectDescriptor (const NXString &bcDescName, const NXString &bcName)
 Creates a BC builder for the simulation object descriptor passed.
NXOpen::CAE::SimBCBuilderCreateBcBuilderForSimulationObjectDescriptor (const NXString &bcDescName, const NXString &bcName, int label)
 Creates a BC builder for the simulation object descriptor passed.
NXOpen::CAE::CaeRegionBuilderCreateCaeRegionBuilder (const NXString &pcRegionDescName, NXOpen::CAE::CaeRegion *tRegion)
 Creates a CAE::CaeRegionBuilder.
NXOpen::CAE::LaminateMetaSolBuilderCreateLaminateMetaSolBuilder (NXOpen::CAE::LaminateMetaSol *tMetaSol)
 Creates a CAE::LaminateMetaSolBuilder.
NXOpen::CAE::LaminateQuickPostReportBuilderCreateLaminateQuickPostReportBuilder (NXOpen::CAE::LaminateQuickPostReport *tSpec)
 Creates a CAE::LaminateQuickPostReportBuilder.
NXOpen::CAE::SimMotionLoadsBuilderCreateMotionLoadsBuilder ()
 Creates a CAE::SimMotionLoadsBuilder.
NXOpen::CAE::SimMotionLoadsListItemBuilderCreateMotionLoadsListItemBuilder ()
 Creates a CAE::SimMotionLoadsListItemBuilder.
NXOpen::CAE::SimSolutionCreateSolution (const NXString &solverType, const NXString &analysisType, const NXString &solutionType, const NXString &name)
 Creates a solution.
NXOpen::CAE::SimSolutionStepCreateSolutionStep (NXOpen::CAE::SimSolution *solution, int stepType, const NXString &name)
 Creates a step and add to the solution.
void DeleteSolution (NXOpen::CAE::SimSolution *solution)
 Delete the solution.
NXOpen::CAE::DurabilityManagerDurabilityManager ()
 Returns the durability manager belonging to this sim part
Created in NX7.5.0.
NXOpen::CAE::FEModelOccurrenceFemodel ()
 Returns the femodeloccurrence CAE::FEModelOccurrence assoicated with the simulation object.
NXOpen::CAE::LaminateManagerLaminateManager ()
 Returns the laminate manager belonging to this sim part
Created in NX8.0.0.
NXOpen::CAE::SimLoadCollectionLoads ()
 Returns the load collection belonging to this sim part
Created in NX3.0.0.
NXOpen::CAE::Optimization::DAOOptimizationManagerOptimizationManager ()
 Returns the Design and Analysis optimization manager belonging to this sim part
Created in NX8.0.0.
NXOpen::CAE::ResponseSimulation::ManagerResponseSimulationManager ()
 Returns the response simulation manager belonging to this sim part
Created in NX3.0.0.
NXOpen::CAE::ResultMeasureCollectionResultMeasures ()
 Returns the CAE ResultMeasure collection belonging to this sim part
Created in NX8.0.0.
void SetActiveSolution (NXOpen::CAE::SimSolution *activeSolution)
 Sets the active solution.
NXOpen::CAE::SimSimulationObjectCollectionSimulationObjects ()
 Returns the simulation object collection belonging to this sim part
Created in NX3.0.0.
NXOpen::CAE::SimRecipeCollectionSimulationRecipes ()
 Returns the simulation recipe collection belonging to this sim part
Created in NX3.0.0.
NXOpen::CAE::SimSolutionCollectionSolutions ()
 Returns the CAE Solution collection belonging to this sim part
Created in NX7.5.0.
NXOpen::CAE::Optimization::TBSOptimizationManagerTBSOptimizationManager ()
 Returns the optimization manager belonging to this sim part
Created in NX8.0.0.

Detailed Description

This is the root object in a .sim file.

Only one instance of this class will exist in each fem part file


To obtain an instance of this class, use CAE::SimPart::Simulation

Created in NX4.0.0.


Member Function Documentation

Returns the active solution.


Created in NX4.0.0.

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

Adds the boundary condition to the step in the solution passed.

If solution is NULL then the boundary condition is added to the active solution If step is NULL then the boundary condition is added to the active step


Created in NX4.0.0.

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

Parameters:
bcbc object
solutionsolution
solutionStepsolution step

Returns the CAE DOFSet collection belonging to this sim part
Created in NX7.5.0.


Returns the CAE region collection belonging to this sim part
Created in NX7.5.0.


Clone the solution.

Returns:
the newly created CAE::SimSolution
Created in NX4.0.0.

License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")
Parameters:
oldSolutionthe CAE::SimSolution to be cloned
suggestedNamename to use instead of default name (may be NULL)
NOTE: The full Unicode character set is not supported for this parameter.

Returns the constraint collection belonging to this sim part
Created in NX3.0.0.


Returns the correl manager belonging to this sim part
Created in NX3.0.0.


Creates a CAE::AutoBCBuilder.

Returns:
The AutoBCBuilder object
Deprecated:
Deprecated in NX6.0.0.


Created in NX5.0.0.

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

Parameters:
pcBCDescNameThe neutral name of the LBCDescriptor.
NOTE: The full Unicode character set is not supported for this parameter.

Creates a CAE::AutoBCBuilder.

Returns:
The AutoBCBuilder object
Created in NX6.0.0.

License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")
Parameters:
pcBCDescNameThe neutral name of the LBCDescriptor.
NOTE: The full Unicode character set is not supported for this parameter.
pcRecipeNameThe name of the AutoBCRecipe
NOTE: The full Unicode character set is not supported for this parameter.

Creates a CAE::AutoPairsBuilder.

Returns:
The AutoPairsBuilder object
Created in NX5.0.0.

License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")
Parameters:
pcBCDescNameThe neutral name of the AutoPairsDescriptor.
NOTE: The full Unicode character set is not supported for this parameter.

Creates a BC builder for the BC passed.

Returns:
bc builder
Created in NX4.0.0.

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

Creates a BC builder for the constraint descriptor passed.

Returns:
bc builder
Created in NX4.0.0.

License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")
Parameters:
bcDescNamename of the constraint descriptor
NOTE: The full Unicode character set is not supported for this parameter.
bcNamename of the constraint to be created
NOTE: The full Unicode character set is not supported for this parameter.

Creates a BC builder for the constraint descriptor passed.

Returns:
bc builder
Created in NX7.5.0.

License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")
Parameters:
bcDescNamename of the constraint descriptor
NOTE: The full Unicode character set is not supported for this parameter.
bcNamename of the constraint to be created
NOTE: The full Unicode character set is not supported for this parameter.
labelconstraint label

Creates a BC builder for the load descriptor passed.

Returns:
bc builder
Created in NX4.0.0.

License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")
Parameters:
bcDescNamename of the load descriptor
NOTE: The full Unicode character set is not supported for this parameter.
bcNamename of the load to be created
NOTE: The full Unicode character set is not supported for this parameter.

Creates a BC builder for the load descriptor passed.

Returns:
bc builder
Created in NX7.5.0.

License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")
Parameters:
bcDescNamename of the load descriptor
NOTE: The full Unicode character set is not supported for this parameter.
bcNamename of the load to be created
NOTE: The full Unicode character set is not supported for this parameter.
labelload label

Creates a BC builder for the simulation object descriptor passed.

Returns:
bc builder
Created in NX4.0.0.

License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")
Parameters:
bcDescNamename of the simulation object descriptor
NOTE: The full Unicode character set is not supported for this parameter.
bcNamename of the simulation object to be created
NOTE: The full Unicode character set is not supported for this parameter.

Creates a BC builder for the simulation object descriptor passed.

Returns:
bc builder
Created in NX7.5.0.

License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")
Parameters:
bcDescNamename of the simulation object descriptor
NOTE: The full Unicode character set is not supported for this parameter.
bcNamename of the simulation object to be created
NOTE: The full Unicode character set is not supported for this parameter.
labelsimulation object label

Creates a CAE::CaeRegionBuilder.

Returns:
The RegionBuilder object
Created in NX7.0.0.

License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")
Parameters:
pcRegionDescNameThe neutral name of the region descriptor.
NOTE: The full Unicode character set is not supported for this parameter.
tRegionThe region if we are editing it, or NULL if we are creating a new one

Creates a CAE::LaminateMetaSolBuilder.

Returns:
the LaminateMetaSolBuilder object
Deprecated:
Deprecated in NX8.0.0.


Created in NX6.0.0.

License requirements : nx_lam_composites ("Laminate Composites")

Parameters:
tMetaSolThe meta solution

Creates a CAE::LaminateQuickPostReportBuilder.

Returns:

Deprecated:
Deprecated in NX8.0.0.


Created in NX7.5.0.

License requirements : nx_lam_comp_adv ("Laminate Composites Advanced")

Parameters:
tSpecthe quick post summary report

Creates a CAE::SimMotionLoadsBuilder.

Returns:
The SimMotionLoadsBuilder object
Created in NX5.0.1.

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

Creates a CAE::SimMotionLoadsListItemBuilder.

Returns:
The SimMotionLoadsListItemBuilder object
Created in NX5.0.1.

License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")
NXOpen::CAE::SimSolution* NXOpen::CAE::SimSimulation::CreateSolution ( const NXString solverType,
const NXString analysisType,
const NXString solutionType,
const NXString name 
)

Creates a solution.

Returns:
the created CAE::SimSolution
Created in NX4.0.0.

License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")
Parameters:
solverTypename of the solver
NOTE: The full Unicode character set is not supported for this parameter.
analysisTypename of the analysis type
NOTE: The full Unicode character set is not supported for this parameter.
solutionTypename of the solution type
NOTE: The full Unicode character set is not supported for this parameter.
namename of the solution to be created

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:
solutionthe solution to which the step will be added, if a NULL is passed the current active solution will be used
stepTypeindex of the step type
namename of the step

Delete the solution.


Created in NX4.0.0.

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

Parameters:
solutionthe CAE::SimSolution to be deleted

Returns the durability manager belonging to this sim part
Created in NX7.5.0.


Returns the femodeloccurrence CAE::FEModelOccurrence assoicated with the simulation object.


Created in NX5.0.0.

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

Returns the laminate manager belonging to this sim part
Created in NX8.0.0.


Returns the load collection belonging to this sim part
Created in NX3.0.0.


Returns the Design and Analysis optimization manager belonging to this sim part
Created in NX8.0.0.


Returns the response simulation manager belonging to this sim part
Created in NX3.0.0.


Returns the CAE ResultMeasure collection belonging to this sim part
Created in NX8.0.0.


Sets the active solution.


Created in NX4.0.0.

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

Parameters:
activeSolutionthe active solution CAE::SimSolution

Returns the simulation object collection belonging to this sim part
Created in NX3.0.0.


Returns the simulation recipe collection belonging to this sim part
Created in NX3.0.0.


Returns the CAE Solution collection belonging to this sim part
Created in NX7.5.0.


Returns the optimization manager belonging to this sim part
Created in NX8.0.0.



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