AfuData Class¶

class NXOpen.CAE.AfuData¶

Bases: NXOpen.TransientObject

the data used to create an AFU Data Record

New in version NX4.0.0.

Properties¶

Property	Description
AfuAbscissaHeaderInfo	Returns or sets the abscissa header information data of the AFU Data Record
AfuHeaderId	Returns or sets the AFU Header Id data of the AFU Data Record
AfuOrdinateHeaderInfo	Returns or sets the ordinate header information data of the AFU Data Record
AfuZHeaderInfo	Returns or sets the Z axis header information data of the AFU Data Record
FileName	Returns or sets the name of AFU file
FunctionDataType	Returns or sets the data type of the AFU Data Record
RecordName	Returns or sets the name of the AFU Data Record

Methods¶

Method	Description
Dispose	Free the AFU Data transient object memory
GetAbscissaAndOrdinateAxisDefinition	Get the Abscissa and Ordinate Axis definitions of an AFU Data Record
GetAxisDefinition	Get the Abscissa and Ordinate Axis definitions of an AFU Data Record
GetComplexData	Get the XY data of an AFU Data Record when the ordinate type is Complex @return Ordinate element data values for imaginary part or phase part
GetEvenData	Get the Abscissa Information for an AFU Data Record when the abscissa type is even
GetIdInformation	Returns main AFU Data Record ID information
GetRealData	Get the XY Data of an AFU Data Record when the ordinate type is real @return Ordinate element data values
SetAbscissaAndOrdinateAxisDefinition	Set the Abscissa and Ordinate Axis definitions of an AFU Data Record
SetAxisDefinition	Set the Abscissa and Ordinate Axis definitions of an AFU Data Record
SetComplexData	Set the XY Data of an AFU record when the ordinate type is Complex
SetEvenData	Set the Abscissa Information for AFU Data Record when abscissa type is even
SetIdInformation	Sets the main AFU Data Record ID information
SetRealData	Set the XY Data of an AFU Data Record when the ordinate type is real

Enumerations¶

AfuDataAbscissaType Enumeration	Defines abscissa data type for AFU data record
AfuDataOrdinateType Enumeration	Defines ordinate data type for AFU data record

Property Detail¶

AfuAbscissaHeaderInfo¶

AfuData.AfuAbscissaHeaderInfo¶

Returns or sets the abscissa header information data of the AFU Data Record

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

Getter Method

Signature AfuAbscissaHeaderInfo()

Returns:	Abscissa header information data `CAE.AfuAbscissaHeaderInfo` to be get
Return type:	`NXOpen.CAE.AfuAbscissaHeaderInfo`

New in version NX10.0.0.

License requirements: nx_ftk (“NX Advanced Graphing”)

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

Setter Method

Signature AfuAbscissaHeaderInfo(abscissaHeaderInfo)

Parameters:	abscissaHeaderInfo (`NXOpen.CAE.AfuAbscissaHeaderInfo`) – Abscissa header information data `CAE.AfuAbscissaHeaderInfo` to be set

New in version NX10.0.0.

License requirements: nx_ftk (“NX Advanced Graphing”)

AfuHeaderId¶

AfuData.AfuHeaderId¶

Returns or sets the AFU Header Id data of the AFU Data Record

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

Getter Method

Signature AfuHeaderId()

Returns:	The AFU Header Id data
Return type:	`NXOpen.CAE.AfuHeaderId`

New in version NX5.0.0.

License requirements: nx_ftk (“NX Advanced Graphing”)

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

Setter Method

Signature AfuHeaderId(afuHeaderId)

Parameters:	afuHeaderId (`NXOpen.CAE.AfuHeaderId`) – The AFU Header Id data

New in version NX5.0.0.

License requirements: nx_ftk (“NX Advanced Graphing”)

AfuOrdinateHeaderInfo¶

AfuData.AfuOrdinateHeaderInfo¶

Returns or sets the ordinate header information data of the AFU Data Record

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

Getter Method

Signature AfuOrdinateHeaderInfo()

Returns:	Ordindate header information data `CAE.AfuOrdinateHeaderInfo` to be get
Return type:	`NXOpen.CAE.AfuOrdinateHeaderInfo`

New in version NX10.0.0.

License requirements: nx_ftk (“NX Advanced Graphing”)

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

