AfuManager Class

class NXOpen.CAE.AfuManager

Bases: object

AFU File and Data Record Manager

To obtain an instance of this class, refer to NXOpen.Session

New in version NX4.0.0.

“AfuDataConvertor”, “Contains FFT operations for AFU data ” “AfuMathOperation”, “Contains Math Operations for AFU data “

Methods

Method Description
CopyRecords Copy multiple AFU Data Records to an AFU file
CreateAfuAbscissaHeaderInfo Creates an afu abscissa header information data object
CreateAfuData Create an AFU Data Record object with specified axis definition
CreateAfuHeaderId Create an AFU Header Id object
CreateAfuOrdinateHeaderInfo Creates an afu ordindate header information data object
CreateAfuZHeaderInfo Create an afu Z axis header information data object
CreateNewAfuFile Create a new empty AFU file
CreateRecord Create a new AFU Data Record.
DeleteAfuFile Delete an AFU file
DeleteRecords Delete multiple AFU Data Records from an AFU file
EditRecord Edit an existing AFU Data Record.
ExportAfu Export an AFU Data Record to a CSV, MAT or DAC file
ExportAfuFile Export all Data Records of an AFU to a RPCIII file
GetAfuData Return data from an AFU Data Record
GetAfuUnitText Return the unit text of AFU data like mm, sec etc.
GetAfuUnitTypeText Return the unit type text of AFU data like Displacement, Time etc.
GetRecordIndexes Return indices of all Data Records in an AFU file
ImportAfu Import AFU Data Records from a CSV, MAT, DAC or RPCIII file
ListFileInformation List header information of all AFU Data Records in an AFU file to listing window or a specified output file
ListRecordInformation List the AFU Data Record information to listing window or a specified output file
RenameRecord Rename an AFU Data Record

Enumerations

AfuManagerWritingFileMode Enumeration This enumeration defines the modes of outputting information to a file

AfuDataConvertor

AfuManager.AfuDataConvertor

Contains FFT operations for AFU data

Signature AfuDataConvertor

New in version NX3.0.0.

Returns:
Return type:NXOpen.CAE.AfuDataConvertor

AfuMathOperation

AfuManager.AfuMathOperation

Contains Math Operations for AFU data

Signature AfuMathOperation

New in version NX3.0.0.

Returns:
Return type:NXOpen.CAE.AfuMathOperation

Method Detail

CopyRecords

AfuManager.CopyRecords

Copy multiple AFU Data Records to an AFU file

Signature CopyRecords(sourceAfuFileNames, recordIndexes, destinationAfuFileName)

Parameters:
  • sourceAfuFileNames (list of str) – List of the AFU Files to be copied (full filenames)
  • recordIndexes (list of int) – Indexes of the AFU Data Records to be copied. Each index Must begin with 1
  • destinationAfuFileName (str) – Destination AFU file (full filename)

New in version NX4.0.0.

License requirements: None.

CreateAfuAbscissaHeaderInfo

AfuManager.CreateAfuAbscissaHeaderInfo

Creates an afu abscissa header information data object

Signature CreateAfuAbscissaHeaderInfo()

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

New in version NX10.0.0.

License requirements: None.

CreateAfuData

AfuManager.CreateAfuData

Create an AFU Data Record object with specified axis definition

Signature CreateAfuData(abscissaType)

Parameters:abscissaType (NXOpen.CAE.AfuDataAbscissaType) – Abscissa specific data type
Returns:AFU Data Record
Return type:NXOpen.CAE.AfuData

New in version NX9.0.0.

License requirements: None.

CreateAfuHeaderId

AfuManager.CreateAfuHeaderId

Create an AFU Header Id object

Signature CreateAfuHeaderId()

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

New in version NX5.0.0.

License requirements: None.

CreateAfuOrdinateHeaderInfo

AfuManager.CreateAfuOrdinateHeaderInfo

Creates an afu ordindate header information data object

Signature CreateAfuOrdinateHeaderInfo()

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

