NXOpen .NET Reference Guide  1899
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties
Public Member Functions | Properties | List of all members
NXOpen.CAE.SimLoadRecipe Class Reference

This is the class handling the attributes of a load recipe. More...

Inheritance diagram for NXOpen.CAE.SimLoadRecipe:
NXOpen.TaggedObject NXOpen.CAE.IPostScenarioDataSource NXOpen.Utilities.NXRemotableObject IMessageSink

Public Member Functions

unsafe void Autofill ()
 Fills the mapping tables of the Load Recipe based on available data in the data sources. More...
 
unsafe void Autofill (NXOpen.CAE.FEModelOccurrence feModelOcc)
 Overload that also sets the Assembly Component to be used by Autofill. More...
 
unsafe void AutofillSelectionRecipeBased ()
 Fills the mapping tables of the Load Recipe based on Selection Recipes in the model and available data in the data sources. More...
 
unsafe void DisableLoadCondition (string loadCondition)
 Disables a load condition in the Load Recipe. More...
 
unsafe void DisableTrackingValue (string trackingValue)
 Disables a tracking value in the Load Recipe. More...
 
unsafe void EnableLoadCondition (string loadCondition)
 Enables a load condition in the Load Recipe. More...
 
unsafe void EnableTrackingValue (string trackingValue)
 Enables a tracking value in the Load Recipe. More...
 
unsafe bool ExportToCSVFile (string filePath)
 Exports mapping entries to a CSV file. More...
 
unsafe
NXOpen.CAE.SimLoadRecipeTypes.LoadConditionHandling 
GetLoadConditionHandlingType ()
 Gets the type of load conditions handling of the NXOpen.CAE.SimLoadRecipe More...
 
unsafe string[] GetLoadConditions ()
 Gets the load condition strings declared in the NXOpen.CAE.SimLoadRecipe More...
 
unsafe string[] GetTrackingValues ()
 Gets the tracking value strings declared in the NXOpen.CAE.SimLoadRecipe More...
 
unsafe void ImportFromCSVFile (string filePath, string csvDelim, out bool noParsedContent, out bool invalidLoadType, out bool invalidEntityType, out bool invalidNbrOfParameters)
 Imports mapping entries from a CSV file. More...
 
unsafe void LoadLoadConditions ()
 Loads all the load conditions available in the data sources and enables them. More...
 
unsafe void LoadTrackingValues ()
 Loads all the tracking values available in the data sources and enables them. More...
 
unsafe
NXOpen.CAE.SimLoadRecipeLbcGenerator 
NewLbcGeneratorFromLoadRecipe ()
 Creates a new NXOpen.CAE.SimLoadRecipeLbcGenerator . More...
 
unsafe
NXOpen.CAE.SimLoadRecipeValidation 
NewValidationFromLoadRecipe ()
 Creates a new NXOpen.CAE.SimLoadRecipeValidation . More...
 
unsafe void SetAutofillAssemblyComponent (NXOpen.CAE.FEModelOccurrence feModelOcc)
 Set the assembly component on which the autofill method operates on. More...
 
unsafe void SetLoadConditionHandlingType (NXOpen.CAE.SimLoadRecipeTypes.LoadConditionHandling lcHandling)
 Sets the type of load conditions handling of the NXOpen.CAE.SimLoadRecipe More...
 
unsafe void Validation ()
 Validation of the Load Recipe More...
 
- Public Member Functions inherited from NXOpen.TaggedObject
void PrintTestData (String variableName)
 <exclude> More...
 
void PrintTestData (String variableName, int lineNumber)
 <exclude> More...
 
override string ToString ()
 Returns a String that represents the current Object. More...
 
- Public Member Functions inherited from NXOpen.Utilities.NXRemotableObject
IMessageCtrl AsyncProcessMessage (IMessage msg, IMessageSink replySink)
 Asynchronously processes the given message. More...
 
IMessage SyncProcessMessage (IMessage msg)
 Synchronously processes the given message. More...
 

Properties

unsafe
NXOpen.CAE.SimLoadRecipeTypes.DataTypes 
DataType [get]
 Returns the data type of a NXOpen.CAE.SimLoadRecipe More...
 
unsafe string Description [get, set]
 Returns or sets the description of a NXOpen.CAE.SimLoadRecipe . More...
 
