NXOpen .NET Reference Guide  1899
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties
Public Types | Public Member Functions | Properties | List of all members
NXOpen.CAE.AfuManager Class Reference

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

Inheritance diagram for NXOpen.CAE.AfuManager:
NXOpen.Utilities.NXRemotableObject IMessageSink

Public Types

enum  RequestedMeasureType { Displacement, Velocity, Acceleration, Pressure }
 This enumeration defines the user requested functions types to be read from the puch file More...
 
enum  WritingFileMode { Override, Append }
 This enumeration defines the write modes for a file More...
 

Public Member Functions

unsafe void CopyRecords (string[] sourceAfuFileNames, int[] recordIndexes, string destinationAfuFileName)
 Copies multiple AFU records to an AFU file More...
 
unsafe
NXOpen.CAE.AfuAbscissaHeaderInfo 
CreateAfuAbscissaHeaderInfo ()
 Creates an abscissa header information data object of an AFU record More...
 
unsafe NXOpen.CAE.AfuData CreateAfuData (NXOpen.CAE.AfuData.AbscissaType abscissaType)
 Creates an AFU record data object with specified axis definition More...
 
unsafe NXOpen.CAE.AfuHeaderId CreateAfuHeaderId ()
 Creates a header id object of an AFU record More...
 
unsafe
NXOpen.CAE.AfuOrdinateHeaderInfo 
CreateAfuOrdinateHeaderInfo ()
 Creates an ordindate header information data object of an AFU record More...
 
unsafe NXOpen.CAE.AfuZHeaderInfo CreateAfuZHeaderInfo ()
 Create a Z axis header information data object of an AFU record More...
 
unsafe void CreateNewAfuFile (string afuFileName)
 Creates a new empty AFU file More...
 
unsafe string CreateRecord (NXOpen.CAE.XyFunctionMacroType macroType, NXOpen.CAE.XyFunctionGeneralType dataType, NXOpen.CAE.AfuData afuData)
 Creates a new AFU record. More...
 
unsafe void CreateRecord (NXOpen.CAE.AfuData afuData)
 Creates a new AFU record. More...
 
unsafe void CreateRecordsFromPunchFile (string sourcePchFileNames, string destinationAfuFileName, NXOpen.CAE.AfuManager.RequestedMeasureType[] requestedFunctions)
 Creates a AFU records from punch file. More...
 
unsafe void DeleteAfuFile (string afuFileName)
 Deletes an AFU file More...
 
unsafe void DeleteRecords (string afuFileName, int[] afuRecordIndexes)
 Deletes multiple AFU records from an AFU file More...
 
unsafe string EditRecord (NXOpen.CAE.XyFunctionMacroType macroType, NXOpen.CAE.XyFunctionGeneralType dataType, int afuRecordIndex, NXOpen.CAE.AfuData afuData)
 Edits an existing AFU record. More...
 
unsafe void EditRecord (int afuRecordIndex, NXOpen.CAE.AfuData afuData)
 Edits an existing AFU record. More...
 
unsafe void ExportAfu (string afuFileName, int recordIndex, string exportFileName)
 Exports an AFU record to an external file file. More...
 
unsafe void ExportAfuFile (string afuFileName, string exportFileName)
 Exports all records in an AFU file to an external file. More...
 
unsafe string GetAfuData (string afuFileName, int recordIndex, out NXOpen.CAE.AfuData afuData)
 Returns the AFU record data More...
 
unsafe string GetAfuUnitText (NXOpen.CAE.XyFunctionUnit unit)
 Returns the unit text of unit enumeration like "mm", "sec" etc. More...
 
unsafe string GetAfuUnitTypeText (NXOpen.CAE.XyFunctionUnit unit)
 Returns the measure text of unit enumeration like "Displacement", "Time" etc. More...
 
unsafe int[] GetRecordIndexes (string afuFileName)
 Returns record indices of all records in an AFU file More...
 
unsafe void ImportAfu (string importFileName, string afuFileName)
 Imports the data from an external file to create AFU records. More...
 
unsafe void ListFileInformation (string afuFileName, bool listPointData, string outputFileName, NXOpen.CAE.AfuManager.WritingFileMode mode)
 Lists record information of all records in an AFU file to listing window or a specified output file More...
 
