This class is responsible for Teamcenter file management related activities. More...
Public Types | |
| enum | FileType { CmmDmi, CpdFeaturePart, CpdGeometryOverride, DirectModel, Excel, ExcelX, Image, Jpeg, NxAttachedPart, NxPart, NxPosBin, NxleSymbolXml, NxleSymbolPreview, Preview2d, Preview3d, QafBinary, QafText, RoutePipeRun, RoutePipeSpec, RoutePipeRunAttachment, Text, Tif, TrushapeData, ValidationRuleSet } |
| PDM file types More... | |
Public Member Functions | |
| unsafe int[] | ImportFiles (string[] itemIds, string[] itemRevisionIds, string[] datasetNames, string[] datasetTypeNames, string[] datasetRelationTypeNames, string[] importDirectoryNames) |
| Imports all associated files for the specified dataset(s) into the Teamcenter database. More... | |
| unsafe int[] | ExportFiles (string[] itemIds, string[] itemRevisionIds, string[] datasetNames, string[] datasetTypeNames, string[] datasetRelationTypeNames, string[] baseDirectoryNames, string[] toolNames, out string[] exportDirectoryNames) |
| Exports all associated files for the specified dataset(s) to a directory. More... | |
| unsafe NXOpen.PDM.PdmFile[] | GetAssociatedFiles (NXOpen.BasePart[] parts, NXOpen.PDM.FileManagement.FileType[] fileTypesToExclude) |
| Given an NX part, this method will return a list of named reference files in the corresponding Teamcenter dataset. More... | |
| unsafe void | DownloadAssociatedFiles (NXOpen.BasePart[] parts, NXOpen.PDM.PdmFile[] files) |
| Download the specified named reference files for NX use. More... | |
| unsafe int[] | ImportFilesAndCreateDatasets (string[] itemIds, string[] itemRevisionIds, string[] datasetNames, string[] datasetTypeNames, string[] datasetRelationTypeNames, string[] datasetToolNames, bool[] fileType, string[] namedReferenceNames, string[] importFileNames, string[] importFileDirectoryNames) |
| Import files for datasets while creating the datasets also. More... | |
Protected Member Functions | |
| override void | FreeResource () |
| Frees the object from memory. More... | |
Detailed Description
This class is responsible for Teamcenter file management related activities.
Use PDM.PdmSession.NewFileManagement to get the instance of this class.
Created in NX6.0.3
Member Enumeration Documentation
Member Function Documentation
| unsafe void NXOpen.PDM.FileManagement.DownloadAssociatedFiles | ( | NXOpen.BasePart[] | parts, |
| NXOpen.PDM.PdmFile[] | files | ||
| ) |
Download the specified named reference files for NX use.
Created in NX11.0.0
License requirements: None.
- Parameters
-
parts files
| unsafe int [] NXOpen.PDM.FileManagement.ExportFiles | ( | string[] | itemIds, |
| string[] | itemRevisionIds, | ||
| string[] | datasetNames, | ||
| string[] | datasetTypeNames, | ||
| string[] | datasetRelationTypeNames, | ||
| string[] | baseDirectoryNames, | ||
| string[] | toolNames, | ||
| out string[] | exportDirectoryNames | ||
| ) |
Exports all associated files for the specified dataset(s) to a directory.
The dataset(s) are identified by their Teamcenter item id, Teamcenter item revision id, Teamcenter dataset name, NX dataset type, and NX dataset relation type. A base export directory name must be specified for each dataset along with the tool name that is requesting the export. The full path to the exported files is returned in an output array. The full path will be NX_default_directory or export_directory. Additionally, an array of PDI result codes is returned indicating the success (0) or failure (non-zero) of each export. The dataset types for FOREIGN_MODEL are the ones included in the Teamcenter preference "TC_NX_Foreign_Datasets". In such a case the input relation type should be "Foreign". The exporting of the associated file is governed by following conditions: The associated filetype should be exportable for combination of the Tool used and the Open action for operation. The associated file should not be in the excluded named reference list. For Foreign Datasets it will not export file types included in the Teamcenter preference "TC_NX_Foreign_Datasets". NX Clone can be used for exporting Foreign datasets. In case of NX CAM dataset type like "UGCAMCLSF", "UGCAMPTP", "UGCAMShopDoc", all the associated files will be exported irrespective of above conditions.
- Excluded Named Reference List:
- "UGPART"
- "UGPART-MASSPR
- "UGPART-BBOX
- "UGPART-ATTRIBUTES
- "UGPART-ATTR
- "Trushape-Data
- "BVRSYNCINFO
- "UG-QuickAccess-Binary
- "UG-QuickAccess-Text
- NX dataset types and relation names
- NX Model Type NX Relation Type NX Dataset Type
- MASTER_MODEL "has shape" "UGMASTER"
- SPEC_MODEL "has specification" "UGPART"
- MAN_MODEL "has manifestation" "UGPART"
- ALTREP_MODEL "has altrep" "UGALTREP"
- SCENARIO_MODEL "UG_scenario" "UGSCENARIO"
- SIMULATION_MODEL "NX_simulation" "NXSimulation"
- MOTION_MODEL "NX_simulation" "NXMotion"
- CAE_SOLN_MODEL "NX_simulation" "CAESolution"
- CAE_MESH_MODEL "NX_simulation" "CAEMesh"
- CAE_GEOM_MODEL "NX_simulation" "CAEGeom"
- FOREIGN_MODEL "Foreign" "*"
- MOTION_MODEL_SPEC "has specification" "MotionSim"
For the input itemIds: In case of Default Domain: it is Teamcenter item ID. In case of non-Default Domain: it is the multifield key. e.g. %MFK#%,=item_id=001, object_type=SupplierPart, supplier_code=x And the encoded part filename would be containing the MFK.
Created in NX6.0.3
License requirements: None.
- Parameters
-
itemIds Multifield Key. itemRevisionIds Teamcenter item revision ids. datasetNames Teamcenter dataset names. datasetTypeNames NX dataset type names. datasetRelationTypeNames NX dataset relation type names. baseDirectoryNames Base export directory name. toolNames Tool names ("UGII V10-ALL"). exportDirectoryNames Resulting location of export directory
- Returns
- Result codes. Success (0), failure (non-zero).
|
protected |
Frees the object from memory.
After this method is called, it is illegal to use the object. In .NET, this method is automatically called when the object is deleted by the garbage collector.
Created in NX6.0.3
License requirements: None.
| unsafe NXOpen.PDM.PdmFile [] NXOpen.PDM.FileManagement.GetAssociatedFiles | ( | NXOpen.BasePart[] | parts, |
| NXOpen.PDM.FileManagement.FileType[] | fileTypesToExclude | ||
| ) |
Given an NX part, this method will return a list of named reference files in the corresponding Teamcenter dataset.
Created in NX11.0.0
License requirements: None.
- Parameters
-
parts fileTypesToExclude
- Returns
| unsafe int [] NXOpen.PDM.FileManagement.ImportFiles | ( | string[] | itemIds, |
| string[] | itemRevisionIds, | ||
| string[] | datasetNames, | ||
| string[] | datasetTypeNames, | ||
| string[] | datasetRelationTypeNames, | ||
| string[] | importDirectoryNames | ||
| ) |
Imports all associated files for the specified dataset(s) into the Teamcenter database.
The files will be attached to the dataset(s) as named references. The dataset(s) are identified by their Teamcenter multifield key, Teamcenter item revision id, Teamcenter dataset name, NX dataset type, and NX dataset relation type. An import directory containing the files must be specified for each dataset. An array of PDI result codes is returned indicating the success (0) or failure (non-zero) of each import. The dataset types for FOREIGN_MODEL are the ones included in the Teamcenter preference "TC_NX_Foreign_Datasets". In such a case the input relation type should be "Foreign". The named reference information from BMIDE setting will be used for the imported file extension.
- NX dataset types and relation names
- NX Model Type NX Relation Type NX Dataset Type
- MASTER_MODEL "has shape" "UGMASTER"
- SPEC_MODEL "has specification" "UGPART"
- MAN_MODEL "has manifestation" "UGPART"
- ALTREP_MODEL "has altrep" "UGALTREP"
- SCENARIO_MODEL "UG_scenario" "UGSCENARIO"
- SIMULATION_MODEL "NX_simulation" "NXSimulation"
- MOTION_MODEL "NX_simulation" "NXMotion"
- CAE_SOLN_MODEL "NX_simulation" "CAESolution"
- CAE_MESH_MODEL "NX_simulation" "CAEMesh"
- CAE_GEOM_MODEL "NX_simulation" "CAEGeom"
- FOREIGN_MODEL "Foreign" "*"
- MOTION_MODEL_SPEC "has specification" "MotionSim"
For the input itemIds: In case of Default Domain: it is Teamcenter item ID. In case of non-Default Domain: it is the multifield key. e.g. %MFK#%,=item_id=001, object_type=SupplierPart, supplier_code=x And the encoded part filename would be containing the MFK.
Created in NX6.0.3
License requirements: None.
- Parameters
-
itemIds Multifield key. itemRevisionIds Teamcenter item revision ids. datasetNames Teamcenter dataset names. datasetTypeNames NX dataset type names. datasetRelationTypeNames NX dataset relation type names. importDirectoryNames Import directories which contain the files to import.
- Returns
- Result codes. Success (0), failure (non-zero).
| unsafe int [] NXOpen.PDM.FileManagement.ImportFilesAndCreateDatasets | ( | string[] | itemIds, |
| string[] | itemRevisionIds, | ||
| string[] | datasetNames, | ||
| string[] | datasetTypeNames, | ||
| string[] | datasetRelationTypeNames, | ||
| string[] | datasetToolNames, | ||
| bool[] | fileType, | ||
| string[] | namedReferenceNames, | ||
| string[] | importFileNames, | ||
| string[] | importFileDirectoryNames | ||
| ) |
Import files for datasets while creating the datasets also.
Created in NX11.0.1
License requirements: None.
- Parameters
-
itemIds Multifield key. itemRevisionIds Teamcenter item revision ids. datasetNames Teamcenter dataset names. datasetTypeNames NX dataset type names. datasetRelationTypeNames NX dataset relation type names. datasetToolNames NX dataset tool names. This is not currently supported. For future use only. fileType Types of files - true = Binary, false = Ascii. namedReferenceNames NX dataset named reference names. importFileNames Import file names which contain the files to import per dataset. importFileDirectoryNames Import file directory names which contain the files to import.
- Returns
- Result codes. Success (0), failure (non-zero).
The documentation for this class was generated from the following file:
- dotnet_pool/PDM_FileManagement.cs