NX Open C++ Reference Guide
Public Types | Public Member Functions | List of all members
NXOpen::CAE::FTK::DataManager Class Reference

Ftk data manager
To obtain an instance of this class use NXOpen::Session::DataManager . More...

Public Types

enum  AfuRecordZValue {
  AfuRecordZValueSelectionOrder, AfuRecordZValueGeneral, AfuRecordZValueRpm, AfuRecordZValueTime,
  AfuRecordZValueOrder
}
 Represents the method to get Z value for afu record in 3D plot. More...
 
enum  FileContainerType {
  FileContainerTypeNone, FileContainerTypeAssociatedContainer, FileContainerTypeResultContainer, FileContainerTypeUserContainer,
  FileContainerTypeAll
}
 Represents the file container type. More...
 

Public Member Functions

NXOpen::CAE::FTK::ArrayRecord2DCreateArrayRecord2d (const NXString &titleName, const NXString &legendName, int numPoints)
 Creates 2d array record. More...
 
NXOpen::CAE::FTK::ArrayRecord2DCreateArrayRecord2d (const char *titleName, const char *legendName, int numPoints)
 Creates 2d array record. More...
 
NXOpen::CAE::FTK::ArrayRecord2DEvenCreateArrayRecord2dEvenSpacing (const NXString &titleName, const NXString &legendName)
 Creates 2d array record with even spacing. More...
 
NXOpen::CAE::FTK::ArrayRecord2DEvenCreateArrayRecord2dEvenSpacing (const char *titleName, const char *legendName)
 Creates 2d array record with even spacing. More...
 
NXOpen::CAE::FTK::ArrayRecord3DCreateArrayRecord3d (const NXString &titleName, const NXString &legendName, int numPoints)
 Creates 3d array record. More...
 
NXOpen::CAE::FTK::ArrayRecord3DCreateArrayRecord3d (const char *titleName, const char *legendName, int numPoints)
 Creates 3d array record. More...
 
NXOpen::CAE::FTK::BaseUnitCreateArrayRecordUnit (NXOpen::CAE::XyFunctionUnit unitType)
 Creates an array record unit by xy function unit. More...
 
NXOpen::CAE::FTK::BaseUnitCreateArrayUnit (NXOpen::Unit *nxUnit)
 Creates array unit by nx system unit. More...
 
NXOpen::CAE::FTK::BaseUnitCreateArrayUnit (NXOpen::CAE::XyFunctionMeasure measureType, NXOpen::CAE::XyFunctionUnit unitType)
 Creates array unit by xy function unit. More...
 
NXOpen::CAE::FTK::BaseUnitCreateArrayUnit (NXOpen::Unit *nxUnit, const NXString &aliasMeasureName)
 Creates array unit by NX unit with new alias measure type name. More...
 
NXOpen::CAE::FTK::BaseUnitCreateArrayUnit (NXOpen::Unit *nxUnit, const char *aliasMeasureName)
 Creates array unit by NX unit with new alias measure type name. More...
 
NXOpen::CAE::FTK::BaseUnitCreateArrayUnit (NXOpen::CAE::FTK::BaseUnit *numeratorUnit, NXOpen::CAE::FTK::BaseUnit *denominatorUnit)
 Creates array unit by numerator and denominator unit. More...
 
NXOpen::CAE::FTK::ComplexSectionBasedMatrixRecordCreateComplexMatrixRecord (const NXString &titleName, const NXString &legendName)
 Creates an empty complex matrix record which section data is complex data. More...
 
NXOpen::CAE::FTK::ComplexSectionBasedMatrixRecordCreateComplexMatrixRecord (const char *titleName, const char *legendName)
 Creates an empty complex matrix record which section data is complex data. More...
 
NXOpen::CAE::FTK::RealSectionBasedMatrixRecordCreateRealMatrixRecord (const NXString &titleName, const NXString &legendName)
 Creates an empty real matrix record which section data is real data. More...
 
NXOpen::CAE::FTK::RealSectionBasedMatrixRecordCreateRealMatrixRecord (const char *titleName, const char *legendName)
 Creates an empty real matrix record which section data is real data. More...
 
NXOpen::CAE::FTK::BaseUnitCreateUnitlessUnit (const NXString &unitName)
 Creates unitless unit. More...
 
NXOpen::CAE::FTK::BaseUnitCreateUnitlessUnit (const char *unitName)
 Creates unitless unit. More...
 
void DeleteArrayUnit (NXOpen::CAE::FTK::BaseUnit *deletedUnit)
 Deletes array unit
Created in NX9.0.0. More...
 
void DeleteFile (const NXString &fileName)
 Deletes afu/op2 file
Created in NX7.5.0. More...
 
