ArrayRecord2D Class

class NXOpen.CAE.FTK.ArrayRecord2D

Bases: NXOpen.CAE.FTK.BaseRecord, NXOpen.CAE.FTK.IApplicationDataOwner

Manages the 2d array record

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
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
FindObject	Finds the NXOpen.NXObject with the given identifier as recorded in a journal.
GetAbscissaUnit	Gets the abscissa unit
GetApplicationData	Gets the application specific data associated with the record
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
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.
GetNextUserAttribute	Gets the next attribute encountered on the object, if any, that satisfies the given iterator.
GetOrdinateUnit	Gets the ordinate unit
GetPdmReferenceAttributeValue	Gets the value of PDM Reference attribute for given object.
GetPointLabels	Gets the point labels
GetRealAttribute	Gets a real attribute by title.
GetRealData	Gets real points 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
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.
GetXCoordinateUnit	Gets X-Coordinate unit
GetYCoordinateUnit	Gets Y-Coordinate unit
HasUserAttribute	Determines if an attribute exists on the object, that satisfies the given iterator
Print	Prints a representation of this object to the system log file.
SetApplicationData	Sets the application specific data to the record
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
SetName	Sets the custom name of the object.
SetPdmReferenceAttribute	Sets the value of PDM Reference attribute on the object.
SetPointLabels	Sets the point labels
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.
SetXCoordinateUnit	Sets X-Coordinate unit
SetYCoordinateUnit	Sets Y-Coordinate unit

Property Detail

IsOccurrence

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

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

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

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

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

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

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

GetApplicationData

ArrayRecord2D.GetApplicationData

Gets the application specific data associated with the record

Signature GetApplicationData()

Returns: Return type:NXOpen.CAE.FTK.IApplicationData

New in version NX12.0.0.

License requirements: None.

GetComplexData

ArrayRecord2D.GetComplexData

Gets complex points data

Signature GetComplexData()

Returns:a tuple Return type:A tuple consisting of (xCoordinatePoints, yCoordinateReal, yCoordinateImag) xCoordinatePoints is a list of float. X-Coordinate data yCoordinateReal is a list of float. Real part of Y-Coordinate data yCoordinateImag is a list of float. Imaginary part of Y-Coordinate data

New in version NX9.0.0.

License requirements: None.

GetRealData

ArrayRecord2D.GetRealData

Gets real points data

Signature GetRealData()

Returns:a tuple Return type:A tuple consisting of (xCoordinatePoints, yCoordinatePoints) xCoordinatePoints is a list of float. X-Coordinate data yCoordinatePoints is a list of float. Y-Coordinate data

New in version NX9.0.0.

License requirements: None.

GetTitle

ArrayRecord2D.GetTitle

Gets the title

Signature GetTitle()

Returns: Return type:str

New in version NX9.0.0.

License requirements: None.

GetXCoordinateUnit

ArrayRecord2D.GetXCoordinateUnit

Gets X-Coordinate unit

Signature GetXCoordinateUnit()

Returns:X-Coordinate unit Return type:NXOpen.CAE.FTK.BaseUnit

New in version NX9.0.0.

License requirements: None.

GetYCoordinateUnit

ArrayRecord2D.GetYCoordinateUnit

Gets Y-Coordinate unit

Signature GetYCoordinateUnit()

Returns:Y-Coordinate unit Return type:NXOpen.CAE.FTK.BaseUnit

New in version NX9.0.0.

License requirements: None.

Print

ArrayRecord2D.Print

Prints a representation of this object to the system log file.

Signature Print()

New in version NX3.0.0.

License requirements: None.

SetApplicationData

ArrayRecord2D.SetApplicationData

Sets the application specific data to the record

Signature SetApplicationData(applicationData)

Parameters:applicationData (NXOpen.CAE.FTK.IApplicationData) –

New in version NX12.0.0.

License requirements: None.

SetComplexData

ArrayRecord2D.SetComplexData

Sets complex points data

Signature SetComplexData(xCoordinatePoints, yCoordinateReal, yCoordinateImag)

Parameters:

• xCoordinatePoints (list of float) – X-Coordinate data
• 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: None.

SetName

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

SetPointLabels

ArrayRecord2D.SetPointLabels

Sets the point labels

Signature SetPointLabels(pointLabels)

Parameters:pointLabels (list of str) –

New in version NX12.0.0.

License requirements: None.

SetRealData

ArrayRecord2D.SetRealData

Sets real points data

Signature SetRealData(xCoordinatePoints, yCoordinatePoints)

Parameters:

• xCoordinatePoints (list of float) – X-Coordinate data
• yCoordinatePoints (list of float) – Y-Coordinate data

New in version NX9.0.0.

License requirements: None.

SetXCoordinateUnit

ArrayRecord2D.SetXCoordinateUnit

Sets X-Coordinate unit

Signature SetXCoordinateUnit(xCoordinateUnit)

Parameters:xCoordinateUnit (NXOpen.CAE.FTK.BaseUnit) – X-Coordinate unit

New in version NX7.5.0.

License requirements: None.

SetYCoordinateUnit

ArrayRecord2D.SetYCoordinateUnit

Sets Y-Coordinate unit

Signature SetYCoordinateUnit(yCoordinateUnit)

Parameters:yCoordinateUnit (NXOpen.CAE.FTK.BaseUnit) – Y-Coordinate unit

New in version NX7.5.0.

License requirements: None.