Provides methods to manipulate AFU file or AFU record. More...

Public Types
enum	WritingFileMode { WritingFileModeOverride, WritingFileModeAppend }
	This enumeration defines the write modes for a file. More...

Public Member Functions
NXOpen::CAE::AfuDataConvertor *	AfuDataConvertor ()
	Contains FFT operations for AFU data Created in NX3.0.0. More...

NXOpen::CAE::AfuMathOperation *	AfuMathOperation ()
	Contains Math Operations for AFU data Created in NX3.0.0. More...

void	CopyRecords (std::vector< NXString > &sourceAfuFileNames, const std::vector< int > &recordIndexes, const NXString &destinationAfuFileName)
	Copies multiple AFU records to an AFU file Created in NX4.0.0. More...

void	CopyRecords (std::vector< NXString > &sourceAfuFileNames, const std::vector< int > &recordIndexes, const char *destinationAfuFileName)
	Copies multiple AFU records to an AFU file Created in NX4.0.0. More...

NXOpen::CAE::AfuAbscissaHeaderInfo *	CreateAfuAbscissaHeaderInfo ()
	Creates an abscissa header information data object of an AFU record. More...

NXOpen::CAE::AfuData *	CreateAfuData (NXOpen::CAE::AfuData::AbscissaType abscissaType)
	Creates an AFU record data object with specified axis definition. More...

NXOpen::CAE::AfuHeaderId *	CreateAfuHeaderId ()
	Creates a header id object of an AFU record. More...

NXOpen::CAE::AfuOrdinateHeaderInfo *	CreateAfuOrdinateHeaderInfo ()
	Creates an ordindate header information data object of an AFU record. More...

NXOpen::CAE::AfuZHeaderInfo *	CreateAfuZHeaderInfo ()
	Create a Z axis header information data object of an AFU record. More...

void	CreateNewAfuFile (const NXString &afuFileName)
	Creates a new empty AFU file Created in NX4.0.0. More...

void	CreateNewAfuFile (const char *afuFileName)
	Creates a new empty AFU file Created in NX4.0.0. More...

NXString	CreateRecord (NXOpen::CAE::XyFunctionMacroType macroType, NXOpen::CAE::XyFunctionGeneralType dataType, NXOpen::CAE::AfuData *afuData)
	Creates a new AFU record. More...

void	CreateRecord (NXOpen::CAE::AfuData *afuData)
	Creates a new AFU record. More...

void	DeleteAfuFile (const NXString &afuFileName)
	Deletes an AFU file Created in NX4.0.0. More...

void	DeleteAfuFile (const char *afuFileName)
	Deletes an AFU file Created in NX4.0.0. More...

void	DeleteRecords (const NXString &afuFileName, const std::vector< int > &afuRecordIndexes)
	Deletes multiple AFU records from an AFU file Created in NX4.0.0. More...

void	DeleteRecords (const char *afuFileName, const std::vector< int > &afuRecordIndexes)
	Deletes multiple AFU records from an AFU file Created in NX4.0.0. More...

NXString	EditRecord (NXOpen::CAE::XyFunctionMacroType macroType, NXOpen::CAE::XyFunctionGeneralType dataType, int afuRecordIndex, NXOpen::CAE::AfuData *afuData)
	Edits an existing AFU record. More...

void	EditRecord (int afuRecordIndex, NXOpen::CAE::AfuData *afuData)
	Edits an existing AFU record. More...

void	ExportAfu (const NXString &afuFileName, int recordIndex, const NXString &exportFileName)
	Exports an AFU record to an external file file. More...

void	ExportAfu (const char afuFileName, int recordIndex, const char exportFileName)
	Exports an AFU record to an external file file. More...

void	ExportAfuFile (const NXString &afuFileName, const NXString &exportFileName)
	Exports all records in an AFU file to an external file. More...

void	ExportAfuFile (const char afuFileName, const char exportFileName)
	Exports all records in an AFU file to an external file. More...

NXString	GetAfuData (const NXString &afuFileName, int recordIndex, NXOpen::CAE::AfuData **afuData)
	Returns the AFU record data. More...