Setter Method

Signature AfuOrdinateHeaderInfo(ordinateHeaderInfo)

Parameters:	ordinateHeaderInfo (`NXOpen.CAE.AfuOrdinateHeaderInfo`) – Ordindate header information data `CAE.AfuOrdinateHeaderInfo` to be set

New in version NX10.0.0.

License requirements: nx_ftk (“NX Advanced Graphing”)

AfuZHeaderInfo¶

AfuData.AfuZHeaderInfo¶

Returns or sets the Z axis header information data of the AFU Data Record

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

Getter Method

Signature AfuZHeaderInfo()

Returns:	Z axis header information data `CAE.AfuZHeaderInfo` to be get
Return type:	`NXOpen.CAE.AfuZHeaderInfo`

New in version NX10.0.0.

License requirements: nx_ftk (“NX Advanced Graphing”)

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

Setter Method

Signature AfuZHeaderInfo(zHeaderInfoP)

Parameters:	zHeaderInfoP (`NXOpen.CAE.AfuZHeaderInfo`) – Z axis header information data `CAE.AfuZHeaderInfo` to be set

New in version NX10.0.0.

License requirements: nx_ftk (“NX Advanced Graphing”)

FileName¶

AfuData.FileName¶

Returns or sets the name of AFU file

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

Getter Method

Signature FileName()

Returns:	The full name of the AFU file
Return type:	str

New in version NX4.0.0.

License requirements: nx_ftk (“NX Advanced Graphing”)

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

Setter Method

Signature FileName(afuFileName)

Parameters:	afuFileName (str) – The full name of the AFU file

New in version NX4.0.0.

License requirements: nx_ftk (“NX Advanced Graphing”)

FunctionDataType¶

AfuData.FunctionDataType¶

Returns or sets the data type of the AFU Data Record

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

Getter Method

Signature FunctionDataType()

Returns:	The data type of a function in AFU
Return type:	`NXOpen.CAE.XyFunctionDataType`

New in version NX5.0.0.

License requirements: nx_ftk (“NX Advanced Graphing”)

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

Setter Method

Signature FunctionDataType(functionDataType)

Parameters:	functionDataType (`NXOpen.CAE.XyFunctionDataType`) – The data type of a function in AFU

New in version NX5.0.0.

License requirements: nx_ftk (“NX Advanced Graphing”)

RecordName¶

AfuData.RecordName¶

Returns or sets the name of the AFU Data Record

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

Getter Method

Signature RecordName()

Returns:	The name of the AFU Data Record
Return type:	str

New in version NX4.0.0.

License requirements: nx_ftk (“NX Advanced Graphing”)

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

Setter Method

Signature RecordName(afuRecordName)

Parameters:	afuRecordName (str) – The name of AFU Data Record

New in version NX4.0.0.

License requirements: nx_ftk (“NX Advanced Graphing”)

Method Detail¶

Dispose¶

AfuData.Dispose¶

Free the AFU Data transient object memory

Signature Dispose()

New in version NX4.0.0.

License requirements: None.

GetAbscissaAndOrdinateAxisDefinition¶

AfuData.GetAbscissaAndOrdinateAxisDefinition¶

Get the Abscissa and Ordinate Axis definitions of an AFU Data Record

Signature GetAbscissaAndOrdinateAxisDefinition()

Returns: a tuple

Return type: A tuple consisting of (abscissaType, xUnit, ordinateType, yUnit, yDenominatorUnit). abscissaType is a NXOpen.CAE.AfuDataAbscissaType. Abscissa specific data type xUnit is a NXOpen.CAE.XyFunctionUnit. Unit Code of abscissa data ordinateType is a NXOpen.CAE.AfuDataOrdinateType. Ordinate data type yUnit is a NXOpen.CAE.XyFunctionUnit. Unit Code of ordinate data yDenominatorUnit is a NXOpen.CAE.XyFunctionUnit. Unit Code of ordinate data

New in version NX9.0.0.

License requirements: nx_ftk (“NX Advanced Graphing”)

GetAxisDefinition¶

AfuData.GetAxisDefinition¶

Get the Abscissa and Ordinate Axis definitions of an AFU Data Record

Signature GetAxisDefinition()

