NX Open C++ Reference Guide
Public Member Functions | 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

Public Member Functions

void AddAssembly (const NXString &assemName)
 Adds the part/assembly to be cloned. More...
 
void AddAssembly (const char *assemName)
 Adds the part/assembly to be cloned. More...
 
void AddAssembly (NXOpen::Part *part)
 Adds the part/assembly to be cloned. More...
 
void AddAssociatedPart (const NXString &clonedPartName, NXOpen::Tooling::ToolingCloneparttype fileType)
 Adds other part (FEM, SIM part etc.) to be cloned. More...
 
void AddAssociatedPart (const char *clonedPartName, NXOpen::Tooling::ToolingCloneparttype fileType)
 Adds other part (FEM, SIM part etc.) to be cloned. More...
 
void BuildAllClonePartItems ()
 Builds the cloned part name (item id, item name, revision id) etc with no cloned part items output. More...
 
void BuildClonePartItems (std::vector< NXOpen::Tooling::ClonePart * > &clonedPartItems)
 Builds the cloned part name (item id, item name, revision id) etc. More...
 
NXOpen::Tooling::ToolingClonemethod CloneMethod ()
 Returns the clone method. More...
 
NXString Commit ()
 Performs the clone operation. More...
 
NXOpen::Tooling::ClonePartCreateClonePartItem (const NXString &partName)
 Creates a new clone part item. More...
 
NXOpen::Tooling::ClonePartCreateClonePartItem (const char *partName)
 Creates a new clone part item. More...
 
NXOpen::Tooling::ClonePartFindClonePartItem (const NXString &partName)
 Find the part item to be cloned by giving part name. More...
 
NXOpen::Tooling::ClonePartFindClonePartItem (const char *partName)
 Find the part item to be cloned by giving part name. More...
 
NXOpen::Tooling::ClonePartFindClonePartItemByIndex (int index)
 Find the part item to be cloned by giving index. More...
 
NXString OutputFolder ()
 Returns the destination folder. More...
 
void RestorePartNumber ()
 Restore start number. More...
 
void SetCloneMethod (NXOpen::Tooling::ToolingClonemethod cloneMethod)
 Sets the clone method. More...
 
void SetDefaultItemType (const NXString &defaultItemType)
 Sets the default item type. More...
 
void SetDefaultItemType (const char *defaultItemType)
 Sets the default item type. More...
 
void SetDefaultNameRule (const NXString &nameRule)
 Sets the name rule (refer to the Customer Defaults). More...
 
void SetDefaultNameRule (const char *nameRule)
 Sets the name rule (refer to the Customer Defaults). More...
 
void SetKeepItemType (bool keepItemType)
 Uses the item type which is same as original source item. More...
 
void SetNameRule (const NXString &nameRule)
 Sets the name rule. More...
 
void SetNameRule (const char *nameRule)
 Sets the name rule. More...
 
void SetNextNumber (int nextNumber)
 Sets the next number of clone object. More...
 
void SetOutputFolder (const NXString &outputFolder)
 Sets the destination folder. More...
 
void SetOutputFolder (const char *outputFolder)
 Sets the destination folder. More...
 
void SetProjectName (const NXString &projName)
 Sets the project name. More...
 
void SetProjectName (const char *projName)
 Sets the project name. More...
 
void SyncPartNumber ()
 Synchronize the previous number with current. More...
 
virtual ~CloneObject ()
 Destructs the class. More...
 
- Public Member Functions inherited from NXOpen::TransientObject
void * GetHandle ()
 Handle of the internal object represented by this object. 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.

Constructor & Destructor Documentation

virtual NXOpen::Tooling::CloneObject::~CloneObject ( )
virtual

Destructs the class.


Created in NX6.0.0.

License requirements : None

Member Function Documentation

void NXOpen::Tooling::CloneObject::AddAssembly ( const NXString assemName)

Adds the part/assembly to be cloned.


Created in NX6.0.0.

License requirements : None

Parameters
assemNameProject assembly name
void NXOpen::Tooling::CloneObject::AddAssembly ( const char *  assemName)

Adds the part/assembly to be cloned.


Created in NX6.0.0.

License requirements : None

Parameters
assemNameProject assembly name
void NXOpen::Tooling::CloneObject::AddAssembly ( NXOpen::Part part)

Adds the part/assembly to be cloned.


Created in NX11.0.2.

License requirements : None

Parameters
partThe assembly to be cloned.
void NXOpen::Tooling::CloneObject::AddAssociatedPart ( const NXString clonedPartName,
NXOpen::Tooling::ToolingCloneparttype  fileType 
)

Adds other part (FEM, SIM part etc.) to be cloned.


Created in NX8.0.0.

License requirements : None

Parameters
clonedPartNamepart name
fileTypepart file type
void NXOpen::Tooling::CloneObject::AddAssociatedPart ( const char *  clonedPartName,
NXOpen::Tooling::ToolingCloneparttype  fileType 
)

Adds other part (FEM, SIM part etc.) to be cloned.


Created in NX8.0.0.

License requirements : None

Parameters
clonedPartNamepart name
fileTypepart file type
void NXOpen::Tooling::CloneObject::BuildAllClonePartItems ( )

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

