AFU File and Data Record Manager
To obtain an instance of this class, refer to NXOpen::Session

Created in NX4.0.0. More...

Public Types
enum	WritingFileMode { WritingFileModeOverride, WritingFileModeAppend }
	This enumeration defines the modes of outputting information to 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)
	Copy multiple AFU Data 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)
	Copy multiple AFU Data Records to an AFU file Created in NX4.0.0. More...

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

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

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

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

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

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

void	CreateNewAfuFile (const char *afuFileName)
	Create 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)
	Create a new AFU Data Record. More...

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

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

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

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

void	DeleteRecords (const char *afuFileName, const std::vector< int > &afuRecordIndexes)
	Delete multiple AFU Data 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)
	Edit an existing AFU Data Record. More...

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

void	ExportAfu (const NXString &afuFileName, int recordIndex, const NXString &exportFileName)
	Export an AFU Data Record to a CSV, MAT or DAC file Created in NX4.0.0. More...

void	ExportAfu (const char afuFileName, int recordIndex, const char exportFileName)
	Export an AFU Data Record to a CSV, MAT or DAC file Created in NX4.0.0. More...

void	ExportAfuFile (const NXString &afuFileName, const NXString &exportFileName)
	Export all Data Records of an AFU to a RPCIII file Created in NX5.0.0. More...

void	ExportAfuFile (const char afuFileName, const char exportFileName)
	Export all Data Records of an AFU to a RPCIII file Created in NX5.0.0. More...

NXString	GetAfuData (const NXString &afuFileName, int recordIndex, NXOpen::CAE::AfuData **afuData)
	Return data from an AFU Data Record. More...

NXString	GetAfuData (const char afuFileName, int recordIndex, NXOpen::CAE::AfuData *afuData)
	Return data from an AFU Data Record. More...

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

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

std::vector< int >	GetRecordIndexes (const NXString &afuFileName)
	Return indices of all Data Records in an AFU file. More...

std::vector< int >	GetRecordIndexes (const char *afuFileName)
	Return indices of all Data Records in an AFU file. More...

void	ImportAfu (const NXString &importFileName, const NXString &afuFileName)
	Import AFU Data Records from a CSV, MAT, DAC or RPCIII file Created in NX4.0.0. More...

void	ImportAfu (const char importFileName, const char afuFileName)
	Import AFU Data Records from a CSV, MAT, DAC or RPCIII file Created in NX4.0.0. More...

void	ListFileInformation (const NXString &afuFileName, bool listPointData, const NXString &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. More...

void	ListFileInformation (const char afuFileName, bool listPointData, const char 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. More...

void	ListRecordInformation (const NXString &afuFileName, int recordIndex, bool listPointData, const NXString &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. More...

void	ListRecordInformation (const char afuFileName, int recordIndex, bool listPointData, const char 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. More...

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

void	RenameRecord (const char afuFileName, int recordIndex, const char newRecordName)
	Rename an AFU Data Record Created in NX4.0.0. More...

tag_t	Tag () const
	Returns the tag of this object. 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

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
	)

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)

void NXOpen::CAE::AfuManager::CopyRecords	(	std::vector< NXString > &	sourceAfuFileNames,
		const std::vector< int > &	recordIndexes,
		const char *	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)

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

Creates an afu abscissa header information data object.

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 )

Create an AFU Data Record object with specified axis definition.

Returns: AFU Data Record
Created in NX9.0.0.

License requirements : None

Parameters

abscissaType Abscissa specific data type

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

Create an AFU Header Id object.

Returns: AFU Header Id data
Created in NX5.0.0.

License requirements : None

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

Creates an afu ordindate header information data object.

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 an afu Z axis header information data object.

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 )

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

License requirements : None

Parameters

afuFileName AFU filename

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

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

License requirements : None

Parameters

afuFileName AFU filename

NXString 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.

Returns: Time stamp string indicates when the record was created
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

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::SetFunctionDataType . Timestamp is NOT outputted.

Created in NX5.0.0.

License requirements : None

Parameters

afuData Afu data used to create AFU Data Record

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

Delete an AFU file
Created in NX4.0.0.

License requirements : None

Parameters

afuFileName AFU filename

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

Delete an AFU file
Created in NX4.0.0.

License requirements : None

Parameters

afuFileName AFU filename

void NXOpen::CAE::AfuManager::DeleteRecords	(	const NXString &	afuFileName,
		const std::vector< 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)

void NXOpen::CAE::AfuManager::DeleteRecords	(	const char *	afuFileName,
		const std::vector< 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)

NXString 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.

Returns: Time stamp string indicates when the data record was last edited
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

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::SetFunctionDataType . 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

void NXOpen::CAE::AfuManager::ExportAfu	(	const NXString &	afuFileName,
		int	recordIndex,
		const NXString &	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

void NXOpen::CAE::AfuManager::ExportAfu	(	const char *	afuFileName,
		int	recordIndex,
		const char *	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

void NXOpen::CAE::AfuManager::ExportAfuFile	(	const NXString &	afuFileName,
		const NXString &	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

void NXOpen::CAE::AfuManager::ExportAfuFile	(	const char *	afuFileName,
		const char *	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

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

Return data from an AFU Data Record.

Returns: Time stamp string indicates the last time the AFU Data Record was edited
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

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

Return data from an AFU Data Record.

Returns: Time stamp string indicates the last time the AFU Data Record was edited
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

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

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

Returns: Unit text of AFU data
Created in NX5.0.0.

License requirements : None

Parameters

unit	Unit Code of AFU data

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

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

Returns: Unit type text of AFU data
Created in NX5.0.0.

License requirements : None

Parameters

unit	Unit Code of AFU data

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

Return indices of all Data Records in an AFU file.

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

License requirements : None

Parameters

afuFileName AFU Filename

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

Return indices of all Data Records in an AFU file.

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

License requirements : None

Parameters

afuFileName AFU Filename

void NXOpen::CAE::AfuManager::ImportAfu	(	const NXString &	importFileName,
		const NXString &	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

void NXOpen::CAE::AfuManager::ImportAfu	(	const char *	importFileName,
		const char *	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

void NXOpen::CAE::AfuManager::ListFileInformation	(	const NXString &	afuFileName,
		bool	listPointData,
		const NXString &	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.

void NXOpen::CAE::AfuManager::ListFileInformation	(	const char *	afuFileName,
		bool	listPointData,
		const char *	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.

void NXOpen::CAE::AfuManager::ListRecordInformation	(	const NXString &	afuFileName,
		int	recordIndex,
		bool	listPointData,
		const NXString &	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.

void NXOpen::CAE::AfuManager::ListRecordInformation	(	const char *	afuFileName,
		int	recordIndex,
		bool	listPointData,
		const char *	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.

void NXOpen::CAE::AfuManager::RenameRecord	(	const NXString &	afuFileName,
		int	recordIndex,
		const NXString &	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

void NXOpen::CAE::AfuManager::RenameRecord	(	const char *	afuFileName,
		int	recordIndex,
		const char *	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

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