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

Handles generation of subcases and loads based on a NXOpen::CAE::SimLoadRecipe . More...

Inheritance diagram for NXOpen::CAE::SimLoadRecipeLbcGenerator:
NXOpen::TransientObject

Public Types

enum  LbcHierarchyTypes { LbcHierarchyTypesAggregated, LbcHierarchyTypesSeparated }
 This enum defines the hierarchy type of LBCs to be created by this NXOpen::CAE::SimLoadRecipeLbcGenerator . More...
 

Public Member Functions

void Generate (NXOpen::CAE::SimSolution *solution)
 Generates Loads at solution level. More...
 
void Generate (NXOpen::CAE::SimSolution *solution, int stepType)
 Generates Loads at the level of solution steps. More...
 
void Generate (NXOpen::CAE::SimSolution *solution, NXOpen::CAE::SimLoadRecipeLbcGenerator::LbcHierarchyTypes lbcHierarchyType)
 Generates Loads at solution level. More...
 
void Generate (NXOpen::CAE::SimSolution *solution, int stepType, NXOpen::CAE::SimLoadRecipeLbcGenerator::LbcHierarchyTypes lbcHierarchyType)
 Generates Loads at the level of solution steps. More...
 
int GetAllowedStepTypeCount (NXOpen::CAE::SimSolution *solution)
 Gets the count of allowable step types when generating steps for a solution from a load recipe. More...
 
virtual ~SimLoadRecipeLbcGenerator ()
 Frees the object from memory. More...
 
- Public Member Functions inherited from NXOpen::TransientObject
void * GetHandle ()
 Handle of the internal object represented by this object. More...
 

Detailed Description

Handles generation of subcases and loads based on a NXOpen::CAE::SimLoadRecipe .

An instance of this class can be obtained from NXOpen::CAE::SimLoadRecipe .
To create a new instance of this class, use NXOpen::CAE::SimLoadRecipe::NewLbcGeneratorFromLoadRecipe

Created in NX10.0.0.

Member Enumeration Documentation

This enum defines the hierarchy type of LBCs to be created by this NXOpen::CAE::SimLoadRecipeLbcGenerator .

Enumerator
LbcHierarchyTypesAggregated 

Aggregated LBCs.

LbcHierarchyTypesSeparated 

Separated LBCs.

Constructor & Destructor Documentation

virtual NXOpen::CAE::SimLoadRecipeLbcGenerator::~SimLoadRecipeLbcGenerator ( )
virtual

Frees the object from memory.

After this method is called, it is illegal to use the object. In .NET, this method is automatically called when the object is deleted by the garbage collector.
Created in NX10.0.0.

License requirements : None

Member Function Documentation

void NXOpen::CAE::SimLoadRecipeLbcGenerator::Generate ( NXOpen::CAE::SimSolution solution)

Generates Loads at solution level.

This method supports creation of loads for a single subcase (load condition or combination of load condition and tracking value). All Loads will be created in the loads container of the solution. No steps will be created or added to the solution.

The solver language of the solution defines what kind of Loads, Constraints and/or Load Sets will be generated for each load type.

Deprecated:
Deprecated in NX11.0.0. Use method taking LBC hierarchy type as input. This method always creates separated LBCs.


Created in NX10.0.0.

License requirements : nx_masterfem ("Finite Element Modeling")

Parameters
solutionsolution
void NXOpen::CAE::SimLoadRecipeLbcGenerator::Generate ( NXOpen::CAE::SimSolution solution,
int  stepType 
)

Generates Loads at the level of solution steps.

This method creates a solution step for every available subcase (load condition or combination of load condition and tracking value) from the load recipe. Loads will be created in the loads container of each created solution step.

The solver language of the solution defines what kind of Loads, Constraints and/or Load Sets will be generated for each load type.

Deprecated:
Deprecated in NX11.0.0. Use method taking LBC hierarchy type as input. This method always creates separated LBCs.


Created in NX10.0.0.

License requirements : nx_masterfem ("Finite Element Modeling")

Parameters
solutionsolution
stepTypesteptype
void NXOpen::CAE::SimLoadRecipeLbcGenerator::Generate ( NXOpen::CAE::SimSolution solution,
NXOpen::CAE::SimLoadRecipeLbcGenerator::LbcHierarchyTypes  lbcHierarchyType 
)

Generates Loads at solution level.

This method supports creation of loads for a single subcase (load condition or combination of load condition and tracking value). All Loads will be created in the loads container of the solution. No steps will be created or added to the solution.

The solver language of the solution defines what kind of Loads, Constraints and/or Load Sets will be generated for each load type.
Created in NX11.0.0.

License requirements : nx_masterfem ("Finite Element Modeling")

Parameters
solutionsolution
lbcHierarchyTypelbchierarchytype
void NXOpen::CAE::SimLoadRecipeLbcGenerator::Generate ( NXOpen::CAE::SimSolution solution,
int  stepType,
NXOpen::CAE::SimLoadRecipeLbcGenerator::LbcHierarchyTypes  lbcHierarchyType 
)

Generates Loads at the level of solution steps.

This method creates a solution step for every available subcase (load condition or combination of load condition and tracking value) from the load recipe. Loads will be created in the loads container of each created solution step.

The solver language of the solution defines what kind of Loads, Constraints and/or Load Sets will be generated for each load type.
Created in NX11.0.0.

License requirements : nx_masterfem ("Finite Element Modeling")

Parameters
solutionsolution
stepTypesteptype
lbcHierarchyTypelbchierarchytype
int NXOpen::CAE::SimLoadRecipeLbcGenerator::GetAllowedStepTypeCount ( NXOpen::CAE::SimSolution solution)

Gets the count of allowable step types when generating steps for a solution from a load recipe.

Note that not every step type supported by a solution can be created from a load recipe. The value returned by this method is not the same as NXOpen::CAE::SimSolution::AllowedStepTypeCount .

Returns
count of allowable step types
Created in NX10.0.0.

License requirements : None
Parameters
solutionsolution

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