NXOpen .NET Reference Guide  1899
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties
Public Member Functions | Protected Member Functions | Properties | List of all members
NXOpen.Tooling.CloneObject Class Reference

Represents the clone operation in Add Reusable Component Builder. More...

Inheritance diagram for NXOpen.Tooling.CloneObject:
NXOpen.TransientObject NXOpen.Utilities.NXRemotableObject IDisposable IMessageSink

Public Member Functions

unsafe void AddAssembly (string assemName)
 Adds the part/assembly to be cloned. More...
 
unsafe void AddAssembly (NXOpen.Part part)
 Adds the part/assembly to be cloned. More...
 
unsafe void AddAssociatedPart (string clonedPartName, NXOpen.Tooling.ToolingCloneparttype fileType)
 Adds other part (FEM, SIM part etc. More...
 
unsafe void BuildAllClonePartItems ()
 Builds the cloned part name (item id, item name, revision id) etc with no cloned part items output. More...
 
unsafe void BuildAllClonePartItems (NXOpen.Part newWorkPart)
 Builds the cloned part name (item id, item name, revision id) etc with no cloned part items output. More...
 
unsafe void BuildAllConceptPartItems ()
 Builds all the cloned part names for Concept Design More...
 
unsafe void BuildClonePartItems (out NXOpen.Tooling.ClonePart[] clonedPartItems)
 Builds the cloned part name (item id, item name, revision id) etc. More...
 
unsafe string Commit ()
 Performs the clone operation. More...
 
unsafe NXOpen.Tooling.ClonePart CreateClonePartItem (string partName)
 Creates a new clone part item. More...
 
unsafe NXOpen.Tooling.ClonePart FindClonePartItem (string partName)
 Find the part item to be cloned by giving part name More...
 
unsafe NXOpen.Tooling.ClonePart FindClonePartItemByIndex (int index)
 Find the part item to be cloned by giving index More...
 
unsafe void RestorePartNumber ()
 Restore start number. More...
 
unsafe void SaveCloneStartNumber ()
 Saves the clone action start number to the root part of an assembly More...
 
unsafe void SetCurrentNameMappingTemplate (string mappingTemplate)
 Sets the name mapping template file for current use. More...
 
unsafe void SetDefaultItemType (string defaultItemType)
 Sets the default item type. More...
 
unsafe void SetDefaultNameRule (string nameRule)
 Sets the name rule (refer to the Customer Defaults). More...
 
unsafe void SetEnableVersionControl (bool bVersionControl)
 Sets whether to enable version control of the template part in generating part names. More...
 
unsafe void SetKeepItemType (bool keepItemType)
 Uses the item type which is same as original source item. More...
 
unsafe void SetNameRule (string nameRule)
 Sets the name rule. More...
 
unsafe void SetNextNumber (int nextNumber)
 Sets the next number of clone object. More...
 
unsafe void SetProjectName (string projName)
 Sets the project name. More...
 
unsafe void SetUseMappingTemplate (bool bUseMappingTemplate)
 Sets whether to use name mapping template to generate part names. More...
 
unsafe void SyncPartNumber ()
 Synchronize the previous number with current. 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 ()
 Destructs the class. More...
 

Properties

unsafe
NXOpen.Tooling.ToolingClonemethod 
CloneMethod [get, set]
 Returns or sets the clone method More...
 
unsafe string OutputFolder [get, set]
 Returns or sets the destination folder More...
 
- Properties inherited from NXOpen.TransientObject
IntPtr Handle [get]
 Handle of the internal object represented by this object. More...
 
- Properties inherited from NXOpen.Utilities.NXRemotableObject
IMessageSink NextSink [get]
 Gets the next message sink in the sink chain. More...
 

Detailed Description

Represents the clone operation in Add Reusable Component Builder.

To create an instance of this object use NXOpen.Tooling.AddReusablePart.CreateCloneObject

Created in NX6.0.0

Member Function Documentation

unsafe void NXOpen.Tooling.CloneObject.AddAssembly ( string  assemName)
inline

Adds the part/assembly to be cloned.

Created in NX6.0.0

License requirements: None.

Parameters
assemNameProject assembly name
unsafe void NXOpen.Tooling.CloneObject.AddAssembly ( NXOpen.Part  part)
inline

Adds the part/assembly to be cloned.

Created in NX11.0.2

License requirements: None.

Parameters
partThe assembly to be cloned.
unsafe void NXOpen.Tooling.CloneObject.AddAssociatedPart ( string  clonedPartName,
NXOpen.Tooling.ToolingCloneparttype  fileType 
)
inline

Adds other part (FEM, SIM part etc.

) to be cloned

Created in NX8.0.0

License requirements: None.

Parameters
clonedPartNamepart name
fileTypepart file type
unsafe void NXOpen.Tooling.CloneObject.BuildAllClonePartItems ( )
inline

Builds the cloned part name (item id, item name, revision id) etc with no cloned part items output.

Created in NX11.0.0

License requirements: None.

unsafe void NXOpen.Tooling.CloneObject.BuildAllClonePartItems ( NXOpen.Part  newWorkPart)
inline

Builds the cloned part name (item id, item name, revision id) etc with no cloned part items output.

Created in NX1872.0.0

License requirements: None.

Parameters
newWorkPartThe part to be cloned.
unsafe void NXOpen.Tooling.CloneObject.BuildAllConceptPartItems ( )
inline

Builds all the cloned part names for Concept Design

Created in NX12.0.2

License requirements: None.

unsafe void NXOpen.Tooling.CloneObject.BuildClonePartItems ( out NXOpen.Tooling.ClonePart[]  clonedPartItems)
inline

Builds the cloned part name (item id, item name, revision id) etc.

Created in NX8.0.0

License requirements: None.

Parameters
clonedPartItemsCloned part items
unsafe string NXOpen.Tooling.CloneObject.Commit ( )
inline

Performs the clone operation.

Created in NX6.0.0

License requirements: None.

Returns
unsafe NXOpen.Tooling.ClonePart NXOpen.Tooling.CloneObject.CreateClonePartItem ( string  partName)
inline

Creates a new clone part item.

Created in NX6.0.0

License requirements: None.

Parameters
partNameclone part name
Returns
the new NXOpen.Tooling.ClonePart instance
unsafe NXOpen.Tooling.ClonePart NXOpen.Tooling.CloneObject.FindClonePartItem ( string  partName)
inline

Find the part item to be cloned by giving part name

Created in NX6.0.0

License requirements: None.

Parameters
partNameclone part name
Returns
The returned NXOpen.Tooling.ClonePart instance
unsafe NXOpen.Tooling.ClonePart NXOpen.Tooling.CloneObject.FindClonePartItemByIndex ( int  index)
inline

Find the part item to be cloned by giving index

Created in NX9.0.1

License requirements: None.

Parameters
indexindex
Returns
The returned NXOpen.Tooling.ClonePart instance
override void NXOpen.Tooling.CloneObject.FreeResource ( )
inlineprotectedvirtual

Destructs the class.

Created in NX6.0.0

License requirements: None.

Implements NXOpen.TransientObject.

unsafe void NXOpen.Tooling.CloneObject.RestorePartNumber ( )
inline

Restore start number.

Created in NX11.0.2

License requirements: None.

unsafe void NXOpen.Tooling.CloneObject.SaveCloneStartNumber ( )
inline

Saves the clone action start number to the root part of an assembly

Created in NX12.0.2

License requirements: None.

unsafe void NXOpen.Tooling.CloneObject.SetCurrentNameMappingTemplate ( string  mappingTemplate)
inline

Sets the name mapping template file for current use.

Created in NX1872.0.0

License requirements: None.

Parameters
mappingTemplatelast time used mapping file name
unsafe void NXOpen.Tooling.CloneObject.SetDefaultItemType ( string  defaultItemType)
inline

Sets the default item type.

Created in NX11.0.2

License requirements: None.

Parameters
defaultItemTypeDefault item type
unsafe void NXOpen.Tooling.CloneObject.SetDefaultNameRule ( string  nameRule)
inline

Sets the name rule (refer to the Customer Defaults).

Created in NX11.0.2

License requirements: None.

Parameters
nameRuleNaming rule
unsafe void NXOpen.Tooling.CloneObject.SetEnableVersionControl ( bool  bVersionControl)
inline

Sets whether to enable version control of the template part in generating part names.

Created in NX1899.0.0

License requirements: None.

Parameters
bVersionControlWhether to enable version control of the template part
unsafe void NXOpen.Tooling.CloneObject.SetKeepItemType ( bool  keepItemType)
inline

Uses the item type which is same as original source item.

Created in NX11.0.2

License requirements: None.

Parameters
keepItemTypeKeep the same item type or not
unsafe void NXOpen.Tooling.CloneObject.SetNameRule ( string  nameRule)
inline

Sets the name rule.

Created in NX11.0.2

License requirements: None.

Parameters
nameRule
unsafe void NXOpen.Tooling.CloneObject.SetNextNumber ( int  nextNumber)
inline

Sets the next number of clone object.

Created in NX9.0.1

License requirements: None.

Parameters
nextNumbernext number
unsafe void NXOpen.Tooling.CloneObject.SetProjectName ( string  projName)
inline

Sets the project name.

Created in NX11.0.2

License requirements: None.

Parameters
projName
unsafe void NXOpen.Tooling.CloneObject.SetUseMappingTemplate ( bool  bUseMappingTemplate)
inline

Sets whether to use name mapping template to generate part names.

Created in NX1872.0.0

License requirements: None.

Parameters
bUseMappingTemplateWhether to use name mapping template to generate part names
unsafe void NXOpen.Tooling.CloneObject.SyncPartNumber ( )
inline

Synchronize the previous number with current.

Created in NX11.0.2

License requirements: None.

Property Documentation

unsafe NXOpen.Tooling.ToolingClonemethod NXOpen.Tooling.CloneObject.CloneMethod
getset

Returns or sets the clone method

Created in NX7.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe string NXOpen.Tooling.CloneObject.OutputFolder
getset

Returns or sets the destination folder

Created in NX6.0.0

License requirements to get this property: None.

License requirements to set this property: None.


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