PreTestSolution Class¶
-
class
NXOpen.CAE.
PreTestSolution
¶ Bases:
NXOpen.NXObject
Represents a pre-test setup
To create or edit an instance of this class, use
NXOpen.CAE.PreTestSolutionBuilder
New in version NX7.5.0.
Properties¶
Property | Description |
---|---|
IsOccurrence | Returns whether this object is an occurrence or not. |
JournalIdentifier | Returns the identifier that would be recorded in a journal for this object. |
Name | Returns or sets the pre-test name |
OwningComponent | Returns the owning component, if this object is an occurrence. |
OwningPart | Returns the owning part of this object |
Prototype | Returns the prototype of this object if it is an occurrence. |
Tag | Returns the Tag for this object. |
Methods¶
Method | Description |
---|---|
CreateExportUnvBuilder | Creates a pre-test export Unv builder @return export UNV Builder |
DeleteAllAttributesByType | Deletes all attributes of a specific type. |
DeleteAttributeByTypeAndTitle | Deletes an attribute by type and title. |
DeleteUserAttribute | Deletes the first attribute encountered with the given Type, Title. |
DeleteUserAttributes | Deletes the attributes encountered with the given Type with option to update or not. |
ExportShapeMetricsCsvFile | Export shape metrics to CSV file |
FindObject | Finds the NXOpen.NXObject with the given identifier as recorded in a journal. |
GetAttributeTitlesByType | Gets all the attribute titles of a specific type. |
GetBooleanUserAttribute | Gets a boolean attribute by Title and array Index. |
GetComputationalTimeUserAttribute | Gets a time attribute by Title and array Index. |
GetIntegerAttribute | Gets an integer attribute by title. |
GetIntegerUserAttribute | Gets an integer attribute by Title and array Index. |
GetRealAttribute | Gets a real attribute by title. |
GetRealUserAttribute | Gets a real attribute by Title and array Index. |
GetReferenceAttribute | Gets the reference string (not the calculated value) of a string attribute that uses a reference string. |
GetStringAttribute | Gets a string attribute value by title. |
GetStringUserAttribute | Gets a string attribute by Title and array Index. |
GetTimeAttribute | Gets a time attribute by title. |
GetTimeUserAttribute | Gets a time attribute by Title and array Index. |
GetUserAttribute | Gets the first attribute encountered on the object, if any, with a given Title, Type and array Index. |
GetUserAttributeAsString | Gets the first attribute encountered on the object, if any, with a given title, type and array index. |
GetUserAttributeCount | Gets the count of set attributes on the object, if any, of the given type. |
GetUserAttributeLock | Determine the lock of the given attribute. |
GetUserAttributeSize | Gets the size of the first attribute encountered on the object, if any, with a given Title and Type. |
GetUserAttributeSourceObjects | Returns an array of objects from which this object presents attributes. |
GetUserAttributes | Gets all the attributes that have been set on the given object. |
GetUserAttributesAsStrings | Gets all the attributes that have been set on the given object. |
HasUserAttribute | Determines if an attribute with the given Title, Type and array Index is present on the object Unset attributes will not be detected by this function, as its purpose is to test for the actual presence of the attribute on the object. |
Prints a representation of this object to the system log file. | |
SetActiveWorkMode | Sets a specific work mode as active or not |
SetAttribute | Creates or modifies an integer attribute. |
SetBooleanUserAttribute | Creates or modifies a boolean attribute with the option to update or not. |
SetReferenceAttribute | Creates or modifies a string attribute which uses a reference string. |
SetTimeAttribute | Creates or modifies a time attribute. |
SetTimeUserAttribute | Creates or modifies a time attribute with the option to update or not. |
SetUserAttribute | Creates or modifies an attribute with the option to update or not. |
SetUserAttributeLock | Lock or unlock the given attribute. |
SetWorkModeWeight | Sets weight for a specific work mode |
SolveExciterConfig | Solve exciter configuration |
SolveSensorConfig | Solve sensor configuration |
UpdateResultsForSolution | Update results for pre-test solution |
Property Detail¶
IsOccurrence¶
-
PreTestSolution.
IsOccurrence
¶ Returns whether this object is an occurrence or not.
-------------------------------------
Getter Method
Signature
IsOccurrence()
Returns: This object is an occurrence Return type: bool New in version NX3.0.0.
License requirements: None.
JournalIdentifier¶
-
PreTestSolution.
JournalIdentifier
¶ Returns the identifier that would be recorded in a journal for this object.
This may not be the same across different releases of the software.
-------------------------------------
Getter Method
Signature
JournalIdentifier()
Returns: Return type: str New in version NX3.0.0.
License requirements: None.
Name¶
-
PreTestSolution.
Name
¶ Returns or sets the pre-test name
-------------------------------------
Getter Method
Signature
Name()
Returns: Return type: str New in version NX7.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
Name(name)
Parameters: name (str) – New in version NX7.5.0.
License requirements: nx_correl_base (“FE Correlation”)
OwningComponent¶
-
PreTestSolution.
OwningComponent
¶ Returns the owning component, if this object is an occurrence.
-------------------------------------
Getter Method
Signature
OwningComponent()
Returns: Return type: NXOpen.Assemblies.Component
New in version NX3.0.0.
License requirements: None.
OwningPart¶
-
PreTestSolution.
OwningPart
¶ Returns the owning part of this object
-------------------------------------
Getter Method
Signature
OwningPart()
Returns: The owning part of this object or null if it does not have an owner Return type: NXOpen.BasePart
New in version NX3.0.0.
License requirements: None.
Prototype¶
-
PreTestSolution.
Prototype
¶ Returns the prototype of this object if it is an occurrence.
-------------------------------------
Getter Method
Signature
Prototype()
Returns: The prototype of this object or null if this object is not an occurrence Return type: NXOpen.INXObject
New in version NX3.0.0.
License requirements: None.
Method Detail¶
CreateExportUnvBuilder¶
-
PreTestSolution.
CreateExportUnvBuilder
¶ Creates a pre-test export Unv builder
Signature
CreateExportUnvBuilder()
Returns: export UNV Builder Return type: NXOpen.CAE.PreTestExportUnvBuilder
New in version NX7.5.2.
License requirements: nx_correl_base (“FE Correlation”)
ExportShapeMetricsCsvFile¶
-
PreTestSolution.
ExportShapeMetricsCsvFile
¶ Export shape metrics to CSV file
Signature
ExportShapeMetricsCsvFile(metricCode, filename)
Parameters: - metricCode (
NXOpen.CAE.CorrelShapemetrictype
) – shape metric code - filename (str) – CSV file name. NOTE: The full Unicode character set is not supported for this parameter.
New in version NX7.5.0.
License requirements: nx_correl_base (“FE Correlation”)
- metricCode (
FindObject¶
-
PreTestSolution.
FindObject
¶ Finds the
NXOpen.NXObject
with the given identifier as recorded in a journal.An object may not return the same value as its JournalIdentifier in different versions of the software. However newer versions of the software should find the same object when FindObject is passed older versions of its journal identifier. In general, this method should not be used in handwritten code and exists to support record and playback of journals.
An exception will be thrown if no object can be found with the given journal identifier.
Signature
FindObject(journalIdentifier)
Parameters: journalIdentifier (str) – Journal identifier of the object Returns: Return type: NXOpen.INXObject
New in version NX3.0.0.
License requirements: None.
Print¶
-
PreTestSolution.
Print
¶ Prints a representation of this object to the system log file.
Signature
Print()
New in version NX3.0.0.
License requirements: None.
SetActiveWorkMode¶
-
PreTestSolution.
SetActiveWorkMode
¶ Sets a specific work mode as active or not
Signature
SetActiveWorkMode(workModeNumber, active)
Parameters: - workModeNumber (int) – work mode to activate or deactivate
- active (bool) – activate or deactivate flag
New in version NX7.5.0.
License requirements: nx_correl_base (“FE Correlation”)
SetWorkModeWeight¶
-
PreTestSolution.
SetWorkModeWeight
¶ Sets weight for a specific work mode
Signature
SetWorkModeWeight(workModeNumber, weight)
Parameters: - workModeNumber (int) – work mode number to set the weight
- weight (float) – weight to set the work mode
New in version NX7.5.0.
License requirements: nx_correl_base (“FE Correlation”)
SolveExciterConfig¶
-
PreTestSolution.
SolveExciterConfig
¶ Solve exciter configuration
Signature
SolveExciterConfig(tExciterConfig)
Parameters: tExciterConfig ( NXOpen.CAE.PreTestExciterConfig
) – exciter configNew in version NX8.0.0.
License requirements: nx_correl_base (“FE Correlation”)
SolveSensorConfig¶
-
PreTestSolution.
SolveSensorConfig
¶ Solve sensor configuration
Signature
SolveSensorConfig(tSensorConfig)
Parameters: tSensorConfig ( NXOpen.CAE.PreTestSensorConfig
) – sensor configNew in version NX7.5.0.
License requirements: nx_correl_base (“FE Correlation”)
UpdateResultsForSolution¶
-
PreTestSolution.
UpdateResultsForSolution
¶ Update results for pre-test solution
Signature
UpdateResultsForSolution(tSolution, ignoreReload)
Parameters: - tSolution (
NXOpen.CAE.SimSolution
) – solution - ignoreReload (bool) – ignore reload
New in version NX7.5.0.
License requirements: nx_correl_base (“FE Correlation”)
- tSolution (