NX Open C++ Reference Guide
Public Types | Public Member Functions | List of all members
NXOpen::Tooling::ElectrodeCopyBuilder Class Reference

The ElectrodeCopy builder
To create a new instance of this class, use NXOpen::Tooling::ElectrodeCopyCollection::CreateElectrodeCopyBuilder
Default values. More...

Inheritance diagram for NXOpen::Tooling::ElectrodeCopyBuilder:
NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Types

enum  Copy { CopyTransform, CopyMirror }
 Represents an index to copy type. More...
 

Public Member Functions

NXOpen::Tooling::CloneObjectCloneObject ()
 Returns the clone client data. More...
 
NXOpen::NXObjectCopyElectrode (NXOpen::Tooling::ElectrodeCopyBuilder::Copy copyType, NXOpen::NXObject *eleBody, NXOpen::NXObject *fromface, NXOpen::NXObject *toface)
 Copy an electrode blank from one face to another face. More...
 
bool CopyInstance ()
 Returns the setting indicates the copy is a new part or an instance. More...
 
int DefNum ()
 Returns the number of transform
Created in NX6.0.0. More...
 
NXOpen::TaggedObjectElectrodeBlankBuilder ()
 Returns the electrode blank builder. More...
 
NXOpen::SelectDatumPlaneListMirrorPlane ()
 Returns the mirror plane
Created in NX6.0.0. More...
 
bool Rename ()
 Returns the new electrode name
Created in NX6.0.0. More...
 
NXOpen::SelectBodyListSelectElectrode ()
 Returns the selected electrode
Created in NX6.0.0. More...
 
NXOpen::SelectFaceListSelectFromFace ()
 Returns the selected 'from' face
Created in NX6.0.0. More...
 
NXOpen::SelectFaceListSelToFace ()
 Returns the selected 'to' face
Created in NX6.0.0. More...
 
NXOpen::Tooling::ElectrodeCopyBuilder::Copy SelType ()
 Returns the copy type
Created in NX6.0.0. More...
 
void SetBlankPartName (const NXString &blankPartName)
 The part name of electrode blank. More...
 
void SetBlankPartName (const char *blankPartName)
 The part name of electrode blank. More...
 
void SetCopyInstance (bool copyInstance)
 Sets the setting indicates the copy is a new part or an instance. More...
 
void SetDefNum (int defNum)
 Sets the number of transform
Created in NX6.0.0. More...
 
void SetElectrodeBlankBuilder (NXOpen::TaggedObject *builderTag)
 Sets the electrode blank builder. More...
 
void SetRename (bool rename)
 Sets the new electrode name
Created in NX6.0.0. More...
 
void SetSelType (NXOpen::Tooling::ElectrodeCopyBuilder::Copy selType)
 Sets the copy type
Created in NX6.0.0. More...
 
NXString UpdateParameterData (NXOpen::TaggedObject *blankBuilderTag, NXOpen::TaggedObject *partTag, std::vector< NXString > &paraNames)
 Update parameter data to electrode blank builder. More...
 
- Public Member Functions inherited from NXOpen::Builder
NXOpen::NXObjectCommit ()
 Commits any edits that have been applied to the builder. More...
 
void Destroy ()
 Deletes the builder, and cleans up any objects created by the builder. More...
 
std::vector< NXOpen::NXObject * > GetCommittedObjects ()
 For builders that create more than one object, this method returns the objects that are created by commit. More...
 
NXOpen::NXObjectGetObject ()
 Returns the object currently being edited by this builder. More...
 
void ShowResults ()
 Updates the model to reflect the result of an edit to the model for all builders that support showing results. More...
 
virtual bool Validate ()
 Validate whether the inputs to the component are sufficient for commit to be called. More...
 
- Public Member Functions inherited from NXOpen::TaggedObject
tag_t Tag () const
 Returns the tag of this object. More...
 

Detailed Description

The ElectrodeCopy builder
To create a new instance of this class, use NXOpen::Tooling::ElectrodeCopyCollection::CreateElectrodeCopyBuilder
Default values.

Property Value

DefNum

1

SelType

Transform


Created in NX6.0.0.

Member Enumeration Documentation

Represents an index to copy type.

Enumerator
CopyTransform 

the method is transform

CopyMirror 

the method is mirror

Member Function Documentation

NXOpen::Tooling::CloneObject* NXOpen::Tooling::ElectrodeCopyBuilder::CloneObject ( )

Returns the clone client data.


Created in NX12.0.0.

License requirements : nx_electrode_wizard ("NX Electrode Wizard")

