AFU File and Data Record Manager More...

Inheritance diagram for NXOpen.CAE.AfuManager:

Public Types
enum	WritingFileMode { Override, Append }
	This enumeration defines the modes of outputting information to a file More...

Public Member Functions
unsafe string	CreateRecord (NXOpen.CAE.XyFunctionMacroType macroType, NXOpen.CAE.XyFunctionGeneralType dataType, NXOpen.CAE.AfuData afuData)
	Create a new AFU Data Record. More...

unsafe string	EditRecord (NXOpen.CAE.XyFunctionMacroType macroType, NXOpen.CAE.XyFunctionGeneralType dataType, int afuRecordIndex, NXOpen.CAE.AfuData afuData)
	Edit an existing AFU Data Record. More...

unsafe void	CopyRecords (string[] sourceAfuFileNames, int[] recordIndexes, string destinationAfuFileName)
	Copy multiple AFU Data Records to an AFU file More...

unsafe void	DeleteRecords (string afuFileName, int[] afuRecordIndexes)
	Delete multiple AFU Data Records from an AFU file More...

unsafe string	GetAfuData (string afuFileName, int recordIndex, out NXOpen.CAE.AfuData afuData)
	Return data from an AFU Data Record More...

unsafe NXOpen.CAE.AfuData	CreateAfuData (NXOpen.CAE.AfuData.AbscissaType abscissaType)
	Create an AFU Data Record object with specified axis definition More...

unsafe void	CreateNewAfuFile (string afuFileName)
	Create a new empty AFU file More...

unsafe void	DeleteAfuFile (string afuFileName)
	Delete an AFU file More...

unsafe void	ImportAfu (string importFileName, string afuFileName)
	Import AFU Data Records from a CSV, MAT, DAC or RPCIII file More...

unsafe void	ExportAfu (string afuFileName, int recordIndex, string exportFileName)
	Export an AFU Data Record to a CSV, MAT or DAC file More...

unsafe void	RenameRecord (string afuFileName, int recordIndex, string newRecordName)
	Rename an AFU Data Record More...

unsafe int[]	GetRecordIndexes (string afuFileName)
	Return indices of all Data Records in an AFU file More...

unsafe void	ListRecordInformation (string afuFileName, int recordIndex, bool listPointData, string outputFileName, NXOpen.CAE.AfuManager.WritingFileMode mode)
	List the AFU Data Record information to listing window or a specified output file More...

unsafe void	ListFileInformation (string afuFileName, bool listPointData, string outputFileName, NXOpen.CAE.AfuManager.WritingFileMode mode)
	List header information of all AFU Data Records in an AFU file to listing window or a specified output file More...

unsafe void	ExportAfuFile (string afuFileName, string exportFileName)
	Export all Data Records of an AFU to a RPCIII file More...

unsafe void	CreateRecord (NXOpen.CAE.AfuData afuData)
	Create a new AFU Data Record. More...

unsafe void	EditRecord (int afuRecordIndex, NXOpen.CAE.AfuData afuData)
	Edit an existing AFU Data Record. More...

unsafe NXOpen.CAE.AfuHeaderId	CreateAfuHeaderId ()
	Create an AFU Header Id object More...

unsafe string	GetAfuUnitTypeText (NXOpen.CAE.XyFunctionUnit unit)
	Return the unit type text of AFU data like "Displacement", "Time" etc. More...

unsafe string	GetAfuUnitText (NXOpen.CAE.XyFunctionUnit unit)
	Return the unit text of AFU data like "mm", "sec" etc. More...

unsafe NXOpen.CAE.AfuAbscissaHeaderInfo	CreateAfuAbscissaHeaderInfo ()
	Creates an afu abscissa header information data object More...

unsafe NXOpen.CAE.AfuOrdinateHeaderInfo	CreateAfuOrdinateHeaderInfo ()
	Creates an afu ordindate header information data object More...

unsafe NXOpen.CAE.AfuZHeaderInfo	CreateAfuZHeaderInfo ()
	Create an afu Z axis header information data object More...

Properties
Tag	Tag `[get]`
	Returns the tag of this object. More...

NXOpen.CAE.AfuDataConvertor	AfuDataConvertor `[get]`
	Contains FFT operations for AFU data More...

NXOpen.CAE.AfuMathOperation	AfuMathOperation `[get]`
	Contains Math Operations for AFU data More...

