NX Open C++ Reference Guide
Public Types | Public Member Functions
NXOpen::CAE::AfuManager Class Reference

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

Created in NX4.0.0. More...

List of all members.

Public Types

enum  WritingFileMode { WritingFileModeOverride, WritingFileModeAppend }
 This enumeration defines the modes of outputting information to a file. More...

Public Member Functions

NXOpen::CAE::AfuDataConvertorAfuDataConvertor ()
 Contains FFT operations for AFU data
Created in NX3.0.0.
NXOpen::CAE::AfuMathOperationAfuMathOperation ()
 Contains Math Operations for AFU data
Created in NX3.0.0.
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.
NXOpen::CAE::AfuDataCreateAfuData ()
 Create an AFU Data Record object.
NXOpen::CAE::AfuHeaderIdCreateAfuHeaderId ()
 Create an AFU Header Id object.
void CreateNewAfuFile (const NXString &afuFileName)
 Create a new empty AFU file
Created in NX4.0.0.
NXString CreateRecord (NXOpen::CAE::XyFunctionMacroType macroType, NXOpen::CAE::XyFunctionGeneralType dataType, NXOpen::CAE::AfuData *afuData)
 Create a new AFU Data Record.
void CreateRecord (NXOpen::CAE::AfuData *afuData)
 Create a new AFU Data Record.
void DeleteAfuFile (const NXString &afuFileName)
 Delete an AFU file
Created in NX4.0.0.
void DeleteRecords (const NXString &afuFileName, const std::vector< int > &afuRecordIndexes)
 Delete multiple AFU Data Records from an AFU file
Created in NX4.0.0.
NXString EditRecord (NXOpen::CAE::XyFunctionMacroType macroType, NXOpen::CAE::XyFunctionGeneralType dataType, int afuRecordIndex, NXOpen::CAE::AfuData *afuData)
 Edit an existing AFU Data Record.
void EditRecord (int afuRecordIndex, NXOpen::CAE::AfuData *afuData)
 Edit an existing AFU Data Record.
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.
void ExportAfuFile (const NXString &afuFileName, const NXString &exportFileName)
 Export all Data Records of an AFU to a RPCIII file
Created in NX5.0.0.
NXString GetAfuData (const NXString &afuFileName, int recordIndex, NXOpen::CAE::AfuData **afuData)
 Return data from an AFU Data Record.
NXString GetAfuUnitText (NXOpen::CAE::XyFunctionUnit unit)
 Return the unit text of AFU data like "mm", "sec" etc.
NXString GetAfuUnitTypeText (NXOpen::CAE::XyFunctionUnit unit)
 Return the unit type text of AFU data like "Displacement", "Time" etc.
std::vector< int > GetRecordIndexes (const NXString &afuFileName)
 Return indices of all Data Records in an AFU file.
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.
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.
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.
void RenameRecord (const NXString &afuFileName, int recordIndex, const NXString &newRecordName)
 Rename an AFU Data Record
Created in NX4.0.0.
tag_t Tag () const
 Returns the tag of this object.

Detailed Description

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

Created in NX4.0.0.



Member Enumeration Documentation

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

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


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 : nx_ftk ("NX Advanced Graphing")

Parameters:
sourceAfuFileNamesList of the AFU Files to be copied (full filenames)
NOTE: The full Unicode character set is not supported for this parameter.
recordIndexesIndexes of the AFU Data Records to be copied. Each index Must begin with 1
destinationAfuFileNameDestination AFU file (full filename)
NOTE: The full Unicode character set is not supported for this parameter.

Create an AFU Data Record object.

Returns:
AFU Data Record
Created in NX4.0.0.

License requirements : nx_ftk ("NX Advanced Graphing")

Create an AFU Header Id object.

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

License requirements : nx_ftk ("NX Advanced Graphing")
void NXOpen::CAE::AfuManager::CreateNewAfuFile ( const NXString afuFileName)

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



License requirements : nx_ftk ("NX Advanced Graphing")

