NX Open C++ Reference Guide
|
AFU File and Data Record Manager
To obtain an instance of this class, refer to 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. | |
NXOpen::CAE::AfuMathOperation * | AfuMathOperation () |
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::AfuData * | CreateAfuData () |
Create an AFU Data Record object. | |
NXOpen::CAE::AfuHeaderId * | CreateAfuHeaderId () |
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. |
AFU File and Data Record Manager
To obtain an instance of this class, refer to Session
Created in NX4.0.0.
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")
sourceAfuFileNames | List of the AFU Files to be copied (full filenames) NOTE: The full Unicode character set is not supported for this parameter. |
recordIndexes | Indexes of the AFU Data Records to be copied. Each index Must begin with 1 |
destinationAfuFileName | Destination AFU file (full filename) NOTE: The full Unicode character set is not supported for this parameter. |
Create an AFU Data Record object.
Create an AFU Header Id object.
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")
afuFileName | AFU filename NOTE: The full Unicode character set is not supported for this parameter. |
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.
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 : nx_ftk ("NX Advanced Graphing")
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 : nx_ftk ("NX Advanced Graphing")
afuFileName | AFU 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")
afuFileName | AFU file full name NOTE: The full Unicode character set is not supported for this parameter. |
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.
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 : nx_ftk ("NX Advanced Graphing")
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 : nx_ftk ("NX Advanced Graphing")
afuFileName | AFU filename NOTE: The full Unicode character set is not supported for this parameter. |
recordIndex | Index of the AFU Data Record to be exported |
exportFileName | Name 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")
afuFileName | AFU filename NOTE: The full Unicode character set is not supported for this parameter. |
exportFileName | Name 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.
afuFileName | AFU filename NOTE: The full Unicode character set is not supported for this parameter. |
recordIndex | Index of the AFU Data Record in the AFU file. Must begin with 1 |
afuData | AFU record data queried |
std::vector<int> NXOpen::CAE::AfuManager::GetRecordIndexes | ( | const NXString & | afuFileName | ) |
Return indices of all Data Records in an AFU file.
afuFileName | AFU 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")
importFileName | Filename for the file to be imported NOTE: The full Unicode character set is not supported for this parameter. |
afuFileName | AFU 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")
afuFileName | AFU filename NOTE: The full Unicode character set is not supported for this parameter. |
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 NOTE: The full Unicode character set is not supported for this parameter. |
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 : nx_ftk ("NX Advanced Graphing")
afuFileName | AFU Filename NOTE: The full Unicode character set is not supported for this parameter. |
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. NOTE: The full Unicode character set is not supported for this parameter. |
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 : nx_ftk ("NX Advanced Graphing")
afuFileName | AFU Filename NOTE: The full Unicode character set is not supported for this parameter. |
recordIndex | Index of the AFU Data Record in the AFU file. Must begin with 1. |
newRecordName | New Data Record name NOTE: The full Unicode character set is not supported for this parameter. |
tag_t NXOpen::CAE::AfuManager::Tag | ( | ) | const |
Returns the tag of this object.