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.FTK.DataManager Class Reference

Ftk data manager More...

Inheritance diagram for NXOpen.CAE.FTK.DataManager:
NXOpen.Utilities.NXRemotableObject IMessageSink

Public Types

enum  AfuRecordZValue {
  SelectionOrder, General, Rpm, Time,
  Order
}
 Represents the method to get Z value for afu record in 3D plot More...
 
enum  FileContainerType {
  None, AssociatedContainer, ResultContainer, UserContainer,
  All
}
 Represents the file container type More...
 

Public Member Functions

unsafe NXOpen.CAE.FTK.ArrayRecord2D CreateArrayRecord2d (string titleName, string legendName, int numPoints)
 Creates 2d array record More...
 
unsafe
NXOpen.CAE.FTK.ArrayRecord2DEven 
CreateArrayRecord2dEvenSpacing (string titleName, string legendName)
 Creates 2d array record with even spacing More...
 
unsafe NXOpen.CAE.FTK.ArrayRecord3D CreateArrayRecord3d (string titleName, string legendName, int numPoints)
 Creates 3d array record More...
 
unsafe NXOpen.CAE.FTK.BaseUnit CreateArrayRecordUnit (NXOpen.CAE.XyFunctionUnit unitType)
 Creates an array record unit by xy function unit More...
 
unsafe NXOpen.CAE.FTK.BaseUnit CreateArrayUnit (NXOpen.Unit nxUnit)
 Creates array unit by nx system unit More...
 
unsafe NXOpen.CAE.FTK.BaseUnit CreateArrayUnit (NXOpen.Unit nxUnit, string aliasMeasureName)
 Creates array unit by NX unit with new alias measure type name. More...
 
unsafe NXOpen.CAE.FTK.BaseUnit CreateArrayUnit (NXOpen.Unit nxUnit, string aliasMeasureName, string localizedAliasMeasureName)
 Creates the object NXOpen.CAE.FTK.BaseUnit by NXOpen.Unit with alias measure name and localized alias measure name. More...
 
unsafe NXOpen.CAE.FTK.BaseUnit CreateArrayUnit (NXOpen.CAE.FTK.BaseUnit numeratorUnit, NXOpen.CAE.FTK.BaseUnit denominatorUnit)
 Creates array unit by numerator and denominator unit More...
 
unsafe
NXOpen.CAE.FTK.ComplexSectionBasedMatrixRecord 
CreateComplexMatrixRecord (string titleName, string legendName)
 Creates an empty complex matrix record which section data is complex data. More...
 
unsafe
NXOpen.CAE.FTK.MatrixPlotRecord 
CreateMatrixPlotRecord (string titleName, string legendName)
 Creates an empty record for matrix plot. More...
 
unsafe
NXOpen.CAE.FTK.RealSectionBasedMatrixRecord 
CreateRealMatrixRecord (string titleName, string legendName)
 Creates an empty real matrix record which section data is real data. More...
 
unsafe NXOpen.CAE.FTK.BaseUnit CreateUnitlessUnit (string measureName)
 Creates unitless unit More...
 
unsafe NXOpen.CAE.FTK.BaseUnit CreateUnitlessUnit (string measureName, string localizedMeasureName)
 Creates unitless unit More...
 
unsafe void DeleteArrayUnit (NXOpen.CAE.FTK.BaseUnit deletedUnit)
 Deletes array unit More...
 
unsafe void DeleteFile (string fileName)
 Deletes afu/op2 file More...
 
unsafe void DeleteRecord (NXOpen.CAE.FTK.BaseRecord deletedRecord)
 Deletes record More...
 
unsafe NXOpen.CAE.FTK.BaseRecord GetAfuRecord (string afuFileName, string recordName)
 Gets afu record More...
 
unsafe NXOpen.CAE.FTK.BaseRecord GetOp2Record (string op2FileName, string dataSetName, string recordName)
 Gets op2 record More...
 
unsafe void LoadFile (string fileName)
 Loads afu/op2 file to User container More...
 