unsafe void ListRecordInformation (string afuFileName, int recordIndex, bool listPointData, string outputFileName, NXOpen.CAE.AfuManager.WritingFileMode mode)
 Lists the AFU record information to listing window or a specified output file More...
 
unsafe void RenameRecord (string afuFileName, int recordIndex, string newRecordName)
 Renames an AFU record More...
 
- Public Member Functions inherited from NXOpen.Utilities.NXRemotableObject
IMessageCtrl AsyncProcessMessage (IMessage msg, IMessageSink replySink)
 Asynchronously processes the given message. More...
 
IMessage SyncProcessMessage (IMessage msg)
 Synchronously processes the given message. More...
 

Properties

NXOpen.CAE.AfuDataConvertor AfuDataConvertor [get]
 Contains FFT operations for AFU data More...
 
NXOpen.CAE.AfuDataCreator AfuDataCreator [get]
 Contains Creator for AFU data More...
 
NXOpen.CAE.AfuMathOperation AfuMathOperation [get]
 Contains Math Operations for AFU data More...
 
Tag Tag [get]
 Returns the tag of this object. More...
 
- Properties inherited from NXOpen.Utilities.NXRemotableObject
IMessageSink NextSink [get]
 Gets the next message sink in the sink chain. More...
 

Additional Inherited Members

- Protected Member Functions inherited from NXOpen.Utilities.NXRemotableObject
void initialize ()
 <exclude> 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

This enumeration defines the user requested functions types to be read from the puch file

Enumerator
Displacement 

Displacement

Velocity 

Velocity

Acceleration 

Acceleration

Pressure 

Pressure

This enumeration defines the write modes for 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 
)
inline

Copies multiple AFU records to an AFU file

Created in NX4.0.0

License requirements: None.

Parameters
sourceAfuFileNamesthe AFU files to be copied
recordIndexesIndexes of the AFU records to be copied. Each index Must begin with 1
destinationAfuFileNameDestination AFU file
unsafe NXOpen.CAE.AfuAbscissaHeaderInfo NXOpen.CAE.AfuManager.CreateAfuAbscissaHeaderInfo ( )
inline

Creates an abscissa header information data object of an AFU record

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)
inline

Creates an AFU record data object with specified axis definition

Created in NX9.0.0

License requirements: None.

Parameters
abscissaTypeAbscissa specific data type
Returns
AFU record data
unsafe NXOpen.CAE.AfuHeaderId NXOpen.CAE.AfuManager.CreateAfuHeaderId ( )
inline

Creates a header id object of an AFU record

Created in NX5.0.0

License requirements: None.

Returns
the header id data of an AFU record
unsafe NXOpen.CAE.AfuOrdinateHeaderInfo NXOpen.CAE.AfuManager.CreateAfuOrdinateHeaderInfo ( )
inline

Creates an ordindate header information data object of an AFU record

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 ( )
inline

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

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)
inline

Creates a new empty AFU file

Created in NX4.0.0

License requirements: None.

Parameters
afuFileNameAFU file name
unsafe string NXOpen.CAE.AfuManager.CreateRecord ( NXOpen.CAE.XyFunctionMacroType  macroType,
NXOpen.CAE.XyFunctionGeneralType  dataType,
NXOpen.CAE.AfuData  afuData 
)
inline

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.

Created in NX4.0.0

License requirements: None.

Parameters
macroTypeApplication type of AFU record used
dataTypeUsage type of AFU record used
afuDataAfu record data
Returns
Time stamp string indicates when the record was created
unsafe void NXOpen.CAE.AfuManager.CreateRecord ( NXOpen.CAE.AfuData  afuData)
inline

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

Created in NX5.0.0

License requirements: None.

Parameters
afuDataAfu record data
unsafe void NXOpen.CAE.AfuManager.CreateRecordsFromPunchFile ( string  sourcePchFileNames,
string  destinationAfuFileName,
NXOpen.CAE.AfuManager.RequestedMeasureType[]  requestedFunctions 
)
inline

Creates a AFU records from punch file.

Created in NX1899.0.0

License requirements: None.

Parameters
sourcePchFileNamesSource PCH file
destinationAfuFileNameDestination AFU file
requestedFunctionsRefer JA_AFU_MANAGER_requested_measure_type
unsafe void NXOpen.CAE.AfuManager.DeleteAfuFile ( string  afuFileName)
inline

Deletes an AFU file

Created in NX4.0.0

License requirements: None.