Detailed Description

AFU File and Data Record Manager

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

Created in NX4.0.0

Member Enumeration Documentation

enum NXOpen.CAE.AfuManager.WritingFileMode

This enumeration defines the modes of outputting information to a file

Enumerator

Override

Opens an empty file for writing.

If the given file exists, its contents are destroyed.

Append

Opens a file for appending data to the end of the file

Member Function Documentation

unsafe void NXOpen.CAE.AfuManager.CopyRecords	(	string[]	sourceAfuFileNames,
		int[]	recordIndexes,
		string	destinationAfuFileName
	)

Copy multiple AFU Data Records to an AFU file

Created in NX4.0.0

License requirements: None.

Parameters

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

unsafe NXOpen.CAE.AfuAbscissaHeaderInfo NXOpen.CAE.AfuManager.CreateAfuAbscissaHeaderInfo ( )

Creates an afu abscissa header information data object

Created in NX10.0.0

License requirements: None.

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

unsafe NXOpen.CAE.AfuData NXOpen.CAE.AfuManager.CreateAfuData ( NXOpen.CAE.AfuData.AbscissaType abscissaType )

Create an AFU Data Record object with specified axis definition

Created in NX9.0.0

License requirements: None.

Parameters

abscissaType Abscissa specific data type

Returns: AFU Data Record

unsafe NXOpen.CAE.AfuHeaderId NXOpen.CAE.AfuManager.CreateAfuHeaderId ( )

Create an AFU Header Id object

Created in NX5.0.0

License requirements: None.

Returns: AFU Header Id data

unsafe NXOpen.CAE.AfuOrdinateHeaderInfo NXOpen.CAE.AfuManager.CreateAfuOrdinateHeaderInfo ( )

Creates an afu ordindate header information data object

Created in NX10.0.0

License requirements: None.

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

unsafe NXOpen.CAE.AfuZHeaderInfo NXOpen.CAE.AfuManager.CreateAfuZHeaderInfo ( )

Create an afu Z axis header information data object

Created in NX10.0.0

License requirements: None.

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

unsafe void NXOpen.CAE.AfuManager.CreateNewAfuFile ( string afuFileName )

Create a new empty AFU file

Created in NX4.0.0

License requirements: None.

Parameters

afuFileName AFU filename

