NX Open C++ Reference Guide
|
This is the class handling the attributes of a load recipe. More...
Public Member Functions | |
void | Autofill () |
Fills the mapping tables of the load recipe based on available functions in the data sources. More... | |
void | Autofill (NXOpen::CAE::FEModelOccurrence *feModelOcc) |
Overload to specify a component of the FEM assembly for which to autofill the mapping tables. More... | |
NXOpen::CAE::SimLoadRecipeTypes::DataTypes | DataType () |
Returns the data type of a NXOpen::CAE::SimLoadRecipe Created in NX10.0.0. More... | |
NXString | Description () |
Returns the description of a NXOpen::CAE::SimLoadRecipe . More... | |
void | DisableLoadCondition (const NXString &loadCondition) |
Disables a load condition in the Load Recipe. More... | |
void | DisableLoadCondition (const char *loadCondition) |
Disables a load condition in the Load Recipe. More... | |
void | DisableTrackingValue (const NXString &trackingValue) |
Disables a tracking value in the Load Recipe. More... | |
void | DisableTrackingValue (const char *trackingValue) |
Disables a tracking value in the Load Recipe. More... | |
void | EnableLoadCondition (const NXString &loadCondition) |
Enables a load condition in the Load Recipe. More... | |
void | EnableLoadCondition (const char *loadCondition) |
Enables a load condition in the Load Recipe. More... | |
void | EnableTrackingValue (const NXString &trackingValue) |
Enables a tracking value in the Load Recipe. More... | |
void | EnableTrackingValue (const char *trackingValue) |
Enables a tracking value in the Load Recipe. More... | |
bool | ExportToCSVFile (const NXString &filePath) |
Exports mapping entries to a CSV file. More... | |
bool | ExportToCSVFile (const char *filePath) |
Exports mapping entries to a CSV file. More... | |
NXOpen::CAE::SimLoadRecipeTypes::LoadConditionHandling | GetLoadConditionHandlingType () |
Gets the type of load conditions handling of the NXOpen::CAE::SimLoadRecipe. More... | |
std::vector< NXString > | GetLoadConditions () |
Gets the load condition strings declared in the NXOpen::CAE::SimLoadRecipe. More... | |
std::vector< NXString > | GetTrackingValues () |
Gets the tracking value strings declared in the NXOpen::CAE::SimLoadRecipe. More... | |
void | ImportFromCSVFile (const NXString &filePath, const NXString &csvDelim, bool *noParsedContent, bool *invalidLoadType, bool *invalidEntityType, bool *invalidNbrOfParameters) |
Imports mapping entries from a CSV file. More... | |
void | ImportFromCSVFile (const char *filePath, const char *csvDelim, bool *noParsedContent, bool *invalidLoadType, bool *invalidEntityType, bool *invalidNbrOfParameters) |
Imports mapping entries from a CSV file. More... | |
void | LoadLoadConditions () |
Loads all the load conditions available in the data sources and enables them. More... | |
void | LoadTrackingValues () |
Loads all the tracking values available in the data sources and enables them. More... | |
NXOpen::CAE::SimLoadRecipeMappingCollection * | MappingCollection () |
Returns the NXOpen::CAE::SimLoadRecipeMappingCollection . More... | |
NXString | Name () |
Returns the name of a NXOpen::CAE::SimLoadRecipe . More... | |
NXOpen::CAE::SimLoadRecipeLbcGenerator * | NewLbcGeneratorFromLoadRecipe () |
Creates a new NXOpen::CAE::SimLoadRecipeLbcGenerator . More... | |
void | SetAutofillAssemblyComponent (NXOpen::CAE::FEModelOccurrence *feModelOcc) |
Set the assembly component on which the autofill method operates on. More... | |
void | SetDescription (const NXString &description) |
Sets the description of a NXOpen::CAE::SimLoadRecipe . More... | |
void | SetDescription (const char *description) |
Sets the description of a NXOpen::CAE::SimLoadRecipe . More... | |
void | SetLoadConditionHandlingType (NXOpen::CAE::SimLoadRecipeTypes::LoadConditionHandling lcHandling) |
Sets the type of load conditions handling of the NXOpen::CAE::SimLoadRecipe Created in NX10.0.0. More... | |
void | SetName (const NXString &name) |
Sets the name of a NXOpen::CAE::SimLoadRecipe . More... | |
void | SetName (const char *name) |
Sets the name of a NXOpen::CAE::SimLoadRecipe . More... | |
NXOpen::CAE::SimLoadRecipeSourceCollection * | SourceCollection () |
Contains a NXOpen::CAE::SimLoadRecipeSourceCollection . More... | |
void | Validation () |
Validation of the Load Recipe Created in NX10.0.0. More... | |
Public Member Functions inherited from NXOpen::TaggedObject | |
tag_t | Tag () const |
Returns the tag of this object. More... | |
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.
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 and NXOpen::CAE::SimLoadRecipeMapEntry::SetTarget for each map entry to the entity label read from the data sources. This method doesn't create entries with NXOpen::CAE::SimLoadRecipeMapEntry::TargetType and NXOpen::CAE::SimLoadRecipeMapEntry::SetTargetType 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")
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.
License requirements : nx_masterfem ("Finite Element Modeling")
feModelOcc | femodelocc |
NXOpen::CAE::SimLoadRecipeTypes::DataTypes NXOpen::CAE::SimLoadRecipe::DataType | ( | ) |
Returns the data type of a NXOpen::CAE::SimLoadRecipe
Created in NX10.0.0.
License requirements : None
NXString NXOpen::CAE::SimLoadRecipe::Description | ( | ) |
Returns the description of a NXOpen::CAE::SimLoadRecipe .
Created in NX10.0.0.
License requirements : None
void NXOpen::CAE::SimLoadRecipe::DisableLoadCondition | ( | const NXString & | 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")
loadCondition | loadcondition |
void NXOpen::CAE::SimLoadRecipe::DisableLoadCondition | ( | const char * | 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")
loadCondition | loadcondition |
void NXOpen::CAE::SimLoadRecipe::DisableTrackingValue | ( | const NXString & | 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")
trackingValue | trackingvalue |
void NXOpen::CAE::SimLoadRecipe::DisableTrackingValue | ( | const char * | 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")
trackingValue | trackingvalue |
void NXOpen::CAE::SimLoadRecipe::EnableLoadCondition | ( | const NXString & | 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")
loadCondition | loadcondition |
void NXOpen::CAE::SimLoadRecipe::EnableLoadCondition | ( | const char * | 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")
loadCondition | loadcondition |
void NXOpen::CAE::SimLoadRecipe::EnableTrackingValue | ( | const NXString & | 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")
trackingValue | trackingvalue |
void NXOpen::CAE::SimLoadRecipe::EnableTrackingValue | ( | const char * | 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")
trackingValue | trackingvalue |
bool NXOpen::CAE::SimLoadRecipe::ExportToCSVFile | ( | const NXString & | filePath | ) |
Exports mapping entries to a CSV file.
filePath | Path of the CSV file |
bool NXOpen::CAE::SimLoadRecipe::ExportToCSVFile | ( | const char * | filePath | ) |
Exports mapping entries to a CSV file.
filePath | Path of the CSV file |
NXOpen::CAE::SimLoadRecipeTypes::LoadConditionHandling NXOpen::CAE::SimLoadRecipe::GetLoadConditionHandlingType | ( | ) |
Gets the type of load conditions handling of the NXOpen::CAE::SimLoadRecipe.
std::vector<NXString> NXOpen::CAE::SimLoadRecipe::GetLoadConditions | ( | ) |
Gets the load condition strings declared in the NXOpen::CAE::SimLoadRecipe.
std::vector<NXString> NXOpen::CAE::SimLoadRecipe::GetTrackingValues | ( | ) |
Gets the tracking value strings declared in the NXOpen::CAE::SimLoadRecipe.
void NXOpen::CAE::SimLoadRecipe::ImportFromCSVFile | ( | const NXString & | filePath, |
const NXString & | csvDelim, | ||
bool * | noParsedContent, | ||
bool * | invalidLoadType, | ||
bool * | invalidEntityType, | ||
bool * | invalidNbrOfParameters | ||
) |
Imports mapping entries from a CSV file.
Created in NX10.0.0.
License requirements : nx_masterfem ("Finite Element Modeling")
filePath | Path of the CSV file |
csvDelim | Delimiter character used in the CSV file. If NULL, the comma character will be used. If this string contains more then one character, only the first one will be used. |
noParsedContent | True if no valid data could be parsed from the file. |
invalidLoadType | True if an invalid load type was found. All data for this load type will be ignored. |
invalidEntityType | True if an invalid entity type was found. The entities with invalid entity type will be ignored. |
invalidNbrOfParameters | True 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. |
void NXOpen::CAE::SimLoadRecipe::ImportFromCSVFile | ( | const char * | filePath, |
const char * | csvDelim, | ||
bool * | noParsedContent, | ||
bool * | invalidLoadType, | ||
bool * | invalidEntityType, | ||
bool * | invalidNbrOfParameters | ||
) |
Imports mapping entries from a CSV file.
Created in NX10.0.0.
License requirements : nx_masterfem ("Finite Element Modeling")
filePath | Path of the CSV file |
csvDelim | Delimiter character used in the CSV file. If NULL, the comma character will be used. If this string contains more then one character, only the first one will be used. |
noParsedContent | True if no valid data could be parsed from the file. |
invalidLoadType | True if an invalid load type was found. All data for this load type will be ignored. |
invalidEntityType | True if an invalid entity type was found. The entities with invalid entity type will be ignored. |
invalidNbrOfParameters | True 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. |
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")
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")
NXOpen::CAE::SimLoadRecipeMappingCollection* NXOpen::CAE::SimLoadRecipe::MappingCollection | ( | ) |
Returns the NXOpen::CAE::SimLoadRecipeMappingCollection .
Created in NX10.0.0.
NXString NXOpen::CAE::SimLoadRecipe::Name | ( | ) |
Returns the name of a NXOpen::CAE::SimLoadRecipe .
Created in NX10.0.0.
License requirements : None
NXOpen::CAE::SimLoadRecipeLbcGenerator* NXOpen::CAE::SimLoadRecipe::NewLbcGeneratorFromLoadRecipe | ( | ) |
Creates a new NXOpen::CAE::SimLoadRecipeLbcGenerator .
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")
feModelOcc | femodelocc |
void NXOpen::CAE::SimLoadRecipe::SetDescription | ( | const NXString & | description | ) |
Sets the description of a NXOpen::CAE::SimLoadRecipe .
Created in NX10.0.0.
License requirements : nx_masterfem ("Finite Element Modeling")
description | description |
void NXOpen::CAE::SimLoadRecipe::SetDescription | ( | const char * | description | ) |
Sets the description of a NXOpen::CAE::SimLoadRecipe .
Created in NX10.0.0.
License requirements : nx_masterfem ("Finite Element Modeling")
description | description |
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")
lcHandling | lchandling |
void NXOpen::CAE::SimLoadRecipe::SetName | ( | const NXString & | name | ) |
Sets the name of a NXOpen::CAE::SimLoadRecipe .
Created in NX10.0.0.
License requirements : nx_masterfem ("Finite Element Modeling")
name | name |
void NXOpen::CAE::SimLoadRecipe::SetName | ( | const char * | name | ) |
Sets the name of a NXOpen::CAE::SimLoadRecipe .
Created in NX10.0.0.
License requirements : nx_masterfem ("Finite Element Modeling")
name | name |
NXOpen::CAE::SimLoadRecipeSourceCollection* NXOpen::CAE::SimLoadRecipe::SourceCollection | ( | ) |
Contains a NXOpen::CAE::SimLoadRecipeSourceCollection .
Created in NX10.0.0.
void NXOpen::CAE::SimLoadRecipe::Validation | ( | ) |
Validation of the Load Recipe
Created in NX10.0.0.
License requirements : nx_masterfem ("Finite Element Modeling")