Returns:	a tuple
Return type:	A tuple consisting of (abscissaType, xUnit, oridinateType, yUnit). abscissaType is a `NXOpen.CAE.AfuDataAbscissaType`. Abscissa specific data type xUnit is a `NXOpen.CAE.XyFunctionUnit`. Unit Code of abscissa data oridinateType is a `NXOpen.CAE.AfuDataOrdinateType`. Ordinate data type yUnit is a `NXOpen.CAE.XyFunctionUnit`. Unit Code of ordinate data

New in version NX4.0.0.

Deprecated since version NX9.0.0: Use AfuData.GetAbscissaAndOrdinateAxisDefinition with Denominator.

License requirements: nx_ftk (“NX Advanced Graphing”)

GetComplexData¶

AfuData.GetComplexData¶

Get the XY data of an AFU Data Record when the ordinate type is Complex

Signature GetComplexData()

Returns:	a tuple
Return type:	A tuple consisting of (zValues, xValues, yValues). zValues is a list of float. Ordinate element data values for imaginary part or phase part xValues is a list of float. Abscissa element data valuesyValues is a list of float. Ordinate element data values for real part or magnitude part

New in version NX4.0.0.

License requirements: nx_ftk (“NX Advanced Graphing”)

GetEvenData¶

AfuData.GetEvenData¶

Get the Abscissa Information for an AFU Data Record when the abscissa type is even

Signature GetEvenData()

Returns:	a tuple
Return type:	A tuple consisting of (xMinimum, xIncrement, numberOfPoints). xMinimum is a float. Minimum abscissa data value xIncrement is a float. Abscissa increment numberOfPoints is a int. Number of abscissa elements

New in version NX4.0.0.

License requirements: nx_ftk (“NX Advanced Graphing”)

GetIdInformation¶

AfuData.GetIdInformation¶

Returns main AFU Data Record ID information

Signature GetIdInformation()

Returns: a tuple

Return type: A tuple consisting of (reference, referenceId, response, responseId). reference is a str. String to define reference direction sense. Up to 4 characters are allowed and the redundant characters will be ignored. ( X, Y, Z, RX, RY, and RZ have specific meaning but the character set can be anything including a “+” or “-” as the last character. examples: ABC+ RSTU ) referenceId is a int. ID of reference element or node response is a str. String to define response direction sense. Up to 4 characters are allowed and the redundant characters will be ignored. ( X, Y, Z, RX, RY, and RZ have specific meaning but the character set can be anything including a “+” or “-” as the last character. examples: ABC+ RSTU ) responseId is a int. ID of response element or node

New in version NX4.0.0.

Deprecated since version NX10.0.0: Use AfuData.AfuHeaderId instead.

License requirements: nx_ftk (“NX Advanced Graphing”)

GetRealData¶

AfuData.GetRealData¶

Get the XY Data of an AFU Data Record when the ordinate type is real

Signature GetRealData()

Returns:	a tuple
Return type:	A tuple consisting of (yValues, xValues). yValues is a list of float. Ordinate element data values xValues is a list of float. Abscissa element data values

New in version NX4.0.0.

License requirements: nx_ftk (“NX Advanced Graphing”)

SetAbscissaAndOrdinateAxisDefinition¶

AfuData.SetAbscissaAndOrdinateAxisDefinition¶

Set the Abscissa and Ordinate Axis definitions of an AFU Data Record

Signature SetAbscissaAndOrdinateAxisDefinition(xUnit, ordinateType, yUnit, yDenominatorUnit)

Parameters:	xUnit (`NXOpen.CAE.XyFunctionUnit`) – Unit Code of abscissa data ordinateType (`NXOpen.CAE.AfuDataOrdinateType`) – Ordinate data type yUnit (`NXOpen.CAE.XyFunctionUnit`) – Unit Code of ordinate data yDenominatorUnit (`NXOpen.CAE.XyFunctionUnit`) – Unit Code of ordinate data

New in version NX9.0.0.

License requirements: nx_ftk (“NX Advanced Graphing”)

SetAxisDefinition¶

AfuData.SetAxisDefinition¶

Set the Abscissa and Ordinate Axis definitions of an AFU Data Record

Signature SetAxisDefinition(abscissaType, xUnit, oridinateType, yUnit)

