NXOpen C++ Reference Guide
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Pages
Public Member Functions | List of all members
NXOpen::CAE::FTK::Op2FileManager Class Reference

Provides methods to query the loaded OP2 files. More...

Public Member Functions

void DeleteFile (const NXString &op2FileName)
 Deletes an OP2 file
Created in NX12.0.1. More...
 
void DeleteFile (const char *op2FileName)
 Deletes an OP2 file
Created in NX12.0.1. More...
 
std::vector< NXStringGetAllDatasetNamesInFile (const NXString &op2FileName)
 Gets all dataset names in an OP2 file which must be loaded
Created in NX12.0.1. More...
 
std::vector< NXStringGetAllDatasetNamesInFile (const char *op2FileName)
 Gets all dataset names in an OP2 file which must be loaded
Created in NX12.0.1. More...
 
std::vector< NXStringGetAllRecordNamesInDataset (const NXString &op2FileName, const NXString &datasetName)
 Gets all record names in an OP2 dataset of an OP2 file which must be loaded
Created in NX12.0.1. More...
 
std::vector< NXStringGetAllRecordNamesInDataset (const char *op2FileName, const char *datasetName)
 Gets all record names in an OP2 dataset of an OP2 file which must be loaded
Created in NX12.0.1. More...
 
std::vector< NXStringGetLoadedFiles ()
 Gets all loaded OP2 files
Created in NX12.0.1. More...
 
NXOpen::CAE::FTK::Op2RecordGetRecord (const NXString &op2FileName, const NXString &datasetName, const NXString &recordName)
 Gets an OP2 record in an OP2 dataset of an OP2 file which must be loaded
Created in NX12.0.1. More...
 
NXOpen::CAE::FTK::Op2RecordGetRecord (const char *op2FileName, const char *datasetName, const char *recordName)
 Gets an OP2 record in an OP2 dataset of an OP2 file which must be loaded
Created in NX12.0.1. More...
 
void LoadFile (const NXString &op2FileName, NXOpen::CAE::FTK::DataManager::FileContainerType containerType)
 Loads an OP2 file to the specified container. More...
 
void LoadFile (const char *op2FileName, NXOpen::CAE::FTK::DataManager::FileContainerType containerType)
 Loads an OP2 file to the specified container. More...
 
tag_t Tag () const
 Returns the tag of this object. More...
 
void UnloadFile (const NXString &op2FileName, NXOpen::CAE::FTK::DataManager::FileContainerType containerType)
 Unloads an OP2 file from the specified container. More...
 
void UnloadFile (const char *op2FileName, NXOpen::CAE::FTK::DataManager::FileContainerType containerType)
 Unloads an OP2 file from the specified container. More...
 

Detailed Description

Provides methods to query the loaded OP2 files.


To obtain an instance of this class use NXOpen::CAE::FTK::DataManager::Op2FileManager .

Created in NX12.0.1.

Member Function Documentation

void NXOpen::CAE::FTK::Op2FileManager::DeleteFile ( const NXString op2FileName)

Deletes an OP2 file
Created in NX12.0.1.



License requirements : None

Parameters
op2FileNameop2filename
void NXOpen::CAE::FTK::Op2FileManager::DeleteFile ( const char *  op2FileName)

Deletes an OP2 file
Created in NX12.0.1.



License requirements : None

Parameters
op2FileNameop2filename
std::vector<NXString> NXOpen::CAE::FTK::Op2FileManager::GetAllDatasetNamesInFile ( const NXString op2FileName)

Gets all dataset names in an OP2 file which must be loaded
Created in NX12.0.1.



License requirements : None

Parameters
op2FileNameop2filename
std::vector<NXString> NXOpen::CAE::FTK::Op2FileManager::GetAllDatasetNamesInFile ( const char *  op2FileName)

Gets all dataset names in an OP2 file which must be loaded
Created in NX12.0.1.



License requirements : None

Parameters
op2FileNameop2filename
std::vector<NXString> NXOpen::CAE::FTK::Op2FileManager::GetAllRecordNamesInDataset ( const NXString op2FileName,
const NXString datasetName 
)

Gets all record names in an OP2 dataset of an OP2 file which must be loaded
Created in NX12.0.1.



License requirements : None

Parameters
op2FileNameop2filename
datasetNamedatasetname
std::vector<NXString> NXOpen::CAE::FTK::Op2FileManager::GetAllRecordNamesInDataset ( const char *  op2FileName,
const char *  datasetName 
)

Gets all record names in an OP2 dataset of an OP2 file which must be loaded
Created in NX12.0.1.



License requirements : None

Parameters
op2FileNameop2filename
datasetNamedatasetname
std::vector<NXString> NXOpen::CAE::FTK::Op2FileManager::GetLoadedFiles ( )

Gets all loaded OP2 files
Created in NX12.0.1.



License requirements : None

NXOpen::CAE::FTK::Op2Record* NXOpen::CAE::FTK::Op2FileManager::GetRecord ( const NXString op2FileName,
const NXString datasetName,
const NXString recordName 
)

Gets an OP2 record in an OP2 dataset of an OP2 file which must be loaded
Created in NX12.0.1.



License requirements : None

Parameters
op2FileNameop2filename
datasetNamedatasetname
recordNamerecordname
NXOpen::CAE::FTK::Op2Record* NXOpen::CAE::FTK::Op2FileManager::GetRecord ( const char *  op2FileName,
const char *  datasetName,
const char *  recordName 
)

Gets an OP2 record in an OP2 dataset of an OP2 file which must be loaded
Created in NX12.0.1.



License requirements : None

Parameters
op2FileNameop2filename
datasetNamedatasetname
recordNamerecordname
void NXOpen::CAE::FTK::Op2FileManager::LoadFile ( const NXString op2FileName,
NXOpen::CAE::FTK::DataManager::FileContainerType  containerType 
)

Loads an OP2 file to the specified container.

An 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.1.

License requirements : None

Parameters
op2FileNameop2filename
containerTypecontainertype
void NXOpen::CAE::FTK::Op2FileManager::LoadFile ( const char *  op2FileName,
NXOpen::CAE::FTK::DataManager::FileContainerType  containerType 
)

Loads an OP2 file to the specified container.

An 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.1.

License requirements : None

Parameters
op2FileNameop2filename
containerTypecontainertype
tag_t NXOpen::CAE::FTK::Op2FileManager::Tag ( ) const

Returns the tag of this object.

void NXOpen::CAE::FTK::Op2FileManager::UnloadFile ( const NXString op2FileName,
NXOpen::CAE::FTK::DataManager::FileContainerType  containerType 
)

Unloads an OP2 file from the specified container.

An 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.1.

License requirements : None

Parameters
op2FileNameop2filename
containerTypecontainertype
void NXOpen::CAE::FTK::Op2FileManager::UnloadFile ( const char *  op2FileName,
NXOpen::CAE::FTK::DataManager::FileContainerType  containerType 
)

Unloads an OP2 file from the specified container.

An 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.1.

License requirements : None

Parameters
op2FileNameop2filename
containerTypecontainertype

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