NXString	GetAfuData (const char afuFileName, int recordIndex, NXOpen::CAE::AfuData *afuData)
	Returns the AFU record data. More...

NXString	GetAfuUnitText (NXOpen::CAE::XyFunctionUnit unit)
	Returns the unit text of unit enumeration like "mm", "sec" etc. More...

NXString	GetAfuUnitTypeText (NXOpen::CAE::XyFunctionUnit unit)
	Returns the measure text of unit enumeration like "Displacement", "Time" etc. More...

std::vector< int >	GetRecordIndexes (const NXString &afuFileName)
	Returns record indices of all records in an AFU file. More...

std::vector< int >	GetRecordIndexes (const char *afuFileName)
	Returns record indices of all records in an AFU file. More...

void	ImportAfu (const NXString &importFileName, const NXString &afuFileName)
	Imports the data from an external file to create AFU records. More...

void	ImportAfu (const char importFileName, const char afuFileName)
	Imports the data from an external file to create AFU records. More...

void	ListFileInformation (const NXString &afuFileName, bool listPointData, const NXString &outputFileName, NXOpen::CAE::AfuManager::WritingFileMode mode)
	Lists record information of all records in an AFU file to listing window or a specified output file Created in NX4.0.0. More...

void	ListFileInformation (const char afuFileName, bool listPointData, const char outputFileName, NXOpen::CAE::AfuManager::WritingFileMode mode)
	Lists record information of all records in an AFU file to listing window or a specified output file Created in NX4.0.0. More...

void	ListRecordInformation (const NXString &afuFileName, int recordIndex, bool listPointData, const NXString &outputFileName, NXOpen::CAE::AfuManager::WritingFileMode mode)
	Lists the AFU record information to listing window or a specified output file Created in NX4.0.0. More...

void	ListRecordInformation (const char afuFileName, int recordIndex, bool listPointData, const char outputFileName, NXOpen::CAE::AfuManager::WritingFileMode mode)
	Lists the AFU record information to listing window or a specified output file Created in NX4.0.0. More...

void	RenameRecord (const NXString &afuFileName, int recordIndex, const NXString &newRecordName)
	Renames an AFU record Created in NX4.0.0. More...

void	RenameRecord (const char afuFileName, int recordIndex, const char newRecordName)
	Renames an AFU record Created in NX4.0.0. More...

tag_t	Tag () const
	Returns the tag of this object. More...

Detailed Description

Provides methods to manipulate AFU file or AFU record.

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 write modes for a file.

Enumerator

WritingFileModeOverride

Opens an empty file for writing.

If the given file exists, its contents are destroyed.

WritingFileModeAppend

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

Member Function Documentation

NXOpen::CAE::AfuDataConvertor* NXOpen::CAE::AfuManager::AfuDataConvertor ( )

Contains FFT operations for AFU data
Created in NX3.0.0.

NXOpen::CAE::AfuMathOperation* NXOpen::CAE::AfuManager::AfuMathOperation ( )

Contains Math Operations for AFU data
Created in NX3.0.0.

void NXOpen::CAE::AfuManager::CopyRecords	(	std::vector< NXString > &	sourceAfuFileNames,
		const std::vector< int > &	recordIndexes,
		const NXString &	destinationAfuFileName
	)

Copies multiple AFU records to an AFU file
Created in NX4.0.0.

License requirements : None

Parameters

sourceAfuFileNames	the AFU files to be copied
recordIndexes	Indexes of the AFU records to be copied. Each index Must begin with 1
destinationAfuFileName	Destination AFU file

void NXOpen::CAE::AfuManager::CopyRecords	(	std::vector< NXString > &	sourceAfuFileNames,
		const std::vector< int > &	recordIndexes,
		const char *	destinationAfuFileName
	)

Copies multiple AFU records to an AFU file
Created in NX4.0.0.

License requirements : None

Parameters

sourceAfuFileNames	the AFU files to be copied
recordIndexes	Indexes of the AFU records to be copied. Each index Must begin with 1
destinationAfuFileName	Destination AFU file