Parameters:	abscissaType (`NXOpen.CAE.AfuDataAbscissaType`) – Abscissa specific data type xUnit (`NXOpen.CAE.XyFunctionUnit`) – Unit Code of abscissa data oridinateType (`NXOpen.CAE.AfuDataOrdinateType`) – Ordinate specific data type yUnit (`NXOpen.CAE.XyFunctionUnit`) – Unit Code of ordinate data

New in version NX4.0.0.

Deprecated since version NX9.0.0: Use AfuData.SetAbscissaAndOrdinateAxisDefinition with Denominator.

License requirements: nx_ftk (“NX Advanced Graphing”)

SetComplexData¶

AfuData.SetComplexData¶

Overloaded method SetComplexData

SetComplexData(xValues, yValues, zValues)
SetComplexData(xMinimum, xIncrement, yValues, zValues)

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

Set the XY Data of an AFU record when the ordinate type is Complex

Signature SetComplexData(xValues, yValues, zValues)

Parameters:	xValues (list of float) – Abscissa element data values yValues (list of float) – Ordinate element data values for real part or magnitude part zValues (list of float) – Ordinate element data values for imaginary part or phase part

New in version NX4.0.0.

License requirements: nx_ftk (“NX Advanced Graphing”)

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

Set the XY Data of an AFU record when the ordinate type is Complex

Signature SetComplexData(xMinimum, xIncrement, yValues, zValues)

Parameters:	xMinimum (float) – Minimum abscissa data value xIncrement (float) – Abscissa increment yValues (list of float) – Ordinate element data values for real part or magnitude part zValues (list of float) – Ordinate element data values for imaginary part or phase part

New in version NX9.0.0.

License requirements: nx_ftk (“NX Advanced Graphing”)

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

SetEvenData¶

AfuData.SetEvenData¶

Set the Abscissa Information for AFU Data Record when abscissa type is even

Signature SetEvenData(xMinimum, xIncrement, numberOfPoints)

Parameters:	xMinimum (float) – Minimum abscissa data value xIncrement (float) – Abscissa increment numberOfPoints (int) – Number of abscissa elements

New in version NX4.0.0.

Deprecated since version NX9.0.0: Use AfuData.SetRealData or :py:meth:`AfuData.SetComplexData`that takes minimum abscissa value and increment instead.

License requirements: nx_ftk (“NX Advanced Graphing”)

SetIdInformation¶

AfuData.SetIdInformation¶

Sets the main AFU Data Record ID information

Signature SetIdInformation(reference, referenceId, response, responseId)

Parameters:

reference (str) – String to define reference direction sense. Up to 4 characters are allowed and the redundant characters will be ignored. ( X, Y, Z, RX, RY, and RZ have specific meaning but the character set can be anything including a “+” or “-” as the last character. examples: ABC+ RSTU ) NOTE: The full Unicode character set is not supported for this parameter.
referenceId (int) – ID of reference element or node
response (str) – String to define response direction sense. Up to 4 characters are allowed and the redundant characters will be ignored. ( X, Y, Z, RX, RY, and RZ have specific meaning but the character set can be anything including a “+” or “-” as the last character. examples: ABC+ RSTU ) NOTE: The full Unicode character set is not supported for this parameter.
responseId (int) – ID of response element or node

New in version NX4.0.0.

Deprecated since version NX10.0.0: Use AfuData.AfuHeaderId instead.

License requirements: nx_ftk (“NX Advanced Graphing”)

SetRealData¶

AfuData.SetRealData¶

Overloaded method SetRealData

SetRealData(xValues, yValues)
SetRealData(xMinimum, xIncrement, yValues)

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

Set the XY Data of an AFU Data Record when the ordinate type is real

Signature SetRealData(xValues, yValues)

Parameters:	xValues (list of float) – Abscissa element data values yValues (list of float) – Ordinate element data values

New in version NX4.0.0.

License requirements: nx_ftk (“NX Advanced Graphing”)

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

Set the XY Data of an AFU Data Record when the ordinate type is real and the absicssa type is even

Signature SetRealData(xMinimum, xIncrement, yValues)

Parameters:	xMinimum (float) – Minimum abscissa data value xIncrement (float) – Abscissa increment yValues (list of float) – Ordinate element data values

New in version NX9.0.0.

License requirements: nx_ftk (“NX Advanced Graphing”)

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