SectionBasedMatrixRecord Class

class NXOpen.CAE.FTK.SectionBasedMatrixRecord

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

Represents a kind of record data could be displayed by 3D graphing.

The record is consist of multiple section data and each section data repsresents a 2D record data. Not support KF.

New in version NX10.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.
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.
SectionCount Returns the section count
Tag Returns the Tag for this object.
Title Returns the title name
XCoordinateUnit Returns or sets the X-Coordinate unit
YCoordinateUnit Returns or sets the Y-Coordinate unit
ZCoordinateUnit Returns or sets the Z-Coordinate unit

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.
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.
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, 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
Print Prints a representation of this object to the system log file.
RemoveSectionData Removes the data values of the specific section.
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.
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

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

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

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

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

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

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

SectionCount

SectionBasedMatrixRecord.SectionCount

Returns the section count

-------------------------------------

Getter Method

Signature SectionCount

Returns:Section count
Return type:int

New in version NX10.0.0.

License requirements: None.

Title

SectionBasedMatrixRecord.Title

Returns the title name

-------------------------------------

Getter Method

Signature Title

Returns:Title name
Return type:str

New in version NX10.0.0.

License requirements: None.

XCoordinateUnit

SectionBasedMatrixRecord.XCoordinateUnit

Returns or sets the X-Coordinate unit

-------------------------------------

Getter Method

Signature XCoordinateUnit

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

New in version NX10.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature XCoordinateUnit

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

New in version NX10.0.0.

License requirements: None.

YCoordinateUnit

SectionBasedMatrixRecord.YCoordinateUnit

Returns or sets the Y-Coordinate unit

-------------------------------------

Getter Method

Signature YCoordinateUnit

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

New in version NX10.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature YCoordinateUnit

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

New in version NX10.0.0.

License requirements: None.

ZCoordinateUnit

SectionBasedMatrixRecord.ZCoordinateUnit

Returns or sets the Z-Coordinate unit

-------------------------------------

Getter Method

Signature ZCoordinateUnit

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

New in version NX10.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature ZCoordinateUnit

Parameters:zCoordinateUnit (NXOpen.CAE.FTK.BaseUnit) – Z-Coordinate unit

New in version NX10.0.0.

License requirements: None.

Method Detail

FindObject

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

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

Print

SectionBasedMatrixRecord.Print

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

Signature Print()

New in version NX3.0.0.

License requirements: None.

RemoveSectionData

SectionBasedMatrixRecord.RemoveSectionData

Removes the data values of the specific section.

The section index must be greater than or equal to 0 and less than CAE.FTK.SectionBasedMatrixRecord.SectionCount().

Signature RemoveSectionData(sectionIndex)

Parameters:sectionIndex (int) – Section index

New in version NX10.0.0.

License requirements: None.

SetApplicationData

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

SetName

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