unsafe void LoadFile (string fileName, NXOpen.CAE.FTK.DataManager.FileContainerType containerType)
 Loads an AFU/OP2 file to the specified container. More...
 
unsafe void UnloadFile (string fileName)
 Unloads afu/op2 file from User container More...
 
unsafe void UnloadFile (string fileName, NXOpen.CAE.FTK.DataManager.FileContainerType containerType)
 Unloads an AFU/OP2 file from the specified container. 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.FTK.AfuFileManager AfuFileManager [get]
 Returns the NXOpen.CAE.FTK.AfuFileManager belonging to FTK data manager More...
 
NXOpen.CAE.FTK.Op2FileManager Op2FileManager [get]
 Returns the NXOpen.CAE.FTK.Op2FileManager belonging to FTK data manager 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

Ftk data manager

To obtain an instance of this class use NXOpen.Session.DataManager .

Created in NX7.5.0

Member Enumeration Documentation

Represents the method to get Z value for afu record in 3D plot

Enumerator
SelectionOrder 

The Z value is selection order

General 

The Z value is attribute of General field in an afu record

Rpm 

The z value is attribute of RPM field in an afu record

Time 

The z value is attribute of Time field in an afu record

Order 

The z value is attribute of Order field in an afu record

Represents the file container type

Enumerator
None 

Not any container

AssociatedContainer 

Part associated container which has the same simple name with the part

ResultContainer 

Solution result container which has the same name with the solution

UserContainer 

User container

All 

All containers

Member Function Documentation

unsafe NXOpen.CAE.FTK.ArrayRecord2D NXOpen.CAE.FTK.DataManager.CreateArrayRecord2d ( string  titleName,
string  legendName,
int  numPoints 
)
inline

Creates 2d array record

Created in NX7.5.0

License requirements: None.

Parameters
titleNameTitle name
legendNameLegend name
numPointsPoint count
Returns
2D array record
unsafe NXOpen.CAE.FTK.ArrayRecord2DEven NXOpen.CAE.FTK.DataManager.CreateArrayRecord2dEvenSpacing ( string  titleName,
string  legendName 
)
inline

Creates 2d array record with even spacing

Created in NX9.0.0

License requirements: None.

Parameters
titleNameTitle name
legendNameLegend name
Returns
2D even array record
unsafe NXOpen.CAE.FTK.ArrayRecord3D NXOpen.CAE.FTK.DataManager.CreateArrayRecord3d ( string  titleName,
string  legendName,
int  numPoints 
)
inline

Creates 3d array record

Created in NX7.5.0

License requirements: None.

Parameters
titleNameTitle name
legendNameLegend name
numPointsPoint count
Returns
3D array record
unsafe NXOpen.CAE.FTK.BaseUnit NXOpen.CAE.FTK.DataManager.CreateArrayRecordUnit ( NXOpen.CAE.XyFunctionUnit  unitType)
inline

Creates an array record unit by xy function unit

Created in NX11.0.0

Deprecated in NX12.0.0. Use NXOpen.CAE.FTK.DataManager.CreateArrayUnit instead.

License requirements: None.

Parameters
unitTypeUnit type
Returns
Array unit
unsafe NXOpen.CAE.FTK.BaseUnit NXOpen.CAE.FTK.DataManager.CreateArrayUnit ( NXOpen.Unit  nxUnit)
inline

Creates array unit by nx system unit

Created in NX7.5.0

License requirements: None.

Parameters
nxUnitNX system unit
Returns
Array unit
unsafe NXOpen.CAE.FTK.BaseUnit NXOpen.CAE.FTK.DataManager.CreateArrayUnit ( NXOpen.Unit  nxUnit,
string  aliasMeasureName 
)
inline

Creates array unit by NX unit with new alias measure type name.

Please use the method NXOpen.CAE.FTK.DataManager.CreateArrayUnit which has two parameters if the alias measure name is not needed

Created in NX12.0.0

Deprecated in NX1847.0.0. Use NXOpen.CAE.FTK.DataManager.CreateArrayUnit which has four argumetns instead.

