NXOpen .NET Reference Guide
|
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 void | DownloadAssociatedFiles (NXOpen.BasePart[] parts, NXOpen.PDM.PdmFile[] files) |
Download the specified named reference files for NX use. 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 void | ExportNamedReferences (string itemId, string itemRevisionId, string datasetName, string datasetTypeName, string datasetRelationTypeName, string datasetNamedReference, string exportDirectoryName, out string[] namedReferences) |
Export Named Reference From Teamcenter. 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 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[] | ImportFilesAndCreateDatasets (string[] itemIds, string[] itemRevisionIds, string[] datasetNames, string[] datasetTypeNames, string[] datasetRelationTypeNames, string[] datasetToolNames, bool[] fileType, string[] namedReferenceNames, string[] importFileNames, string[] importFileDirectoryNames) |
Import files and create datasets in Teamcenter. More... | |
Public Member Functions inherited from NXOpen.TransientObject | |
void | Dispose () |
Frees the object from memory. More... | |
void | PrintTestData (String variableName) |
<exclude> More... | |
void | PrintTestData (String variableName, int lineNumber) |
<exclude> More... | |
new string | ToString () |
Returns a String that represents the current Object. 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... | |
Protected Member Functions | |
override void | FreeResource () |
Frees the object from memory. More... | |
Additional Inherited Members | |
Properties inherited from NXOpen.TransientObject | |
IntPtr | Handle [get] |
Handle of the internal object represented by this object. More... | |
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
|
inline |
Download the specified named reference files for NX use.
Created in NX11.0.0
License requirements: None.
parts | |
files |
|
inline |
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". In case of NX CAM dataset type like "UGCAMCLSF", "UGCAMPTP", "UGCAMShopDoc", all the associated files will be exported irrespective of above conditions.
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.
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 |
|
inline |
Export Named Reference From Teamcenter.
The Dataset Relation Type Names are the names of the Teamcenter relationships used to find the Datasets to the correponding Item Revisions. Any ImanRelation types can be used.
Created in NX1847.0.0
License requirements: None.
itemId | Multifield key. |
itemRevisionId | Teamcenter item revision ids. |
datasetName | Teamcenter dataset names. |
datasetTypeName | NX dataset type names. |
datasetRelationTypeName | Exact Teamcenter relation type names. |
datasetNamedReference | NX dataset named reference names. |
exportDirectoryName | Where to export files to |
namedReferences | NamedReferences |
|
inlineprotectedvirtual |
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.
Implements NXOpen.TransientObject.
|
inline |
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.
parts | |
fileTypesToExclude |
|
inline |
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.
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.
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. |
|
inline |
Import files and create datasets in Teamcenter.
The Dataset Relation Type Names are the names of the Teamcenter relationships used to attach the Datasets to the correponding Item Revisions. Any ImanRelation types can be used.
Created in NX11.0.1
License requirements: None.
itemIds | Multifield key. |
itemRevisionIds | Teamcenter item revision ids. |
datasetNames | Teamcenter dataset names. |
datasetTypeNames | NX dataset type names. |
datasetRelationTypeNames | Exact Teamcenter 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 file names with extension only to import per dataset. This should not contain full directory path. |
importFileDirectoryNames | Import file directory names which contain the files to import. |