NXOpen.CAE.SimLoadRecipeMappingCollection MappingCollection [get]
 Returns the NXOpen.CAE.SimLoadRecipeMappingCollection . More...
 
unsafe
NXOpen.CAE.SimLoadRecipeTypes.MappingTypes 
MappingType [get, set]
 Returns or sets the mapping type of a NXOpen.CAE.SimLoadRecipe More...
 
unsafe string Name [get, set]
 Returns or sets the name of a NXOpen.CAE.SimLoadRecipe . More...
 
NXOpen.CAE.SimLoadRecipeSourceCollection SourceCollection [get]
 Contains a NXOpen.CAE.SimLoadRecipeSourceCollection . More...
 
unsafe
NXOpen.Fields.FieldEvaluator.ValuesOutsideTableInterpolationEnum 
ValuesOutsideTableOption [get, set]
 Returns or sets the extrapolation option used for values outside the table for table fields created based on the NXOpen.CAE.SimLoadRecipe . More...
 
- Properties inherited from NXOpen.TaggedObject
Tag Tag [get]
 Returns the tag of this object. More...
 
- Properties inherited from NXOpen.Utilities.NXRemotableObject
IMessageSink NextSink [get]
 Gets the next message sink in the sink chain. More...
 

Additional Inherited Members

- Protected Member Functions inherited from NXOpen.TaggedObject
new void initialize ()
 <exclude> More...
 

Detailed Description

This is the class handling the attributes of a load recipe.

To create a new instance of this class, use NXOpen.CAE.SimLoadRecipeCollection.Create

Created in NX10.0.0

Member Function Documentation

unsafe void NXOpen.CAE.SimLoadRecipe.Autofill ( )
inline

Fills the mapping tables of the Load Recipe based on available data in the data sources.

The behavior depends on the Load Recipe settings and the nature of the available data in the data sources.

  1. If the NXOpen.CAE.SimLoadRecipe.MappingType is NXOpen.CAE.SimLoadRecipeTypes.MappingTypes.FileBased it will generate a single entry that targets the top level FE Model for each available Load Type and maps each parameter with AE (Auto-Entity) mapping. Note that all parameters are mapped, even if the data sources don't provide data for a certain parameter.
  2. For data that maps to free coordinates instead of FE entity types or if SORT1 data on FE entities is available for a specific Load Type, a single entry that targets the FE Model set using NXOpen.CAE.SimLoadRecipe.SetAutofillAssemblyComponent will be created with all available parameters set to AE (Auto-Entity) mapping. If an assembly component other than the top level FE Model is set using NXOpen.CAE.SimLoadRecipe.SetAutofillAssemblyComponent , the mapping will use the mapped entity labels in the context of that particular FE Model.
  3. If SORT2 data is available, entries will be created for all targets (nodes, element faces, etc.) read from the data sources and ME (Manual-Entity) mapping will be used for all available parameters in the following format: "ME:&lt;target label&gt;". If an assembly component other than the top level FE Model is set using NXOpen.CAE.SimLoadRecipe.SetAutofillAssemblyComponent , the mapping will use the mapped entity labels in the context of that particular FE Model.

Created in NX10.0.0

License requirements: nx_masterfem ("Finite Element Modeling")

unsafe void NXOpen.CAE.SimLoadRecipe.Autofill ( NXOpen.CAE.FEModelOccurrence  feModelOcc)
inline

Overload that also sets the Assembly Component to be used by Autofill.

Created in NX11.0.0

Deprecated in NX12.0.0. Use NXOpen.CAE.SimLoadRecipe.SetAutofillAssemblyComponent and NXOpen.CAE.SimLoadRecipe.Autofill instead.

License requirements: nx_masterfem ("Finite Element Modeling")

Parameters
feModelOcc
unsafe void NXOpen.CAE.SimLoadRecipe.AutofillSelectionRecipeBased ( )
inline

Fills the mapping tables of the Load Recipe based on Selection Recipes in the model and available data in the data sources.

For each mapping table, individual mapping entries will be created for all Selection Recipes which map to available SORT2 data by function name. Available parameters will be mapped using AF (Auto-Function) mapping.

Created in NX1847.0.0