License requirements: None.

Parameters
nxUnit
aliasMeasureName
Returns
unsafe NXOpen.CAE.FTK.BaseUnit NXOpen.CAE.FTK.DataManager.CreateArrayUnit ( NXOpen.Unit  nxUnit,
string  aliasMeasureName,
string  localizedAliasMeasureName 
)
inline

Creates the object NXOpen.CAE.FTK.BaseUnit by NXOpen.Unit with alias measure name and localized alias measure name.

Please use the method NXOpen.CAE.FTK.DataManager.CreateArrayUnit which has two arguments if alias measure name is not needed.

Created in NX1847.0.0

License requirements: None.

Parameters
nxUnit
aliasMeasureName
localizedAliasMeasureName
Returns
unsafe NXOpen.CAE.FTK.BaseUnit NXOpen.CAE.FTK.DataManager.CreateArrayUnit ( NXOpen.CAE.FTK.BaseUnit  numeratorUnit,
NXOpen.CAE.FTK.BaseUnit  denominatorUnit 
)
inline

Creates array unit by numerator and denominator unit

Created in NX7.5.0

License requirements: None.

Parameters
numeratorUnitNumerator unit
denominatorUnitDenominator unit
Returns
Array unit
unsafe NXOpen.CAE.FTK.ComplexSectionBasedMatrixRecord NXOpen.CAE.FTK.DataManager.CreateComplexMatrixRecord ( string  titleName,
string  legendName 
)
inline

Creates an empty complex matrix record which section data is complex data.

Created in NX10.0.0

License requirements: None.

Parameters
titleNameTitle name
legendNameLegend name
Returns
Complex matrix record
unsafe NXOpen.CAE.FTK.MatrixPlotRecord NXOpen.CAE.FTK.DataManager.CreateMatrixPlotRecord ( string  titleName,
string  legendName 
)
inline

Creates an empty record for matrix plot.

Created in NX1847.0.0

License requirements: None.

Parameters
titleName
legendName
Returns
unsafe NXOpen.CAE.FTK.RealSectionBasedMatrixRecord NXOpen.CAE.FTK.DataManager.CreateRealMatrixRecord ( string  titleName,
string  legendName 
)
inline

Creates an empty real matrix record which section data is real data.

Created in NX10.0.0

License requirements: None.

Parameters
titleNameTitle name
legendNameLegend name
Returns
Real matrix record
unsafe NXOpen.CAE.FTK.BaseUnit NXOpen.CAE.FTK.DataManager.CreateUnitlessUnit ( string  measureName)
inline

Creates unitless unit

Created in NX12.0.0

Deprecated in NX1847.0.0. Use NXOpen.CAE.FTK.DataManager.CreateUnitlessUnit which has three argumetns instead.

License requirements: None.

Parameters
measureName
Returns
unsafe NXOpen.CAE.FTK.BaseUnit NXOpen.CAE.FTK.DataManager.CreateUnitlessUnit ( string  measureName,
string  localizedMeasureName 
)
inline

Creates unitless unit

Created in NX1847.0.0

License requirements: None.

Parameters
measureName
localizedMeasureName
Returns
unsafe void NXOpen.CAE.FTK.DataManager.DeleteArrayUnit ( NXOpen.CAE.FTK.BaseUnit  deletedUnit)
inline

Deletes array unit

Created in NX9.0.0

License requirements: None.

Parameters
deletedUnitDeleted unit
unsafe void NXOpen.CAE.FTK.DataManager.DeleteFile ( string  fileName)
inline

Deletes afu/op2 file

Created in NX7.5.0

Deprecated in NX12.0.1. Use CAE.FTK.AfuFileManager.DeleteFile instead when deleting an AFU file; Use CAE.FTK.Op2FileManager.DeleteFile instead when deleting an OP2 file.

License requirements: None.

Parameters
fileNameAfu/Op2 file name with full path
unsafe void NXOpen.CAE.FTK.DataManager.DeleteRecord ( NXOpen.CAE.FTK.BaseRecord  deletedRecord)
inline