New in version NX10.0.0.

License requirements: None.

CreateAfuZHeaderInfo

AfuManager.CreateAfuZHeaderInfo

Create an afu Z axis header information data object

Signature CreateAfuZHeaderInfo()

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

New in version NX10.0.0.

License requirements: None.

CreateNewAfuFile

AfuManager.CreateNewAfuFile

Create a new empty AFU file

Signature CreateNewAfuFile(afuFileName)

Parameters:afuFileName (str) – AFU filename

New in version NX4.0.0.

License requirements: None.

CreateRecord

AfuManager.CreateRecord

Overloaded method CreateRecord

  • CreateRecord(macroType, dataType, afuData)
  • CreateRecord(afuData)

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

Create a new AFU Data Record. Application type and usage type are specified to set the function data type of the AFU Data Record. Timestamp is outputted.

Signature CreateRecord(macroType, dataType, afuData)

Parameters:
Returns:

Time stamp string indicates when the record was created
Return type:

str

New in version NX4.0.0.

License requirements: None.

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

Create a new AFU Data Record. Application type and usage type are NOT specified. The function data type of the AFU Data Record will be set by CAE.AfuData.FunctionDataType(). Timestamp is NOT outputted.

Signature CreateRecord(afuData)

Parameters:afuData (NXOpen.CAE.AfuData) – Afu data used to create AFU Data Record

New in version NX5.0.0.

License requirements: None.

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

DeleteAfuFile

AfuManager.DeleteAfuFile

Delete an AFU file

Signature DeleteAfuFile(afuFileName)

Parameters:afuFileName (str) – AFU filename

New in version NX4.0.0.

License requirements: None.

DeleteRecords

AfuManager.DeleteRecords

Delete multiple AFU Data Records from an AFU file

Signature DeleteRecords(afuFileName, afuRecordIndexes)

Parameters:
  • afuFileName (str) – AFU file full name
  • afuRecordIndexes (list of int) – List of Indexes of data records to be deleted from the AFU file. (Indexes begin with 1)

New in version NX4.0.0.

License requirements: None.

EditRecord

AfuManager.EditRecord

Overloaded method EditRecord

  • EditRecord(macroType, dataType, afuRecordIndex, afuData)
  • EditRecord(afuRecordIndex, afuData)

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

Edit an existing AFU Data Record. Application type and usage type are specified to set the function data type of the AFU Data Record. Timestamp is outputted.

Signature EditRecord(macroType, dataType, afuRecordIndex, afuData)

Parameters:
Returns:

Time stamp string indicates when the data record was last edited
Return type:

str

New in version NX4.0.0.

License requirements: None.

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

Edit an existing AFU Data Record. Application type and usage type are NOT specified. The function data type of the AFU Data Record will be set by CAE.AfuData.FunctionDataType(). Timestamp is NOT outputted.

Signature EditRecord(afuRecordIndex, afuData)

Parameters:
  • afuRecordIndex (int) – Index of the AFU Data Record in the AFU file. Must begin with 1
  • afuData (NXOpen.CAE.AfuData) – Afu data used to create the AFU Data Record

New in version NX5.0.0.

License requirements: None.

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

ExportAfu

AfuManager.ExportAfu

Export an AFU Data Record to a CSV, MAT or DAC file

Signature ExportAfu(afuFileName, recordIndex, exportFileName)

Parameters:
  • afuFileName (str) – AFU filename
  • recordIndex (int) – Index of the AFU Data Record to be exported
  • exportFileName (str) – Name of destination file to which AFU Data Record is exported

New in version NX4.0.0.

License requirements: None.

ExportAfuFile

AfuManager.ExportAfuFile

Export all Data Records of an AFU to a RPCIII file

Signature ExportAfuFile(afuFileName, exportFileName)

Parameters:
  • afuFileName (str) – AFU filename
  • exportFileName (str) – Name of destination file to which AFU Data Record is exported

New in version NX5.0.0.