License requirements: nx_masterfem ("Finite Element Modeling")

unsafe void NXOpen.CAE.SimLoadRecipe.DisableLoadCondition ( string  loadCondition)
inline

Disables a load condition in the Load Recipe.

Disabled load conditions will not be used when creating a solution from load recipe.

Created in NX10.0.0

License requirements: nx_masterfem ("Finite Element Modeling")

Parameters
loadCondition
unsafe void NXOpen.CAE.SimLoadRecipe.DisableTrackingValue ( string  trackingValue)
inline

Disables a tracking value in the Load Recipe.

Disabled tracking values will not be used when creating a solution from load recipe.

Created in NX10.0.0

License requirements: nx_masterfem ("Finite Element Modeling")

Parameters
trackingValue
unsafe void NXOpen.CAE.SimLoadRecipe.EnableLoadCondition ( string  loadCondition)
inline

Enables a load condition in the Load Recipe.

Only enabled load conditions will be used when creating a solution from load recipe.

Created in NX10.0.0

License requirements: nx_masterfem ("Finite Element Modeling")

Parameters
loadCondition
unsafe void NXOpen.CAE.SimLoadRecipe.EnableTrackingValue ( string  trackingValue)
inline

Enables a tracking value in the Load Recipe.

Only enabled tracking values will be used when creating a solution from load recipe.

Created in NX10.0.0

License requirements: nx_masterfem ("Finite Element Modeling")

Parameters
trackingValue
unsafe bool NXOpen.CAE.SimLoadRecipe.ExportToCSVFile ( string  filePath)
inline

Exports mapping entries to a CSV file.

Created in NX10.0.0

License requirements: nx_masterfem ("Finite Element Modeling")

Parameters
filePathPath of the CSV file
Returns
True if the mapping table entries contain the CSV delimiter character. If this is true, it will cause inconsistencies when importing the file.
unsafe NXOpen.CAE.SimLoadRecipeTypes.LoadConditionHandling NXOpen.CAE.SimLoadRecipe.GetLoadConditionHandlingType ( )
inline

Gets the type of load conditions handling of the NXOpen.CAE.SimLoadRecipe

Created in NX10.0.0

License requirements: None.

Returns
unsafe string [] NXOpen.CAE.SimLoadRecipe.GetLoadConditions ( )
inline

Gets the load condition strings declared in the NXOpen.CAE.SimLoadRecipe

Created in NX11.0.0

License requirements: None.

Returns
unsafe string [] NXOpen.CAE.SimLoadRecipe.GetTrackingValues ( )
inline

Gets the tracking value strings declared in the NXOpen.CAE.SimLoadRecipe

Created in NX11.0.0

License requirements: None.

Returns
unsafe void NXOpen.CAE.SimLoadRecipe.ImportFromCSVFile ( string  filePath,
string  csvDelim,
out bool  noParsedContent,
out bool  invalidLoadType,
out bool  invalidEntityType,
out bool  invalidNbrOfParameters 
)
inline

Imports mapping entries from a CSV file.

Created in NX10.0.0

License requirements: nx_masterfem ("Finite Element Modeling")

Parameters
filePathPath of the CSV file
csvDelimDelimiter character used in the CSV file. If a null reference (Nothing in Visual Basic), the comma character will be used. If this string contains more then one character, only the first one will be used.
noParsedContentTrue if no valid data could be parsed from the file.
invalidLoadTypeTrue if an invalid load type was found. All data for this load type will be ignored.
invalidEntityTypeTrue if an invalid entity type was found. The entities with invalid entity type will be ignored.
invalidNbrOfParametersTrue if an invalid number of parameters was found for an entry. If the number of parameters is less then expected, it will populate the first values for which it has values. If the number of parameters is more then expected, the last values will be ignored.
unsafe void NXOpen.CAE.SimLoadRecipe.LoadLoadConditions ( )
inline

Loads all the load conditions available in the data sources and enables them.

Created in NX10.0.0

License requirements: nx_masterfem ("Finite Element Modeling")

unsafe void NXOpen.CAE.SimLoadRecipe.LoadTrackingValues ( )
inline

Loads all the tracking values available in the data sources and enables them.

Created in NX10.0.0

License requirements: nx_masterfem ("Finite Element Modeling")