Parameters:
afuFileNameAFU filename
NOTE: The full Unicode character set is not supported for this parameter.

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 : nx_ftk ("NX Advanced Graphing")
Parameters:
macroTypeApplication type of AFU Data Record used
dataTypeUsage type of AFU Data Record used
afuDataAfu data used to create AFU Data Record

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 : nx_ftk ("NX Advanced Graphing")

Parameters:
afuDataAfu 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 : nx_ftk ("NX Advanced Graphing")

Parameters:
afuFileNameAFU filename
NOTE: The full Unicode character set is not supported for this parameter.
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 : nx_ftk ("NX Advanced Graphing")

Parameters:
afuFileNameAFU file full name
NOTE: The full Unicode character set is not supported for this parameter.
afuRecordIndexesList of Indexes of data records to be deleted from the AFU file. (Indexes begin with 1)

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 : nx_ftk ("NX Advanced Graphing")
Parameters:
macroTypeApplication type of AFU Data Record used
dataTypeUsage type of AFU Data Record used
afuRecordIndexIndex of the AFU Data Record in the AFU file. Must begin with 1
afuDataAfu 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 : nx_ftk ("NX Advanced Graphing")

Parameters:
afuRecordIndexIndex of the AFU Data Record in the AFU file. Must begin with 1
afuDataAfu 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 : nx_ftk ("NX Advanced Graphing")

Parameters:
afuFileNameAFU filename
NOTE: The full Unicode character set is not supported for this parameter.
recordIndexIndex of the AFU Data Record to be exported
exportFileNameName of destination file to which AFU Data Record is exported
NOTE: The full Unicode character set is not supported for this parameter.
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 : nx_ftk ("NX Advanced Graphing")

Parameters:
afuFileNameAFU filename
NOTE: The full Unicode character set is not supported for this parameter.
exportFileNameName of destination file to which AFU Data Record is exported
NOTE: The full Unicode character set is not supported for this parameter.
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 : nx_ftk ("NX Advanced Graphing")
Parameters:
afuFileNameAFU filename
NOTE: The full Unicode character set is not supported for this parameter.
recordIndexIndex of the AFU Data Record in the AFU file. Must begin with 1
afuDataAFU record data queried

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

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

License requirements : nx_ftk ("NX Advanced Graphing")
Parameters:
unitUnit Code of AFU data

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 : nx_ftk ("NX Advanced Graphing")
Parameters:
unitUnit 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 : nx_ftk ("NX Advanced Graphing")
Parameters:
afuFileNameAFU Filename
NOTE: The full Unicode character set is not supported for this parameter.
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 : nx_ftk ("NX Advanced Graphing")

Parameters:
importFileNameFilename for the file to be imported
NOTE: The full Unicode character set is not supported for this parameter.
afuFileNameAFU Filename to import data into
NOTE: The full Unicode character set is not supported for this parameter.
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 : nx_ftk ("NX Advanced Graphing")

Parameters:
afuFileNameAFU filename
NOTE: The full Unicode character set is not supported for this parameter.
listPointDataList Control Flag. If true, the record XY data will be listed. Otherwise only AFU header information is listed.
outputFileNameOutput file to which the record information is written. If NULL, the information is only output to the listing window
NOTE: The full Unicode character set is not supported for this parameter.
modeOverwrite 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 : nx_ftk ("NX Advanced Graphing")

Parameters:
afuFileNameAFU Filename
NOTE: The full Unicode character set is not supported for this parameter.
recordIndexIndex of the AFU Data Record to be listed
listPointDataList control flag. If true, the record XY data will be listed. Otherwise only AFU header information is listed.
outputFileNameOutput file to which the record information is written. If NULL, the information is only output to the listing window.
NOTE: The full Unicode character set is not supported for this parameter.
modeOverwrite 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 : nx_ftk ("NX Advanced Graphing")

Parameters:
afuFileNameAFU Filename
NOTE: The full Unicode character set is not supported for this parameter.
recordIndexIndex of the AFU Data Record in the AFU file. Must begin with 1.
newRecordNameNew Data Record name
NOTE: The full Unicode character set is not supported for this parameter.

Returns the tag of this object.


The documentation for this class was generated from the following file:
Copyright 2011 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.