void DeleteFile (const char *fileName)
 Deletes afu/op2 file
Created in NX7.5.0. More...
 
void DeleteRecord (NXOpen::CAE::FTK::BaseRecord *deletedRecord)
 Deletes record
Created in NX7.5.0. More...
 
NXOpen::CAE::FTK::BaseRecordGetAfuRecord (const NXString &afuFileName, const NXString &recordName)
 Gets afu record. More...
 
NXOpen::CAE::FTK::BaseRecordGetAfuRecord (const char *afuFileName, const char *recordName)
 Gets afu record. More...
 
NXOpen::CAE::FTK::BaseRecordGetOp2Record (const NXString &op2FileName, const NXString &dataSetName, const NXString &recordName)
 Gets op2 record. More...
 
NXOpen::CAE::FTK::BaseRecordGetOp2Record (const char *op2FileName, const char *dataSetName, const char *recordName)
 Gets op2 record. More...
 
void LoadFile (const NXString &fileName)
 Loads afu/op2 file to User container
Created in NX7.5.0. More...
 
void LoadFile (const char *fileName)
 Loads afu/op2 file to User container
Created in NX7.5.0. More...
 
void LoadFile (const NXString &fileName, NXOpen::CAE::FTK::DataManager::FileContainerType containerType)
 Loads an AFU/OP2 file to the specified container. More...
 
void LoadFile (const char *fileName, NXOpen::CAE::FTK::DataManager::FileContainerType containerType)
 Loads an AFU/OP2 file to the specified container. More...
 
tag_t Tag () const
 Returns the tag of this object. More...
 
void UnloadFile (const NXString &fileName)
 Unloads afu/op2 file from User container
Created in NX7.5.0. More...
 
void UnloadFile (const char *fileName)
 Unloads afu/op2 file from User container
Created in NX7.5.0. More...
 
void UnloadFile (const NXString &fileName, NXOpen::CAE::FTK::DataManager::FileContainerType containerType)
 Unloads an AFU/OP2 file from the specified container. More...
 
void UnloadFile (const char *fileName, NXOpen::CAE::FTK::DataManager::FileContainerType containerType)
 Unloads an AFU/OP2 file from the specified container. 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
AfuRecordZValueSelectionOrder 

The Z value is selection order.

AfuRecordZValueGeneral 

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

AfuRecordZValueRpm 

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

AfuRecordZValueTime 

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

AfuRecordZValueOrder 

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

Represents the file container type.

Enumerator
FileContainerTypeNone 

Not any container.

FileContainerTypeAssociatedContainer 

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

FileContainerTypeResultContainer 

Solution result container which has the same name with the solution.

FileContainerTypeUserContainer 

User container.

FileContainerTypeAll 

All containers.

Member Function Documentation

NXOpen::CAE::FTK::ArrayRecord2D* NXOpen::CAE::FTK::DataManager::CreateArrayRecord2d ( const NXString titleName,
const NXString legendName,
int  numPoints 
)

Creates 2d array record.

Returns
2D array record
Created in NX7.5.0.

License requirements : None
Parameters
titleNameTitle name
legendNameLegend name
numPointsPoint count
NXOpen::CAE::FTK::ArrayRecord2D* NXOpen::CAE::FTK::DataManager::CreateArrayRecord2d ( const char *  titleName,
const char *  legendName,
int  numPoints 
)

Creates 2d array record.

Returns
2D array record
Created in NX7.5.0.

License requirements : None
Parameters
titleNameTitle name
legendNameLegend name
numPointsPoint count
NXOpen::CAE::FTK::ArrayRecord2DEven* NXOpen::CAE::FTK::DataManager::CreateArrayRecord2dEvenSpacing ( const NXString titleName,
const NXString legendName 
)

Creates 2d array record with even spacing.

Returns
2D even array record
Created in NX9.0.0.

License requirements : None
Parameters
titleNameTitle name
legendNameLegend name
NXOpen::CAE::FTK::ArrayRecord2DEven* NXOpen::CAE::FTK::DataManager::CreateArrayRecord2dEvenSpacing ( const char *  titleName,
const char *  legendName 
)

Creates 2d array record with even spacing.

Returns
2D even array record
Created in NX9.0.0.

License requirements : None
Parameters
titleNameTitle name
legendNameLegend name
NXOpen::CAE::FTK::ArrayRecord3D* NXOpen::CAE::FTK::DataManager::CreateArrayRecord3d ( const NXString titleName,
const NXString legendName,
int  numPoints 
)

Creates 3d array record.

Returns
3D array record
Created in NX7.5.0.