NXOpen::CAE::AfuAbscissaHeaderInfo* NXOpen::CAE::AfuManager::CreateAfuAbscissaHeaderInfo ( )

Creates an abscissa header information data object of an AFU record.

Returns: Abscissa header information data NXOpen::CAE::AfuAbscissaHeaderInfo to be created
Created in NX10.0.0.

License requirements : None

NXOpen::CAE::AfuData* NXOpen::CAE::AfuManager::CreateAfuData ( NXOpen::CAE::AfuData::AbscissaType abscissaType )

Creates an AFU record data object with specified axis definition.

Returns: AFU record data
Created in NX9.0.0.

License requirements : None

Parameters

abscissaType Abscissa specific data type

NXOpen::CAE::AfuHeaderId* NXOpen::CAE::AfuManager::CreateAfuHeaderId ( )

Creates a header id object of an AFU record.

Returns: the header id data of an AFU record
Created in NX5.0.0.

License requirements : None

NXOpen::CAE::AfuOrdinateHeaderInfo* NXOpen::CAE::AfuManager::CreateAfuOrdinateHeaderInfo ( )

Creates an ordindate header information data object of an AFU record.

Returns: Ordindate header information data NXOpen::CAE::AfuOrdinateHeaderInfo to be created
Created in NX10.0.0.

License requirements : None

NXOpen::CAE::AfuZHeaderInfo* NXOpen::CAE::AfuManager::CreateAfuZHeaderInfo ( )

Create a Z axis header information data object of an AFU record.

Returns: Z axis header information data NXOpen::CAE::AfuZHeaderInfo to be created
Created in NX10.0.0.

License requirements : None

void NXOpen::CAE::AfuManager::CreateNewAfuFile ( const NXString & afuFileName )

Creates a new empty AFU file
Created in NX4.0.0.

License requirements : None

Parameters

afuFileName AFU file name

void NXOpen::CAE::AfuManager::CreateNewAfuFile ( const char * afuFileName )

Creates a new empty AFU file
Created in NX4.0.0.

License requirements : None

Parameters

afuFileName AFU file name

NXString NXOpen::CAE::AfuManager::CreateRecord	(	NXOpen::CAE::XyFunctionMacroType	macroType,
		NXOpen::CAE::XyFunctionGeneralType	dataType,
		NXOpen::CAE::AfuData *	afuData
	)

Creates a new AFU record.

Application type and usage type are specified to set the function data type of the AFU record. Timestamp is outputted.

Returns: Time stamp string indicates when the record was created
Created in NX4.0.0.

License requirements : None

Parameters

macroType	Application type of AFU record used
dataType	Usage type of AFU record used
afuData	Afu record data

void NXOpen::CAE::AfuManager::CreateRecord ( NXOpen::CAE::AfuData * afuData )

Creates a new AFU record.

Application type and usage type are NOT specified. The function data type of the AFU record will be set by CAE::AfuData::SetFunctionDataType . Timestamp is NOT outputted.

Created in NX5.0.0.

License requirements : None

Parameters

afuData Afu record data

void NXOpen::CAE::AfuManager::DeleteAfuFile ( const NXString & afuFileName )

Deletes an AFU file
Created in NX4.0.0.

License requirements : None

Parameters

afuFileName AFU file name

void NXOpen::CAE::AfuManager::DeleteAfuFile ( const char * afuFileName )

Deletes an AFU file
Created in NX4.0.0.

License requirements : None

Parameters

afuFileName AFU file name

void NXOpen::CAE::AfuManager::DeleteRecords	(	const NXString &	afuFileName,
		const std::vector< int > &	afuRecordIndexes
	)

Deletes multiple AFU records from an AFU file
Created in NX4.0.0.

License requirements : None

Parameters

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

void NXOpen::CAE::AfuManager::DeleteRecords	(	const char *	afuFileName,
		const std::vector< int > &	afuRecordIndexes
	)

Deletes multiple AFU records from an AFU file
Created in NX4.0.0.