unsafe string NXOpen.CAE.AfuManager.CreateRecord	(	NXOpen.CAE.XyFunctionMacroType	macroType,
		NXOpen.CAE.XyFunctionGeneralType	dataType,
		NXOpen.CAE.AfuData	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.

Created in NX4.0.0

License requirements: None.

Parameters

macroType	Application type of AFU Data Record used
dataType	Usage type of AFU Data Record used
afuData	Afu data used to create AFU Data Record

Returns: Time stamp string indicates when the record was created

unsafe void NXOpen.CAE.AfuManager.CreateRecord ( NXOpen.CAE.AfuData afuData )

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.

Created in NX5.0.0

License requirements: None.

Parameters

afuData Afu data used to create AFU Data Record

unsafe void NXOpen.CAE.AfuManager.DeleteAfuFile ( string afuFileName )

Delete an AFU file

Created in NX4.0.0

License requirements: None.

Parameters

afuFileName AFU filename

unsafe void NXOpen.CAE.AfuManager.DeleteRecords	(	string	afuFileName,
		int[]	afuRecordIndexes
	)

Delete multiple AFU Data Records from an AFU file

Created in NX4.0.0

License requirements: None.

Parameters

afuFileName	AFU file full name
afuRecordIndexes	List of Indexes of data records to be deleted from the AFU file. (Indexes begin with 1)

unsafe string NXOpen.CAE.AfuManager.EditRecord	(	NXOpen.CAE.XyFunctionMacroType	macroType,
		NXOpen.CAE.XyFunctionGeneralType	dataType,
		int	afuRecordIndex,
		NXOpen.CAE.AfuData	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.

Created in NX4.0.0

License requirements: None.

Parameters

macroType	Application type of AFU Data Record used
dataType	Usage type of AFU Data Record used
afuRecordIndex	Index of the AFU Data Record in the AFU file. Must begin with 1
afuData	Afu data used to create the AFU Data Record

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

unsafe void NXOpen.CAE.AfuManager.EditRecord	(	int	afuRecordIndex,
		NXOpen.CAE.AfuData	afuData
	)

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.

Created in NX5.0.0

License requirements: None.

Parameters

afuRecordIndex	Index of the AFU Data Record in the AFU file. Must begin with 1
afuData	Afu data used to create the AFU Data Record

unsafe void NXOpen.CAE.AfuManager.ExportAfu	(	string	afuFileName,
		int	recordIndex,
		string	exportFileName
	)

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

Created in NX4.0.0

License requirements: None.

Parameters

afuFileName	AFU filename
recordIndex	Index of the AFU Data Record to be exported
exportFileName	Name of destination file to which AFU Data Record is exported

unsafe void NXOpen.CAE.AfuManager.ExportAfuFile	(	string	afuFileName,
		string	exportFileName
	)

Export all Data Records of an AFU to a RPCIII file

Created in NX5.0.0

License requirements: None.

Parameters

afuFileName	AFU filename
exportFileName	Name of destination file to which AFU Data Record is exported

unsafe string NXOpen.CAE.AfuManager.GetAfuData	(	string	afuFileName,
		int	recordIndex,
		out NXOpen.CAE.AfuData	afuData
	)

Return data from an AFU Data Record

Created in NX4.0.0

License requirements: None.

Parameters

afuFileName	AFU filename
recordIndex	Index of the AFU Data Record in the AFU file. Must begin with 1
afuData	AFU record data queried

Returns: Time stamp string indicates the last time the AFU Data Record was edited

unsafe string NXOpen.CAE.AfuManager.GetAfuUnitText ( NXOpen.CAE.XyFunctionUnit unit )

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

Created in NX5.0.0

License requirements: None.

Parameters

unit	Unit Code of AFU data

Returns: Unit text of AFU data

unsafe string NXOpen.CAE.AfuManager.GetAfuUnitTypeText ( NXOpen.CAE.XyFunctionUnit unit )

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

Created in NX5.0.0

License requirements: None.

Parameters

unit	Unit Code of AFU data

Returns: Unit type text of AFU data

unsafe int [] NXOpen.CAE.AfuManager.GetRecordIndexes ( string afuFileName )

Return indices of all Data Records in an AFU file

Created in NX4.0.0

License requirements: None.

Parameters

afuFileName AFU Filename

Returns: Index array of all Data Records in the AFU file.

unsafe void NXOpen.CAE.AfuManager.ImportAfu	(	string	importFileName,
		string	afuFileName
	)

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

Created in NX4.0.0

License requirements: None.

Parameters

importFileName	Filename for the file to be imported
afuFileName	AFU Filename to import data into

unsafe void NXOpen.CAE.AfuManager.ListFileInformation	(	string	afuFileName,
		bool	listPointData,
		string	outputFileName,
		NXOpen.CAE.AfuManager.WritingFileMode	mode
	)

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

Created in NX4.0.0

License requirements: None.

Parameters

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

unsafe void NXOpen.CAE.AfuManager.ListRecordInformation	(	string	afuFileName,
		int	recordIndex,
		bool	listPointData,
		string	outputFileName,
		NXOpen.CAE.AfuManager.WritingFileMode	mode
	)

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

Created in NX4.0.0

License requirements: None.

Parameters

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

unsafe void NXOpen.CAE.AfuManager.RenameRecord	(	string	afuFileName,
		int	recordIndex,
		string	newRecordName
	)

Rename an AFU Data Record

Created in NX4.0.0

License requirements: None.

Parameters

afuFileName	AFU Filename
recordIndex	Index of the AFU Data Record in the AFU file. Must begin with 1.
newRecordName	New Data Record name

Property Documentation

NXOpen.CAE.AfuDataConvertor NXOpen.CAE.AfuManager.AfuDataConvertor

get

Contains FFT operations for AFU data

Created in NX3.0.0

NXOpen.CAE.AfuMathOperation NXOpen.CAE.AfuManager.AfuMathOperation

get

Contains Math Operations for AFU data

Created in NX3.0.0

Tag NXOpen.CAE.AfuManager.Tag

get

Returns the tag of this object.

The documentation for this class was generated from the following file:

dotnet_pool/CAE_AfuManager.cs

Public Types

Public Member Functions

Properties

Detailed Description

Member Enumeration Documentation

Member Function Documentation

Property Documentation