License requirements : None
Parameters
titleNameTitle name
legendNameLegend name
numPointsPoint count
NXOpen::CAE::FTK::ArrayRecord3D* NXOpen::CAE::FTK::DataManager::CreateArrayRecord3d ( const char *  titleName,
const char *  legendName,
int  numPoints 
)

Creates 3d array record.

Returns
3D array record
Created in NX7.5.0.

License requirements : None
Parameters
titleNameTitle name
legendNameLegend name
numPointsPoint count
NXOpen::CAE::FTK::BaseUnit* NXOpen::CAE::FTK::DataManager::CreateArrayRecordUnit ( NXOpen::CAE::XyFunctionUnit  unitType)

Creates an array record unit by xy function unit.

Returns
Array unit
Deprecated:
Deprecated in NX12.0.0. Use NXOpen::CAE::FTK::DataManager::CreateArrayUnit instead.


Created in NX11.0.0.

License requirements : None

Parameters
unitTypeUnit type
NXOpen::CAE::FTK::BaseUnit* NXOpen::CAE::FTK::DataManager::CreateArrayUnit ( NXOpen::Unit nxUnit)

Creates array unit by nx system unit.

Returns
Array unit
Created in NX7.5.0.

License requirements : None
Parameters
nxUnitNX system unit
NXOpen::CAE::FTK::BaseUnit* NXOpen::CAE::FTK::DataManager::CreateArrayUnit ( NXOpen::CAE::XyFunctionMeasure  measureType,
NXOpen::CAE::XyFunctionUnit  unitType 
)

Creates array unit by xy function unit.

Returns
Array unit
Deprecated:
Deprecated in NX11.0.0. Use NXOpen::CAE::FTK::DataManager::CreateArrayUnit instead.


Created in NX7.5.0.

License requirements : None

Parameters
measureTypeUnit measure type
unitTypeUnit type
NXOpen::CAE::FTK::BaseUnit* NXOpen::CAE::FTK::DataManager::CreateArrayUnit ( NXOpen::Unit nxUnit,
const NXString aliasMeasureName 
)

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

Returns
Array unit
Created in NX12.0.0.

License requirements : None
Parameters
nxUnitNX unit
aliasMeasureNamealias measure name
NXOpen::CAE::FTK::BaseUnit* NXOpen::CAE::FTK::DataManager::CreateArrayUnit ( NXOpen::Unit nxUnit,
const char *  aliasMeasureName 
)

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

Returns
Array unit
Created in NX12.0.0.

License requirements : None
Parameters
nxUnitNX unit
aliasMeasureNamealias measure name
NXOpen::CAE::FTK::BaseUnit* NXOpen::CAE::FTK::DataManager::CreateArrayUnit ( NXOpen::CAE::FTK::BaseUnit numeratorUnit,
NXOpen::CAE::FTK::BaseUnit denominatorUnit 
)

Creates array unit by numerator and denominator unit.

Returns
Array unit
Created in NX7.5.0.

License requirements : None
Parameters
numeratorUnitNumerator unit
denominatorUnitDenominator unit
NXOpen::CAE::FTK::ComplexSectionBasedMatrixRecord* NXOpen::CAE::FTK::DataManager::CreateComplexMatrixRecord ( const NXString titleName,
const NXString legendName 
)

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

Returns
Complex matrix record
Created in NX10.0.0.

License requirements : None
Parameters
titleNameTitle name
legendNameLegend name
NXOpen::CAE::FTK::ComplexSectionBasedMatrixRecord* NXOpen::CAE::FTK::DataManager::CreateComplexMatrixRecord ( const char *  titleName,
const char *  legendName 
)

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

Returns
Complex matrix record
Created in NX10.0.0.

License requirements : None
Parameters
titleNameTitle name
legendNameLegend name
NXOpen::CAE::FTK::RealSectionBasedMatrixRecord* NXOpen::CAE::FTK::DataManager::CreateRealMatrixRecord ( const NXString titleName,
const NXString legendName 
)

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

Returns
Real matrix record
Created in NX10.0.0.

License requirements : None
Parameters
titleNameTitle name
legendNameLegend name
NXOpen::CAE::FTK::RealSectionBasedMatrixRecord* NXOpen::CAE::FTK::DataManager::CreateRealMatrixRecord ( const char *  titleName,
const char *  legendName 
)

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

Returns
Real matrix record
Created in NX10.0.0.

License requirements : None
Parameters
titleNameTitle name
legendNameLegend name
NXOpen::CAE::FTK::BaseUnit* NXOpen::CAE::FTK::DataManager::CreateUnitlessUnit ( const NXString unitName)

Creates unitless unit.

Returns
Array unit
Created in NX12.0.0.

License requirements : None
Parameters
unitNameUnit name
NXOpen::CAE::FTK::BaseUnit* NXOpen::CAE::FTK::DataManager::CreateUnitlessUnit ( const char *  unitName)