void NXOpen::Tooling::CloneObject::BuildClonePartItems ( std::vector< NXOpen::Tooling::ClonePart * > &  clonedPartItems)

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


Created in NX8.0.0.

License requirements : None

Parameters
clonedPartItemsCloned part items
NXOpen::Tooling::ToolingClonemethod NXOpen::Tooling::CloneObject::CloneMethod ( )

Returns the clone method.


Created in NX7.0.0.

License requirements : None

NXString NXOpen::Tooling::CloneObject::Commit ( )

Performs the clone operation.

Returns

Created in NX6.0.0.

License requirements : None
NXOpen::Tooling::ClonePart* NXOpen::Tooling::CloneObject::CreateClonePartItem ( const NXString partName)

Creates a new clone part item.

Returns
the new NXOpen::Tooling::ClonePart instance
Created in NX6.0.0.

License requirements : None
Parameters
partNameclone part name
NXOpen::Tooling::ClonePart* NXOpen::Tooling::CloneObject::CreateClonePartItem ( const char *  partName)

Creates a new clone part item.

Returns
the new NXOpen::Tooling::ClonePart instance
Created in NX6.0.0.

License requirements : None
Parameters
partNameclone part name
NXOpen::Tooling::ClonePart* NXOpen::Tooling::CloneObject::FindClonePartItem ( const NXString partName)

Find the part item to be cloned by giving part name.

Returns
The returned NXOpen::Tooling::ClonePart instance
Created in NX6.0.0.

License requirements : None
Parameters
partNameclone part name
NXOpen::Tooling::ClonePart* NXOpen::Tooling::CloneObject::FindClonePartItem ( const char *  partName)

Find the part item to be cloned by giving part name.

Returns
The returned NXOpen::Tooling::ClonePart instance
Created in NX6.0.0.

License requirements : None
Parameters
partNameclone part name
NXOpen::Tooling::ClonePart* NXOpen::Tooling::CloneObject::FindClonePartItemByIndex ( int  index)

Find the part item to be cloned by giving index.

Returns
The returned NXOpen::Tooling::ClonePart instance
Created in NX9.0.1.

License requirements : None
Parameters
indexindex
NXString NXOpen::Tooling::CloneObject::OutputFolder ( )

Returns the destination folder.


Created in NX6.0.0.

License requirements : None

void NXOpen::Tooling::CloneObject::RestorePartNumber ( )

Restore start number.


Created in NX11.0.2.

License requirements : None

void NXOpen::Tooling::CloneObject::SetCloneMethod ( NXOpen::Tooling::ToolingClonemethod  cloneMethod)

Sets the clone method.


Created in NX7.0.0.

License requirements : None

Parameters
cloneMethodclonemethod
void NXOpen::Tooling::CloneObject::SetDefaultItemType ( const NXString defaultItemType)

Sets the default item type.


Created in NX11.0.2.

License requirements : None

Parameters
defaultItemTypeDefault item type
void NXOpen::Tooling::CloneObject::SetDefaultItemType ( const char *  defaultItemType)

Sets the default item type.


Created in NX11.0.2.

License requirements : None

Parameters
defaultItemTypeDefault item type
void NXOpen::Tooling::CloneObject::SetDefaultNameRule ( const NXString nameRule)

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


Created in NX11.0.2.

License requirements : None

Parameters
nameRuleNaming rule
void NXOpen::Tooling::CloneObject::SetDefaultNameRule ( const char *  nameRule)

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


Created in NX11.0.2.

License requirements : None

Parameters
nameRuleNaming rule
void NXOpen::Tooling::CloneObject::SetKeepItemType ( bool  keepItemType)

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
void NXOpen::Tooling::CloneObject::SetNameRule ( const NXString nameRule)

Sets the name rule.


Created in NX11.0.2.

License requirements : None

Parameters
nameRulenamerule
void NXOpen::Tooling::CloneObject::SetNameRule ( const char *  nameRule)

Sets the name rule.


Created in NX11.0.2.

License requirements : None

Parameters
nameRulenamerule
void NXOpen::Tooling::CloneObject::SetNextNumber ( int  nextNumber)

Sets the next number of clone object.


Created in NX9.0.1.

License requirements : None

Parameters
nextNumbernext number
void NXOpen::Tooling::CloneObject::SetOutputFolder ( const NXString outputFolder)

Sets the destination folder.


Created in NX6.0.0.

License requirements : None

Parameters
outputFolderIf this folder is not set, it will use the folder of display part
void NXOpen::Tooling::CloneObject::SetOutputFolder ( const char *  outputFolder)

Sets the destination folder.


Created in NX6.0.0.

License requirements : None

Parameters
outputFolderIf this folder is not set, it will use the folder of display part
void NXOpen::Tooling::CloneObject::SetProjectName ( const NXString projName)

Sets the project name.


Created in NX11.0.2.

License requirements : None

Parameters
projNameprojname
void NXOpen::Tooling::CloneObject::SetProjectName ( const char *  projName)

Sets the project name.


Created in NX11.0.2.

License requirements : None

Parameters
projNameprojname
void NXOpen::Tooling::CloneObject::SyncPartNumber ( )

Synchronize the previous number with current.


Created in NX11.0.2.

License requirements : None


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