Deletes record

Created in NX7.5.0

License requirements: None.

Parameters
deletedRecordDeleted record
unsafe NXOpen.CAE.FTK.BaseRecord NXOpen.CAE.FTK.DataManager.GetAfuRecord ( string  afuFileName,
string  recordName 
)
inline

Gets afu record

Created in NX7.5.0

Deprecated in NX12.0.1. Use CAE.FTK.AfuFileManager.GetRecord instead

License requirements: None.

Parameters
afuFileNameAfu file name with full path
recordNameAfu record name
Returns
Afu record data
unsafe NXOpen.CAE.FTK.BaseRecord NXOpen.CAE.FTK.DataManager.GetOp2Record ( string  op2FileName,
string  dataSetName,
string  recordName 
)
inline

Gets op2 record

Created in NX7.5.0

Deprecated in NX12.0.1. Use CAE.FTK.Op2FileManager.GetRecord instead

License requirements: None.

Parameters
op2FileNameOp2 file name with full path
dataSetNameOp2 data set name
recordNameOp2 record name
Returns
Op2 record data
unsafe void NXOpen.CAE.FTK.DataManager.LoadFile ( string  fileName)
inline

Loads afu/op2 file to User container

Created in NX7.5.0

Deprecated in NX12.0.1. Use CAE.FTK.AfuFileManager.LoadFile instead when loading an AFU file; Use CAE.FTK.Op2FileManager.LoadFile instead when loading an OP2 file.

License requirements: None.

Parameters
fileNameAfu/Op2 file name with full path
unsafe void NXOpen.CAE.FTK.DataManager.LoadFile ( string  fileName,
NXOpen.CAE.FTK.DataManager.FileContainerType  containerType 
)
inline

Loads an AFU/OP2 file to the specified container.

An AFU/OP2 file can be loaded under associated container, solution result container or user container. The container type indicates under which container the file is loaded.

Created in NX12.0.0

Deprecated in NX12.0.1. Use CAE.FTK.AfuFileManager.LoadFile instead when loading an AFU file; Use CAE.FTK.Op2FileManager.LoadFile instead when loading an OP2 file.

License requirements: None.

Parameters
fileNameAFU/OP2 file name with full path
containerType
unsafe void NXOpen.CAE.FTK.DataManager.UnloadFile ( string  fileName)
inline

Unloads afu/op2 file from User container

Created in NX7.5.0

Deprecated in NX12.0.1. Use CAE.FTK.AfuFileManager.UnloadFile instead when unloading an AFU file; Use CAE.FTK.Op2FileManager.UnloadFile instead when unloading an OP2 file.

License requirements: None.

Parameters
fileNameAfu/Op2 file name with full path
unsafe void NXOpen.CAE.FTK.DataManager.UnloadFile ( string  fileName,
NXOpen.CAE.FTK.DataManager.FileContainerType  containerType 
)
inline

Unloads an AFU/OP2 file from the specified container.

An AFU/OP2 file can be loaded under associated container, solution result container or user container. The container type indicates under which container the file is unloaded.

Created in NX12.0.0

Deprecated in NX12.0.1. Use CAE.FTK.AfuFileManager.UnloadFile instead when unloading an AFU file; Use CAE.FTK.Op2FileManager.UnloadFile instead when unloading an OP2 file.

License requirements: None.

Parameters
fileNameAFU/OP2 file name with full path
containerType

Property Documentation

NXOpen.CAE.FTK.AfuFileManager NXOpen.CAE.FTK.DataManager.AfuFileManager
get

Returns the NXOpen.CAE.FTK.AfuFileManager belonging to FTK data manager

Created in NX12.0.1

NXOpen.CAE.FTK.Op2FileManager NXOpen.CAE.FTK.DataManager.Op2FileManager
get

Returns the NXOpen.CAE.FTK.Op2FileManager belonging to FTK data manager

Created in NX12.0.1

Tag NXOpen.CAE.FTK.DataManager.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.