ArrayRecord2DEven Class¶
-
class
NXOpen.CAE.FTK.
ArrayRecord2DEven
¶ Bases:
NXOpen.CAE.FTK.ArrayRecord2D
Manages the 2d array record with even abscissa data
Not support KF.
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. |
LegendName | Returns the legend name |
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 |
---|---|
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. |
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. |
GetComplexData | Gets complex points data @return X-Coordinate data |
GetComputationalTimeUserAttribute | Gets a time attribute by Title and array Index. |
GetEvenComplexData | Gets even complex data @return Real part of Y-Coordinate data |
GetEvenRealData | Gets even real data @return Y-Coordinate data |
GetIntegerAttribute | Gets an integer attribute by title. |
GetIntegerUserAttribute | Gets an integer attribute by Title and array Index. |
GetLegend | Gets the legend @return |
GetRealAttribute | Gets a real attribute by title. |
GetRealData | Gets real points data @return X-Coordinate data |
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. |
GetTitle | Gets the title @return |
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. |
GetXCoordinateUnit | Gets X-Coordinate unit @return X-Coordinate unit |
GetYCoordinateUnit | Gets Y-Coordinate unit @return Y-Coordinate unit |
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. | |
SetAttribute | Creates or modifies an integer attribute. |
SetBooleanUserAttribute | Creates or modifies a boolean attribute with the option to update or not. |
SetComplexData | Sets complex points data |
SetEvenComplexData | Sets even complex data |
SetEvenRealData | Sets even real data |
SetName | Sets the custom name of the object. |
SetRealData | Sets real points data |
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. |
SetXCoordinatePoints | Sets X-Coordinate points |
SetXCoordinateUnit | Sets X-Coordinate unit |
SetYCoordinatePoints | Sets Y-Coordinate points, the supplied point data consists of real numbers |
SetYCoordinateUnit | Sets Y-Coordinate unit |
Property Detail¶
IsOccurrence¶
-
ArrayRecord2DEven.
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¶
-
ArrayRecord2DEven.
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¶
-
ArrayRecord2DEven.
Name
¶ Returns the custom name of the object.
-------------------------------------
Getter Method
Signature
Name()
Returns: Return type: str New in version NX3.0.0.
License requirements: None.
OwningComponent¶
-
ArrayRecord2DEven.
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¶
-
ArrayRecord2DEven.
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¶
-
ArrayRecord2DEven.
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¶
FindObject¶
-
ArrayRecord2DEven.
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.
GetEvenComplexData¶
-
ArrayRecord2DEven.
GetEvenComplexData
¶ Gets even complex data
Signature
GetEvenComplexData()
Returns: a tuple Return type: A tuple consisting of (yCoordinateReal, xMinimum, xIncrement, yCoordinateImag). yCoordinateReal is a list of float. Real part of Y-Coordinate data xMinimum is a float. Minimum abscissa data value xIncrement is a float. Abscissa increment yCoordinateImag is a list of float. Imaginary part of Y-Coordinate data New in version NX9.0.0.
License requirements: nx_ftk (“NX Advanced Graphing”)
GetEvenRealData¶
-
ArrayRecord2DEven.
GetEvenRealData
¶ Gets even real data
Signature
GetEvenRealData()
Returns: a tuple Return type: A tuple consisting of (yCoordinatePoints, xMinimum, xIncrement). yCoordinatePoints is a list of float. Y-Coordinate data xMinimum is a float. Minimum abscissa data value xIncrement is a float. Abscissa increment New in version NX9.0.0.
License requirements: nx_ftk (“NX Advanced Graphing”)
Print¶
-
ArrayRecord2DEven.
Print
¶ Prints a representation of this object to the system log file.
Signature
Print()
New in version NX3.0.0.
License requirements: None.
SetEvenComplexData¶
-
ArrayRecord2DEven.
SetEvenComplexData
¶ Sets even complex data
Signature
SetEvenComplexData(xMinimum, xIncrement, yCoordinateReal, yCoordinateImag)
Parameters: - xMinimum (float) – Minimum abscissa data value
- xIncrement (float) – Abscissa increment
- yCoordinateReal (list of float) – Real part of Y-Coordinate data
- yCoordinateImag (list of float) – Imaginary part of Y-Coordinate data
New in version NX9.0.0.
License requirements: nx_ftk (“NX Advanced Graphing”)
SetEvenRealData¶
-
ArrayRecord2DEven.
SetEvenRealData
¶ Sets even real data
Signature
SetEvenRealData(xMinimum, xIncrement, yCoordinatePoints)
Parameters: - xMinimum (float) – Minimum abscissa data value
- xIncrement (float) – Abscissa increment
- yCoordinatePoints (list of float) – Y-Coordinate data
New in version NX9.0.0.
License requirements: nx_ftk (“NX Advanced Graphing”)
SetName¶
-
ArrayRecord2DEven.
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.