License requirements : None

Parameters

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

NXString NXOpen::CAE::AfuManager::EditRecord	(	NXOpen::CAE::XyFunctionMacroType	macroType,
		NXOpen::CAE::XyFunctionGeneralType	dataType,
		int	afuRecordIndex,
		NXOpen::CAE::AfuData *	afuData
	)

Edits an existing AFU record.

Application type and usage type are specified to set the function data type of the AFU record. Timestamp is outputted.

Returns: Time stamp string indicates when the record was last edited
Created in NX4.0.0.

License requirements : None

Parameters

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

void NXOpen::CAE::AfuManager::EditRecord	(	int	afuRecordIndex,
		NXOpen::CAE::AfuData *	afuData
	)

Edits an existing AFU record.

Application type and usage type are NOT specified. The function data type of the AFU record will be set by CAE::AfuData::SetFunctionDataType . Timestamp is NOT outputted.

Created in NX5.0.0.

License requirements : None

Parameters

afuRecordIndex	Index of the AFU record in the AFU file. Must begin with 1
afuData	Afu record data

void NXOpen::CAE::AfuManager::ExportAfu	(	const NXString &	afuFileName,
		int	recordIndex,
		const NXString &	exportFileName
	)

Exports an AFU record to an external file file.

Currently supports CSV, MAT, DAC and UNV58 files.

Created in NX4.0.0.

License requirements : None

Parameters

afuFileName	AFU file name
recordIndex	Index of the AFU record to be exported
exportFileName	The file name to be exported

void NXOpen::CAE::AfuManager::ExportAfu	(	const char *	afuFileName,
		int	recordIndex,
		const char *	exportFileName
	)

Exports an AFU record to an external file file.

Currently supports CSV, MAT, DAC and UNV58 files.

Created in NX4.0.0.

License requirements : None

Parameters

afuFileName	AFU file name
recordIndex	Index of the AFU record to be exported
exportFileName	The file name to be exported

void NXOpen::CAE::AfuManager::ExportAfuFile	(	const NXString &	afuFileName,
		const NXString &	exportFileName
	)

Exports all records in an AFU file to an external file.

Currently supports RPCIII and UNV58 files.

Created in NX5.0.0.

License requirements : None

Parameters

afuFileName	AFU file name
exportFileName	The file name to be exported

void NXOpen::CAE::AfuManager::ExportAfuFile	(	const char *	afuFileName,
		const char *	exportFileName
	)

Exports all records in an AFU file to an external file.

Currently supports RPCIII and UNV58 files.

Created in NX5.0.0.

License requirements : None

Parameters

afuFileName	AFU file name
exportFileName	The file name to be exported

NXString NXOpen::CAE::AfuManager::GetAfuData	(	const NXString &	afuFileName,
		int	recordIndex,
		NXOpen::CAE::AfuData **	afuData
	)

Returns the AFU record data.

Returns: Time stamp string indicates the last time the AFU record was edited
Created in NX4.0.0.

License requirements : None

Parameters

afuFileName	AFU file name
recordIndex	Index of the AFU record in the AFU file. Must begin with 1
afuData	AFU record data

NXString NXOpen::CAE::AfuManager::GetAfuData	(	const char *	afuFileName,
		int	recordIndex,
		NXOpen::CAE::AfuData **	afuData
	)

Returns the AFU record data.

Returns: Time stamp string indicates the last time the AFU record was edited
Created in NX4.0.0.

License requirements : None

Parameters

afuFileName	AFU file name
recordIndex	Index of the AFU record in the AFU file. Must begin with 1
afuData	AFU record data

NXString NXOpen::CAE::AfuManager::GetAfuUnitText ( NXOpen::CAE::XyFunctionUnit unit )

Returns the unit text of unit enumeration like "mm", "sec" etc.

Returns: Unit text
Created in NX5.0.0.

License requirements : None

Parameters

unit	Unit enumeration

NXString NXOpen::CAE::AfuManager::GetAfuUnitTypeText ( NXOpen::CAE::XyFunctionUnit unit )