NXOpen::NXObject* NXOpen::Tooling::ElectrodeCopyBuilder::CopyElectrode ( NXOpen::Tooling::ElectrodeCopyBuilder::Copy  copyType,
NXOpen::NXObject eleBody,
NXOpen::NXObject fromface,
NXOpen::NXObject toface 
)

Copy an electrode blank from one face to another face.

Returns
new part tag
Created in NX12.0.0.

License requirements : nx_electrode_wizard ("NX Electrode Wizard")
Parameters
copyTypecopy type
eleBodythe electrode blank object that is to be copied
fromfacethe 'from' face object used for transform electrode or datum plane object used for mirror electrode
tofacethe 'to' face object used for transform electrode
bool NXOpen::Tooling::ElectrodeCopyBuilder::CopyInstance ( )

Returns the setting indicates the copy is a new part or an instance.


Created in NX7.5.0.

License requirements : None

int NXOpen::Tooling::ElectrodeCopyBuilder::DefNum ( )

Returns the number of transform
Created in NX6.0.0.



License requirements : None

NXOpen::TaggedObject* NXOpen::Tooling::ElectrodeCopyBuilder::ElectrodeBlankBuilder ( )

Returns the electrode blank builder.


Created in NX10.0.1.

License requirements : None

NXOpen::SelectDatumPlaneList* NXOpen::Tooling::ElectrodeCopyBuilder::MirrorPlane ( )

Returns the mirror plane
Created in NX6.0.0.



License requirements : None

bool NXOpen::Tooling::ElectrodeCopyBuilder::Rename ( )

Returns the new electrode name
Created in NX6.0.0.



License requirements : None

NXOpen::SelectBodyList* NXOpen::Tooling::ElectrodeCopyBuilder::SelectElectrode ( )

Returns the selected electrode
Created in NX6.0.0.



License requirements : None

NXOpen::SelectFaceList* NXOpen::Tooling::ElectrodeCopyBuilder::SelectFromFace ( )

Returns the selected 'from' face
Created in NX6.0.0.



License requirements : None

NXOpen::SelectFaceList* NXOpen::Tooling::ElectrodeCopyBuilder::SelToFace ( )

Returns the selected 'to' face
Created in NX6.0.0.



License requirements : None

NXOpen::Tooling::ElectrodeCopyBuilder::Copy NXOpen::Tooling::ElectrodeCopyBuilder::SelType ( )

Returns the copy type
Created in NX6.0.0.



License requirements : None

void NXOpen::Tooling::ElectrodeCopyBuilder::SetBlankPartName ( const NXString blankPartName)

The part name of electrode blank.


Created in NX12.0.0.

License requirements : nx_electrode_wizard ("NX Electrode Wizard")

Parameters
blankPartNameblank part name
void NXOpen::Tooling::ElectrodeCopyBuilder::SetBlankPartName ( const char *  blankPartName)

The part name of electrode blank.


Created in NX12.0.0.

License requirements : nx_electrode_wizard ("NX Electrode Wizard")

Parameters
blankPartNameblank part name
void NXOpen::Tooling::ElectrodeCopyBuilder::SetCopyInstance ( bool  copyInstance)

Sets the setting indicates the copy is a new part or an instance.


Created in NX7.5.0.

License requirements : None

Parameters
copyInstancecopyinstance
void NXOpen::Tooling::ElectrodeCopyBuilder::SetDefNum ( int  defNum)

Sets the number of transform
Created in NX6.0.0.



License requirements : None

Parameters
defNumdefnum
void NXOpen::Tooling::ElectrodeCopyBuilder::SetElectrodeBlankBuilder ( NXOpen::TaggedObject builderTag)

Sets the electrode blank builder.


Created in NX10.0.1.

License requirements : nx_electrode_wizard ("NX Electrode Wizard")

Parameters
builderTagelectrode blank builder tag
void NXOpen::Tooling::ElectrodeCopyBuilder::SetRename ( bool  rename)

Sets the new electrode name
Created in NX6.0.0.



License requirements : None

Parameters
renamerename
void NXOpen::Tooling::ElectrodeCopyBuilder::SetSelType ( NXOpen::Tooling::ElectrodeCopyBuilder::Copy  selType)

Sets the copy type
Created in NX6.0.0.



License requirements : None

Parameters
selTypeseltype
NXString NXOpen::Tooling::ElectrodeCopyBuilder::UpdateParameterData ( NXOpen::TaggedObject blankBuilderTag,
NXOpen::TaggedObject partTag,
std::vector< NXString > &  paraNames 
)

Update parameter data to electrode blank builder.

Returns
model path
Created in NX12.0.0.

License requirements : nx_electrode_wizard ("NX Electrode Wizard")
Parameters
blankBuilderTagelectrode blank builder tag
partTagelectrode blank body tag
paraNamesparameter name

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