unsafe NXOpen.CAE.SimLoadRecipeLbcGenerator NXOpen.CAE.SimLoadRecipe.NewLbcGeneratorFromLoadRecipe ( )
inline

Creates a new NXOpen.CAE.SimLoadRecipeLbcGenerator .

Created in NX10.0.0

License requirements: nx_masterfem ("Finite Element Modeling")

Returns
unsafe NXOpen.CAE.SimLoadRecipeValidation NXOpen.CAE.SimLoadRecipe.NewValidationFromLoadRecipe ( )
inline

Creates a new NXOpen.CAE.SimLoadRecipeValidation .

The method also validates the Load Recipe.

Created in NX1872.0.0

License requirements: nx_masterfem ("Finite Element Modeling")

Returns
unsafe void NXOpen.CAE.SimLoadRecipe.SetAutofillAssemblyComponent ( NXOpen.CAE.FEModelOccurrence  feModelOcc)
inline

Set the assembly component on which the autofill method operates on.

Created in NX12.0.0

License requirements: nx_masterfem ("Finite Element Modeling")

Parameters
feModelOcc
unsafe void NXOpen.CAE.SimLoadRecipe.SetLoadConditionHandlingType ( NXOpen.CAE.SimLoadRecipeTypes.LoadConditionHandling  lcHandling)
inline

Sets the type of load conditions handling of the NXOpen.CAE.SimLoadRecipe

Created in NX10.0.0

License requirements: nx_masterfem ("Finite Element Modeling")

Parameters
lcHandling
unsafe void NXOpen.CAE.SimLoadRecipe.Validation ( )
inline

Validation of the Load Recipe

Created in NX10.0.0

License requirements: nx_masterfem ("Finite Element Modeling")

Property Documentation

unsafe NXOpen.CAE.SimLoadRecipeTypes.DataTypes NXOpen.CAE.SimLoadRecipe.DataType
get

Returns the data type of a NXOpen.CAE.SimLoadRecipe

Created in NX10.0.0

License requirements: None.

unsafe string NXOpen.CAE.SimLoadRecipe.Description
getset

Returns or sets the description of a NXOpen.CAE.SimLoadRecipe .

Created in NX10.0.0

License requirements to get this property: None.

License requirements to set this property: nx_masterfem ("Finite Element Modeling")

NXOpen.CAE.SimLoadRecipeMappingCollection NXOpen.CAE.SimLoadRecipe.MappingCollection
get

Returns the NXOpen.CAE.SimLoadRecipeMappingCollection .

Created in NX10.0.0

unsafe NXOpen.CAE.SimLoadRecipeTypes.MappingTypes NXOpen.CAE.SimLoadRecipe.MappingType
getset

Returns or sets the mapping type of a NXOpen.CAE.SimLoadRecipe

Created in NX1847.0.0

License requirements to get this property: None.

License requirements to set this property: nx_masterfem ("Finite Element Modeling")

unsafe string NXOpen.CAE.SimLoadRecipe.Name
getset

Returns or sets the name of a NXOpen.CAE.SimLoadRecipe .

Created in NX10.0.0

License requirements to get this property: None.

License requirements to set this property: nx_masterfem ("Finite Element Modeling")

NXOpen.CAE.SimLoadRecipeSourceCollection NXOpen.CAE.SimLoadRecipe.SourceCollection
get

Contains a NXOpen.CAE.SimLoadRecipeSourceCollection .

Created in NX10.0.0

unsafe NXOpen.Fields.FieldEvaluator.ValuesOutsideTableInterpolationEnum NXOpen.CAE.SimLoadRecipe.ValuesOutsideTableOption
getset

Returns or sets the extrapolation option used for values outside the table for table fields created based on the NXOpen.CAE.SimLoadRecipe .

The valid values are: JA_FIELDS_FIELD_EVAL_ValuesOutsideTableInterpolationEnum_extrapolate, JA_FIELDS_FIELD_EVAL_ValuesOutsideTableInterpolationEnum_constant and JA_FIELDS_FIELD_EVAL_ValuesOutsideTableInterpolationEnum_userdefined.

Created in NX1872.0.0

License requirements to get this property: None.

License requirements to set this property: nx_masterfem ("Finite Element Modeling")


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