License requirements: None.

GetAfuData

AfuManager.GetAfuData

Return data from an AFU Data Record

Signature GetAfuData(afuFileName, recordIndex)

Parameters:
  • afuFileName (str) – AFU filename
  • recordIndex (int) – Index of the AFU Data Record in the AFU file. Must begin with 1
Returns:

a tuple
Return type:

A tuple consisting of (recordTimestamp, afuData). recordTimestamp is a str. Time stamp string indicates the last time the AFU Data Record was edited afuData is a NXOpen.CAE.AfuData. AFU record data queried

New in version NX4.0.0.

License requirements: None.

GetAfuUnitText

AfuManager.GetAfuUnitText

Return the unit text of AFU data like “mm”, “sec” etc.

Signature GetAfuUnitText(unit)

Parameters:unit (NXOpen.CAE.XyFunctionUnit) – Unit Code of AFU data
Returns:Unit text of AFU data
Return type:str

New in version NX5.0.0.

License requirements: None.

GetAfuUnitTypeText

AfuManager.GetAfuUnitTypeText

Return the unit type text of AFU data like “Displacement”, “Time” etc.

Signature GetAfuUnitTypeText(unit)

Parameters:unit (NXOpen.CAE.XyFunctionUnit) – Unit Code of AFU data
Returns:Unit type text of AFU data
Return type:str

New in version NX5.0.0.

License requirements: None.

GetRecordIndexes

AfuManager.GetRecordIndexes

Return indices of all Data Records in an AFU file

Signature GetRecordIndexes(afuFileName)

Parameters:afuFileName (str) – AFU Filename
Returns:Index array of all Data Records in the AFU file.
Return type:list of int

New in version NX4.0.0.

License requirements: None.

ImportAfu

AfuManager.ImportAfu

Import AFU Data Records from a CSV, MAT, DAC or RPCIII file

Signature ImportAfu(importFileName, afuFileName)

Parameters:
  • importFileName (str) – Filename for the file to be imported
  • afuFileName (str) – AFU Filename to import data into

New in version NX4.0.0.

License requirements: None.

ListFileInformation

AfuManager.ListFileInformation

List header information of all AFU Data Records in an AFU file to listing window or a specified output file

Signature ListFileInformation(afuFileName, listPointData, outputFileName, mode)

Parameters:
  • afuFileName (str) – AFU filename
  • listPointData (bool) – List Control Flag. If true, the record XY data will be listed. Otherwise only AFU header information is listed.
  • outputFileName (str) – Output file to which the record information is written. If NULL, the information is only output to the listing window
  • mode (NXOpen.CAE.AfuManagerWritingFileMode) – Overwrite or Append Output Mode for file output. Only valid when output file name is not NULL.

New in version NX4.0.0.

License requirements: None.

ListRecordInformation

AfuManager.ListRecordInformation

List the AFU Data Record information to listing window or a specified output file

Signature ListRecordInformation(afuFileName, recordIndex, listPointData, outputFileName, mode)

Parameters:
  • afuFileName (str) – AFU Filename
  • recordIndex (int) – Index of the AFU Data Record to be listed
  • listPointData (bool) – List control flag. If true, the record XY data will be listed. Otherwise only AFU header information is listed.
  • outputFileName (str) – Output file to which the record information is written. If NULL, the information is only output to the listing window.
  • mode (NXOpen.CAE.AfuManagerWritingFileMode) – Overwrite or Append Output Mode for file output. Only valid when output file name is not NULL.

New in version NX4.0.0.

License requirements: None.

RenameRecord

AfuManager.RenameRecord

Rename an AFU Data Record

Signature RenameRecord(afuFileName, recordIndex, newRecordName)

Parameters:
  • afuFileName (str) – AFU Filename
  • recordIndex (int) – Index of the AFU Data Record in the AFU file. Must begin with 1.
  • newRecordName (str) – New Data Record name

New in version NX4.0.0.

License requirements: None.