Parameters
afuFileNameAFU file name
unsafe void NXOpen.CAE.AfuManager.DeleteRecords ( string  afuFileName,
int[]  afuRecordIndexes 
)
inline

Deletes multiple AFU records from an AFU file

Created in NX4.0.0

License requirements: None.

Parameters
afuFileNameAFU file name
afuRecordIndexesIndexes of the AFU 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 
)
inline

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.

Created in NX4.0.0

License requirements: None.

Parameters
macroTypeApplication type of AFU record used
dataTypeUsage type of AFU record used
afuRecordIndexIndex of the AFU record in the AFU file. Must begin with 1
afuDataAfu record data
Returns
Time stamp string indicates when the record was last edited
unsafe void NXOpen.CAE.AfuManager.EditRecord ( int  afuRecordIndex,
NXOpen.CAE.AfuData  afuData 
)
inline

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

Created in NX5.0.0

License requirements: None.

Parameters
afuRecordIndexIndex of the AFU record in the AFU file. Must begin with 1
afuDataAfu record data
unsafe void NXOpen.CAE.AfuManager.ExportAfu ( string  afuFileName,
int  recordIndex,
string  exportFileName 
)
inline

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
afuFileNameAFU file name
recordIndexIndex of the AFU record to be exported
exportFileNameThe file name to be exported
unsafe void NXOpen.CAE.AfuManager.ExportAfuFile ( string  afuFileName,
string  exportFileName 
)
inline

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
afuFileNameAFU file name
exportFileNameThe file name to be exported
unsafe string NXOpen.CAE.AfuManager.GetAfuData ( string  afuFileName,
int  recordIndex,
out NXOpen.CAE.AfuData  afuData 
)
inline

Returns the AFU record data

Created in NX4.0.0

License requirements: None.

Parameters
afuFileNameAFU file name
recordIndexIndex of the AFU record in the AFU file. Must begin with 1
afuDataAFU record data
Returns
Time stamp string indicates the last time the AFU record was edited
unsafe string NXOpen.CAE.AfuManager.GetAfuUnitText ( NXOpen.CAE.XyFunctionUnit  unit)
inline

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

Created in NX5.0.0

License requirements: None.

Parameters
unitUnit enumeration
Returns
Unit text
unsafe string NXOpen.CAE.AfuManager.GetAfuUnitTypeText ( NXOpen.CAE.XyFunctionUnit  unit)
inline

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

Created in NX5.0.0

License requirements: None.

Parameters
unitUnit enumeration
Returns
Measure text
unsafe int [] NXOpen.CAE.AfuManager.GetRecordIndexes ( string  afuFileName)
inline

Returns record indices of all records in an AFU file

Created in NX4.0.0

License requirements: None.

Parameters
afuFileNameAFU file name
Returns
Index array of all records in the AFU file.
unsafe void NXOpen.CAE.AfuManager.ImportAfu ( string  importFileName,
string  afuFileName 
)
inline

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
importFileNameThe file name to be imported
afuFileNameAFU file name
unsafe void NXOpen.CAE.AfuManager.ListFileInformation ( string  afuFileName,
bool  listPointData,
string  outputFileName,
NXOpen.CAE.AfuManager.WritingFileMode  mode 
)
inline

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
afuFileNameAFU file name
listPointDataList Control Flag. If true, the record data will be listed. Otherwise only AFU record header information is listed.
outputFileNameOutput file name which the record information is written. If NULL, the information is only outputted to the listing window
modeOutput file write mode: Overwrite or Append, 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 
)
inline

Lists the AFU record information to listing window or a specified output file

Created in NX4.0.0

License requirements: None.

Parameters
afuFileNameAFU file name
recordIndexIndex of the AFU 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 outputted to the listing window.
modeOutput file write mode: Overwrite or Append, only valid when output file name is not NULL.
unsafe void NXOpen.CAE.AfuManager.RenameRecord ( string  afuFileName,
int  recordIndex,
string  newRecordName 
)
inline

Renames an AFU record

Created in NX4.0.0

License requirements: None.

Parameters
afuFileNameAFU file name
recordIndexIndex of the AFU record in the AFU file. Must begin with 1.
newRecordNameNew 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.AfuDataCreator NXOpen.CAE.AfuManager.AfuDataCreator
get

Contains Creator for AFU data

Created in NX1899.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:
Copyright 2019 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.