MappedResult Class¶
-
class
NXOpen.CAE.MappedResult¶ Bases:
NXOpen.CAE.ResultRepresents analysis results for a imported solver results file.
Use
NXOpen.CAE.ResultManagerto create anNXOpen.CAE.MappedResultAn instance of this class can not be obtained
New in version NX9.0.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 the custom name of the object. |
| 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 |
|---|---|
| AskElementIndex | Ask element index of a given element user label |
| AskElementLabel | Ask element user label of a given element index |
| AskElementNodes | Asks for the nodes given an element |
| AskElementShape | Ask element shape given an element index |
| AskIterations | Number of iterations available for a given loadcase and their descriptions Iteration index varies from 0 to N-1 (number of iterations) |
| AskLoadcases | Number of loadcases available in the result file and their descriptions. |
| AskNodeCoordinates | Asks for the coordinates of a node array |
| AskNodeIndex | Ask node index of a given node user label |
| AskNodeIndicesOnElementEdge | Returns number of nodes and node Indices on given element index and edge index. |
| AskNodeIndicesOnElementFace | Returns number of nodes and node Indices on given element index and face index. |
| AskNodeLabel | Ask node user label of a given node index |
| AskNumEdgesOnElement | Returns number of edges on given element index |
| AskNumElements | Ask number of elements in the model Element index varies from 0 to N-1 (number of elements) |
| AskNumElementsOfGroup | Returns an array of elements indices for a given group Group index range from 0 to N-1 (number of groups) |
| AskNumFacesOnElement | Returns number of faces on given element index |
| AskNumGroupsInContainer | Returns the number of groups available in the model of type NXOpen.CAE.ResultGroupContainer |
| AskNumIterations | Number of iterations available for a given loadcase. |
| AskNumLoadcases | Number of loadcases available in the result file |
| AskNumNodes | Ask number of nodes in the model Node index varies from 1 to N (number of nodes) |
| AskNumberOfSectors | Returns number of sectors for cyclic symmetric solution |
| AskResultDataType | Ask result datatype |
| AskResultLoadcaseValue | Ask load case description, value type and value for the input load case |
| AskResultSections | Ask element ids and corresponding number of sections at which result is defined |
| AskResultTypes | Returns an array of result types and descriptions available for a given loadcase and iteration |
| AskSectionDescription | Ask Section description provided section type |
| CreateAttributeIterator | Create an attribute iterator |
| 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 on the object, if any, that satisfy the given iterator |
| Find | Returns a NXOpen.CAE.BaseLoadcase |
| 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. |
| GetFilename | Gets the mapped result filename used to create this object. |
| GetFiletype | Gets the mapped result filetype (NXOpen.CAE.ResultFiletype |
| GetIntegerAttribute | Gets an integer attribute by title. |
| GetIntegerUserAttribute | Gets an integer attribute by Title and array Index. |
| GetLoadcases | Ask the loadcases present in this result |
| GetMeshes | Returns number of meshgoups and array of their objects in the loaded result. |
| GetMeshesOfGivenDimension | Returns number of meshgoups and array of their objects of the given dimension in the loaded result. |
| GetNextUserAttribute | Gets the next attribute encountered on the object, if any, that satisfies the given iterator. |
| GetPdmReferenceAttributeValue | Gets the value of PDM Reference attribute for given object. |
| 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. |
| GetResultCoordinateSystemDefinition | Returns definitions of a result coordinate system |
| GetResultCoordinateSystems | Returns coordinate system IDs defined in the result |
| 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, that satisfy the given iterator. |
| 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, if any, that satisfy the given iterator. |
| GetUserAttributesAsStrings | Gets all the attributes that have been set on the given object. |
| HasUserAttribute | Determines if an attribute exists on the object, that satisfies the given iterator |
| IsResultTypeComplex | Ask whether a result type is complex or not |
| Prints a representation of this object to the system log file. | |
| SetAttribute | Creates or modifies an integer attribute. |
| SetBooleanUserAttribute | Creates or modifies a boolean attribute with the option to update or not. |
| SetName | Sets the custom name of the object. |
| SetPdmReferenceAttribute | Sets the value of PDM Reference attribute on the object. |
| 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. |
Property Detail¶
IsOccurrence¶
-
MappedResult.IsOccurrence¶ Returns whether this object is an occurrence or not.
-------------------------------------Getter Method
Signature
IsOccurrenceReturns: This object is an occurrence Return type: bool New in version NX3.0.0.
License requirements: None.
JournalIdentifier¶
-
MappedResult.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
JournalIdentifierReturns: Return type: str New in version NX3.0.0.
License requirements: None.
Name¶
-
MappedResult.Name¶ Returns the custom name of the object.
-------------------------------------Getter Method
Signature
NameReturns: Return type: str New in version NX3.0.0.
License requirements: None.
OwningComponent¶
-
MappedResult.OwningComponent¶ Returns the owning component, if this object is an occurrence.
-------------------------------------Getter Method
Signature
OwningComponentReturns: Return type: NXOpen.Assemblies.ComponentNew in version NX3.0.0.
License requirements: None.
OwningPart¶
-
MappedResult.OwningPart¶ Returns the owning part of this object
-------------------------------------Getter Method
Signature
OwningPartReturns: The owning part of this object or null if it does not have an owner Return type: NXOpen.BasePartNew in version NX3.0.0.
License requirements: None.
Prototype¶
-
MappedResult.Prototype¶ Returns the prototype of this object if it is an occurrence.
-------------------------------------Getter Method
Signature
PrototypeReturns: The prototype of this object or null if this object is not an occurrence Return type: NXOpen.INXObjectNew in version NX3.0.0.
License requirements: None.
Method Detail¶
FindObject¶
-
MappedResult.FindObject¶ Finds the
NXOpen.NXObjectwith 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.INXObjectNew in version NX3.0.0.
License requirements: None.
GetFilename¶
-
MappedResult.GetFilename¶ Gets the mapped result filename used to create this object.
Signature
GetFilename()Returns: Return type: str New in version NX9.0.0.
License requirements: None.
GetFiletype¶
-
MappedResult.GetFiletype¶ Gets the mapped result filetype (
NXOpen.CAE.ResultFiletypeSignature
GetFiletype()Returns: Return type: NXOpen.CAE.ResultFiletypeNew in version NX9.0.0.
License requirements: None.
Print¶
-
MappedResult.Print¶ Prints a representation of this object to the system log file.
Signature
Print()New in version NX3.0.0.
License requirements: None.
SetName¶
-
MappedResult.SetName¶ Sets the custom name of the object.
NOTE: This method should not be used to edit a read-only object such as a Mirrored PMI object. If it is, the changes will be overridden when the part is updated.
Signature
SetName(name)Parameters: name (str) – New in version NX3.0.0.
License requirements: None.