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 |
Extrapolation | Returns or sets the extrapolation type |
FileName | Returns or sets the name of AFU file |
FunctionDataType | Returns or sets the data type of the AFU Data Record |
Interpolation | Returns or sets the interpolation type |
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 |
GetComplexData | Get the XY data of an AFU Data Record when the ordinate type is Complex |
GetEvenData | Get the Abscissa Information for an AFU Data Record when the abscissa type is even |
GetRealData | Get the XY Data of an AFU Data Record when the ordinate type is real |
SetAbscissaAndOrdinateAxisDefinition | 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 |
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 |
AfuDataExtrapolationType Enumeration | Defines data extrapolation type for AFU data record |
AfuDataInterpolationType Enumeration | Defines data interpolation 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 getReturn type: NXOpen.CAE.AfuAbscissaHeaderInfo
New in version NX10.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
AfuAbscissaHeaderInfo
Parameters: abscissaHeaderInfo ( NXOpen.CAE.AfuAbscissaHeaderInfo
) – Abscissa header information dataCAE.AfuAbscissaHeaderInfo
to be setNew in version NX10.0.0.
License requirements: None.
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: None.
-------------------------------------
Setter Method
Signature
AfuHeaderId
Parameters: afuHeaderId ( NXOpen.CAE.AfuHeaderId
) – The AFU Header Id dataNew in version NX5.0.0.
License requirements: None.
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 getReturn type: NXOpen.CAE.AfuOrdinateHeaderInfo
New in version NX10.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
AfuOrdinateHeaderInfo
Parameters: ordinateHeaderInfo ( NXOpen.CAE.AfuOrdinateHeaderInfo
) – Ordindate header information dataCAE.AfuOrdinateHeaderInfo
to be setNew in version NX10.0.0.
License requirements: None.
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 getReturn type: NXOpen.CAE.AfuZHeaderInfo
New in version NX10.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
AfuZHeaderInfo
Parameters: zHeaderInfoP ( NXOpen.CAE.AfuZHeaderInfo
) – Z axis header information dataCAE.AfuZHeaderInfo
to be setNew in version NX10.0.0.
License requirements: None.
Extrapolation¶
-
AfuData.
Extrapolation
¶ Returns or sets the extrapolation type
-------------------------------------
Getter Method
Signature
Extrapolation
Returns: the extrapolation method Return type: NXOpen.CAE.AfuDataExtrapolationType
New in version NX11.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
Extrapolation
Parameters: extrapolation ( NXOpen.CAE.AfuDataExtrapolationType
) – the extrapolation methodNew in version NX11.0.0.
License requirements: None.
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: None.
-------------------------------------
Setter Method
Signature
FileName
Parameters: afuFileName (str) – The full name of the AFU file New in version NX4.0.0.
License requirements: None.
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: None.
-------------------------------------
Setter Method
Signature
FunctionDataType
Parameters: functionDataType ( NXOpen.CAE.XyFunctionDataType
) – The data type of a function in AFUNew in version NX5.0.0.
License requirements: None.
Interpolation¶
-
AfuData.
Interpolation
¶ Returns or sets the interpolation type
-------------------------------------
Getter Method
Signature
Interpolation
Returns: the interpolation method Return type: NXOpen.CAE.AfuDataInterpolationType
New in version NX11.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
Interpolation
Parameters: interpolation ( NXOpen.CAE.AfuDataInterpolationType
) – the interpolation methodNew in version NX11.0.0.
License requirements: None.
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: None.
-------------------------------------
Setter Method
Signature
RecordName
Parameters: afuRecordName (str) – The name of AFU Data Record New in version NX4.0.0.
License requirements: None.
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 aNXOpen.CAE.XyFunctionUnit
. Unit Code of abscissa data ordinateType is aNXOpen.CAE.AfuDataOrdinateType
. Ordinate data type yUnit is aNXOpen.CAE.XyFunctionUnit
. Unit Code of ordinate data yDenominatorUnit is aNXOpen.CAE.XyFunctionUnit
. Unit Code of ordinate dataNew in version NX9.0.0.
License requirements: None.
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: None.
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: None.
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: None.
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: None.
- xUnit (
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: None.
-------------------------------------
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: None.
-------------------------------------
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: None.
-------------------------------------
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: None.
-------------------------------------