Creates unitless unit.

Returns
Array unit
Created in NX12.0.0.

License requirements : None
Parameters
unitNameUnit name
void NXOpen::CAE::FTK::DataManager::DeleteArrayUnit ( NXOpen::CAE::FTK::BaseUnit deletedUnit)

Deletes array unit
Created in NX9.0.0.



License requirements : None

Parameters
deletedUnitDeleted unit
void NXOpen::CAE::FTK::DataManager::DeleteFile ( const NXString fileName)

Deletes afu/op2 file
Created in NX7.5.0.



License requirements : None

Parameters
fileNameAfu/Op2 file name with full path
void NXOpen::CAE::FTK::DataManager::DeleteFile ( const char *  fileName)

Deletes afu/op2 file
Created in NX7.5.0.



License requirements : None

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

Deletes record
Created in NX7.5.0.



License requirements : None

Parameters
deletedRecordDeleted record
NXOpen::CAE::FTK::BaseRecord* NXOpen::CAE::FTK::DataManager::GetAfuRecord ( const NXString afuFileName,
const NXString recordName 
)

Gets afu record.

Returns
Afu record data
Created in NX7.5.0.

License requirements : None
Parameters
afuFileNameAfu file name with full path
recordNameAfu record name
NXOpen::CAE::FTK::BaseRecord* NXOpen::CAE::FTK::DataManager::GetAfuRecord ( const char *  afuFileName,
const char *  recordName 
)

Gets afu record.

Returns
Afu record data
Created in NX7.5.0.

License requirements : None
Parameters
afuFileNameAfu file name with full path
recordNameAfu record name
NXOpen::CAE::FTK::BaseRecord* NXOpen::CAE::FTK::DataManager::GetOp2Record ( const NXString op2FileName,
const NXString dataSetName,
const NXString recordName 
)

Gets op2 record.

Returns
Op2 record data
Created in NX7.5.0.

License requirements : None
Parameters
op2FileNameOp2 file name with full path
dataSetNameOp2 data set name
recordNameOp2 record name
NXOpen::CAE::FTK::BaseRecord* NXOpen::CAE::FTK::DataManager::GetOp2Record ( const char *  op2FileName,
const char *  dataSetName,
const char *  recordName 
)

Gets op2 record.

Returns
Op2 record data
Created in NX7.5.0.

License requirements : None
Parameters
op2FileNameOp2 file name with full path
dataSetNameOp2 data set name
recordNameOp2 record name
void NXOpen::CAE::FTK::DataManager::LoadFile ( const NXString fileName)

Loads afu/op2 file to User container
Created in NX7.5.0.



License requirements : None

Parameters
fileNameAfu/Op2 file name with full path
void NXOpen::CAE::FTK::DataManager::LoadFile ( const char *  fileName)

Loads afu/op2 file to User container
Created in NX7.5.0.



License requirements : None

Parameters
fileNameAfu/Op2 file name with full path
void NXOpen::CAE::FTK::DataManager::LoadFile ( const NXString fileName,
NXOpen::CAE::FTK::DataManager::FileContainerType  containerType 
)

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.

License requirements : None

Parameters
fileNameAFU/OP2 file name with full path
containerTypecontainertype
void NXOpen::CAE::FTK::DataManager::LoadFile ( const char *  fileName,
NXOpen::CAE::FTK::DataManager::FileContainerType  containerType 
)

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.

License requirements : None

Parameters
fileNameAFU/OP2 file name with full path
containerTypecontainertype
tag_t NXOpen::CAE::FTK::DataManager::Tag ( ) const

Returns the tag of this object.

void NXOpen::CAE::FTK::DataManager::UnloadFile ( const NXString fileName)

Unloads afu/op2 file from User container
Created in NX7.5.0.



License requirements : None

Parameters
fileNameAfu/Op2 file name with full path
void NXOpen::CAE::FTK::DataManager::UnloadFile ( const char *  fileName)

Unloads afu/op2 file from User container
Created in NX7.5.0.



License requirements : None

Parameters
fileNameAfu/Op2 file name with full path
void NXOpen::CAE::FTK::DataManager::UnloadFile ( const NXString fileName,
NXOpen::CAE::FTK::DataManager::FileContainerType  containerType 
)

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.

License requirements : None

Parameters
fileNameAFU/OP2 file name with full path
containerTypecontainertype
void NXOpen::CAE::FTK::DataManager::UnloadFile ( const char *  fileName,
NXOpen::CAE::FTK::DataManager::FileContainerType  containerType 
)

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.

License requirements : None

Parameters
fileNameAFU/OP2 file name with full path
containerTypecontainertype

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