NXOpen .NET Reference  12.0.0
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.CAE.IPostScenarioDataSource

Public Member Functions

unsafe
NXOpen.CAE.SimLoadRecipeTypes.LoadConditionHandling 
GetLoadConditionHandlingType ()
 Gets the type of load conditions handling of the NXOpen.CAE.SimLoadRecipe More...
 
unsafe void SetLoadConditionHandlingType (NXOpen.CAE.SimLoadRecipeTypes.LoadConditionHandling lcHandling)
 Sets 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 DisableLoadCondition (string loadCondition)
 Disables a load condition in the Load Recipe. More...
 
unsafe void EnableLoadCondition (string loadCondition)
 Enables a load condition in the Load Recipe. More...
 
unsafe void DisableTrackingValue (string trackingValue)
 Disables a tracking value in the Load Recipe. More...
 
unsafe void EnableTrackingValue (string trackingValue)
 Enables a tracking value in the Load Recipe. More...
 
unsafe
NXOpen.CAE.SimLoadRecipeLbcGenerator 
NewLbcGeneratorFromLoadRecipe ()
 Creates a new NXOpen.CAE.SimLoadRecipeLbcGenerator . 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 bool ExportToCSVFile (string filePath)
 Exports mapping entries to a CSV file. More...
 
unsafe void Autofill ()
 Fills the mapping tables of the load recipe based on available functions in the data sources. More...
 
unsafe void Autofill (NXOpen.CAE.FEModelOccurrence feModelOcc)
 Overload to specify a component of the FEM assembly for which to autofill the mapping tables. More...
 
unsafe void Validation ()
 Validation of the Load Recipe 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 void SetAutofillAssemblyComponent (NXOpen.CAE.FEModelOccurrence feModelOcc)
 Set the assembly component on which the autofill method operates on. More...
 

Properties

NXOpen.CAE.SimLoadRecipeMappingCollection MappingCollection [get]
 Returns the NXOpen.CAE.SimLoadRecipeMappingCollection . More...
 
NXOpen.CAE.SimLoadRecipeSourceCollection SourceCollection [get]
 Contains a NXOpen.CAE.SimLoadRecipeSourceCollection . More...
 
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...
 
unsafe string Name [get, set]
 Returns or sets the name of a NXOpen.CAE.SimLoadRecipe . 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 ( )

Fills the mapping tables of the load recipe based on available functions in the data sources.

Creates and adds NXOpen.CAE.SimLoadRecipeMapEntry instances to the load recipe. Sets the value of NXOpen.CAE.SimLoadRecipeMapEntry.Target for each map entry to the entity label read from the data sources. This method doesn't create entries with NXOpen.CAE.SimLoadRecipeMapEntry.TargetType which refer to groups or meshes.

The parameters available in the data sources are filled for each entry in the following format: "ME:<target label>".

Created in NX10.0.0

License requirements: nx_masterfem ("Finite Element Modeling")

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

Overload to specify a component of the FEM assembly for which to autofill the mapping tables.

Created in NX11.0.0

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

License requirements: nx_masterfem ("Finite Element Modeling")

Parameters
feModelOcc
unsafe void NXOpen.CAE.SimLoadRecipe.DisableLoadCondition ( string  loadCondition)

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)

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)

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)

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)

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 ( )

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 ( )

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 ( )

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 
)

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 ( )

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 ( )

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 ( )

Creates a new NXOpen.CAE.SimLoadRecipeLbcGenerator .

Created in NX10.0.0

License requirements: nx_masterfem ("Finite Element Modeling")

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

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)

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 ( )

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 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


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