Returns the measure text of unit enumeration like "Displacement", "Time" etc.

Returns: Measure text
Created in NX5.0.0.

License requirements : None

Parameters

unit	Unit enumeration

std::vector<int> NXOpen::CAE::AfuManager::GetRecordIndexes ( const NXString & afuFileName )

Returns record indices of all records in an AFU file.

Returns: Index array of all records in the AFU file.
Created in NX4.0.0.

License requirements : None

Parameters

afuFileName AFU file name

std::vector<int> NXOpen::CAE::AfuManager::GetRecordIndexes ( const char * afuFileName )

Returns record indices of all records in an AFU file.

Returns: Index array of all records in the AFU file.
Created in NX4.0.0.

License requirements : None

Parameters

afuFileName AFU file name

void NXOpen::CAE::AfuManager::ImportAfu	(	const NXString &	importFileName,
		const NXString &	afuFileName
	)

Imports the data from an external file to create AFU records.

Currently supports CSV, MAT, DAC, RPCIII, UNV58, Samcef Des files.

Created in NX4.0.0.

License requirements : None

Parameters

importFileName	The file name to be imported
afuFileName	AFU file name

void NXOpen::CAE::AfuManager::ImportAfu	(	const char *	importFileName,
		const char *	afuFileName
	)

Imports the data from an external file to create AFU records.

Currently supports CSV, MAT, DAC, RPCIII, UNV58, Samcef Des files.

Created in NX4.0.0.

License requirements : None

Parameters

importFileName	The file name to be imported
afuFileName	AFU file name

void NXOpen::CAE::AfuManager::ListFileInformation	(	const NXString &	afuFileName,
		bool	listPointData,
		const NXString &	outputFileName,
		NXOpen::CAE::AfuManager::WritingFileMode	mode
	)

Lists record information of all records in an AFU file to listing window or a specified output file
Created in NX4.0.0.

License requirements : None

Parameters

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

void NXOpen::CAE::AfuManager::ListFileInformation	(	const char *	afuFileName,
		bool	listPointData,
		const char *	outputFileName,
		NXOpen::CAE::AfuManager::WritingFileMode	mode
	)

Lists record information of all records in an AFU file to listing window or a specified output file
Created in NX4.0.0.

License requirements : None

Parameters

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

void NXOpen::CAE::AfuManager::ListRecordInformation	(	const NXString &	afuFileName,
		int	recordIndex,
		bool	listPointData,
		const NXString &	outputFileName,
		NXOpen::CAE::AfuManager::WritingFileMode	mode
	)

Lists the AFU record information to listing window or a specified output file
Created in NX4.0.0.

License requirements : None

Parameters

afuFileName	AFU file name
recordIndex	Index of the AFU 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 outputted to the listing window.
mode	Output file write mode: Overwrite or Append, only valid when output file name is not NULL.

void NXOpen::CAE::AfuManager::ListRecordInformation	(	const char *	afuFileName,
		int	recordIndex,
		bool	listPointData,
		const char *	outputFileName,
		NXOpen::CAE::AfuManager::WritingFileMode	mode
	)

Lists the AFU record information to listing window or a specified output file
Created in NX4.0.0.

License requirements : None

Parameters

afuFileName	AFU file name
recordIndex	Index of the AFU 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 outputted to the listing window.
mode	Output file write mode: Overwrite or Append, only valid when output file name is not NULL.

void NXOpen::CAE::AfuManager::RenameRecord	(	const NXString &	afuFileName,
		int	recordIndex,
		const NXString &	newRecordName
	)

Renames an AFU record
Created in NX4.0.0.

License requirements : None

Parameters

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

void NXOpen::CAE::AfuManager::RenameRecord	(	const char *	afuFileName,
		int	recordIndex,
		const char *	newRecordName
	)

Renames an AFU record
Created in NX4.0.0.

License requirements : None

Parameters

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

tag_t NXOpen::CAE::AfuManager::Tag ( ) const

Returns the tag of this object.

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

CAE_AfuManager.hxx

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Member Function Documentation