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

Electrode initialize project builder to creates an electrode design assembly. More...

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

Public Types

enum  Method { MethodOriginal, MethodNoWorkingPart, MethodNoMsetPart, MethodNoTemplate }
 The initialize type: Original, No Working Part, No Machine Set Part and No Template. More...
 
enum  Type { TypeCloneTopPart, TypeCloneMsetPart, TypeCloneWorkingPart }
 Clone a member of an electrode assembly, such as top part, machine set part, and working part. More...
 

Public Member Functions

NXOpen::Tooling::ElectrodeInitializationBuilder::Method ActionType ()
 Returns the initialize method of initialize electrode project. More...
 
NXString BuildMemberPartName (NXOpen::Tooling::ElectrodeInitializationBuilder::Type type)
 Builds the name of a part which is a member of an electrode assembly. More...
 
NXOpen::Tooling::CloneObjectCreateCloneObjectOfMsetPart ()
 Creates clone object of machine set part. More...
 
NXOpen::Tooling::CloneObjectCreateCloneObjectOfTopPart ()
 Creates clone object of top part. More...
 
NXOpen::Tooling::CloneObjectCreateCloneObjectOfWorkingPart ()
 Creates clone object of working part. More...
 
NXOpen::TaggedObjectCreateMsetPart (NXOpen::Tooling::CloneObject *cloneObject)
 Creates the mset part. More...
 
void CreateProject (NXOpen::Tooling::CloneObject *cloneObject)
 Creates the assembly structure of Electrode Wizard project. More...
 
NXOpen::TaggedObjectCreateWorkingPart (NXOpen::Tooling::CloneObject *cloneObject, NXOpen::TaggedObject *msetPartTag)
 Creates the working part. More...
 
NXOpen::TaggedObjectCurrentMset ()
 Returns the machine set part which is the working part. More...
 
void DisposeCloneObject (NXOpen::Tooling::CloneObject *cloneObject)
 Disposes the clone object. More...
 
NXOpen::SelectFaceFace ()
 Returns the face whose center will be the origin of the machine set csys. More...
 
NXOpen::SelectFaceListFaceList ()
 Returns the face list whose center will be the origin of the machine set csys. More...
 
NXOpen::TaggedObjectGetMsetPart (int listIndex)
 Gets the machine set part in machine set tree list. More...
 
NXOpen::TaggedObjectGetWorkingPart (NXOpen::TaggedObject *msetPartTag)
 Gets the working part in mset. More...
 
void InitalizeProjectParameter (NXOpen::NXObject *rootPartTag)
 Initialize the parameters of the project that need no machine set part. More...
 
void InitLinkObjects (NXOpen::TaggedObject *workingPartTag)
 Links the selected objects to the working component of Electrode assembly. More...
 
NXString InputName ()
 Returns the input name as project name. More...
 
NXString PathBrowser ()
 Returns the path browser. More...
 
void RemoveSelectedMsetNode (NXOpen::TaggedObject *msetPartTag)
 Remove a selected machine set node. More...
 
bool Rename ()
 Returns the component name can be defined in the part name management. More...
 
void SetActionType (NXOpen::Tooling::ElectrodeInitializationBuilder::Method actionType)
 Sets the initialize method of initialize electrode project. More...
 
void SetCloneMethod (int cloneMethod)
 Set clone method. More...
 
void SetConfigurationData (const NXString &configName, const NXString &topPartName, const NXString &msetPartName, const NXString &workingPartName, const NXString &subdir, int cloneMethod)
 Sets details of the configuration data. More...
 
void SetConfigurationData (const char *configName, const char *topPartName, const char *msetPartName, const char *workingPartName, const char *subdir, int cloneMethod)
 Sets details of the configuration data. More...
 
void SetCurrentMset (NXOpen::TaggedObject *mset)
 Sets the machine set part which is the working part. More...
 
void SetInputName (const NXString &inputName)
 Sets the input name as project name. More...
 
void SetInputName (const char *inputName)
 Sets the input name as project name. More...
 
void SetMsetCsysMatrixOrigin (const NXOpen::Matrix3x3 &matrix, const NXOpen::Point3d &origin)
 Sets csys matrix and origin. More...
 
void SetMsetCsysOriginToFaceCenter ()
 Sets MSET CSYS origin to center of the selected faces. More...
 
void SetPathBrowser (const NXString &foldername)
 Sets the path browser. More...
 
void SetPathBrowser (const char *foldername)
 Sets the path browser. More...
 
void SetRename (bool rename)
 Sets the component name can be defined in the part name management. More...
 
NXOpen::SelectBodyWorkpiece ()
 Returns the utility to get the workpiece to create an electrode design project. More...
 
NXOpen::SelectBodyListWorkpieceList ()
 Returns the utility to get the workpiece list to create an electrode design project. 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

Electrode initialize project builder to creates an electrode design assembly.


To create a new instance of this class, use NXOpen::Tooling::ElectrodeDesignCollection::CreateProjectBuilder
Default values.

Property Value

ActionType

Original

Rename

0


Created in NX8.0.0.

Member Enumeration Documentation

The initialize type: Original, No Working Part, No Machine Set Part and No Template.

Enumerator
MethodOriginal 

original

MethodNoWorkingPart 

no working part

MethodNoMsetPart 

no mset part

MethodNoTemplate 

no template

Clone a member of an electrode assembly, such as top part, machine set part, and working part.

Enumerator
TypeCloneTopPart 

clone top part

TypeCloneMsetPart 

clone mset part

TypeCloneWorkingPart 

clone working part

Member Function Documentation

NXOpen::Tooling::ElectrodeInitializationBuilder::Method NXOpen::Tooling::ElectrodeInitializationBuilder::ActionType ( )

Returns the initialize method of initialize electrode project.


Created in NX11.0.1.

License requirements : None

NXString NXOpen::Tooling::ElectrodeInitializationBuilder::BuildMemberPartName ( NXOpen::Tooling::ElectrodeInitializationBuilder::Type  type)

Builds the name of a part which is a member of an electrode assembly.

Returns

Created in NX11.0.2.

License requirements : nx_electrode_wizard ("NX Electrode Wizard")
Parameters
typetype
NXOpen::Tooling::CloneObject* NXOpen::Tooling::ElectrodeInitializationBuilder::CreateCloneObjectOfMsetPart ( )

Creates clone object of machine set part.

Returns

Created in NX9.0.1.

License requirements : nx_electrode_wizard ("NX Electrode Wizard")
NXOpen::Tooling::CloneObject* NXOpen::Tooling::ElectrodeInitializationBuilder::CreateCloneObjectOfTopPart ( )

Creates clone object of top part.

Returns

Created in NX9.0.1.

License requirements : nx_electrode_wizard ("NX Electrode Wizard")
NXOpen::Tooling::CloneObject* NXOpen::Tooling::ElectrodeInitializationBuilder::CreateCloneObjectOfWorkingPart ( )

Creates clone object of working part.

Returns

Created in NX9.0.1.

License requirements : nx_electrode_wizard ("NX Electrode Wizard")
NXOpen::TaggedObject* NXOpen::Tooling::ElectrodeInitializationBuilder::CreateMsetPart ( NXOpen::Tooling::CloneObject cloneObject)

Creates the mset part.

Returns

Created in NX9.0.1.

License requirements : nx_electrode_wizard ("NX Electrode Wizard")
Parameters
cloneObjectcloneobject
void NXOpen::Tooling::ElectrodeInitializationBuilder::CreateProject ( NXOpen::Tooling::CloneObject cloneObject)

Creates the assembly structure of Electrode Wizard project.


Created in NX9.0.1.

License requirements : nx_electrode_wizard ("NX Electrode Wizard")

Parameters
cloneObjectcloneobject
NXOpen::TaggedObject* NXOpen::Tooling::ElectrodeInitializationBuilder::CreateWorkingPart ( NXOpen::Tooling::CloneObject cloneObject,
NXOpen::TaggedObject msetPartTag 
)

Creates the working part.

Returns

Created in NX9.0.1.

License requirements : nx_electrode_wizard ("NX Electrode Wizard")
Parameters
cloneObjectcloneobject
msetPartTagmsetparttag
NXOpen::TaggedObject* NXOpen::Tooling::ElectrodeInitializationBuilder::CurrentMset ( )

Returns the machine set part which is the working part.


Created in NX8.0.0.

License requirements : nx_electrode_wizard ("NX Electrode Wizard")

void NXOpen::Tooling::ElectrodeInitializationBuilder::DisposeCloneObject ( NXOpen::Tooling::CloneObject cloneObject)

Disposes the clone object.


Created in NX9.0.1.

License requirements : nx_electrode_wizard ("NX Electrode Wizard")

Parameters
cloneObjectcloneobject
NXOpen::SelectFace* NXOpen::Tooling::ElectrodeInitializationBuilder::Face ( )

Returns the face whose center will be the origin of the machine set csys.


Deprecated:
Deprecated in NX11.0.0. This functionality is no longer supported.


Created in NX8.0.0.

License requirements : nx_electrode_wizard ("NX Electrode Wizard")

NXOpen::SelectFaceList* NXOpen::Tooling::ElectrodeInitializationBuilder::FaceList ( )

Returns the face list whose center will be the origin of the machine set csys.


Created in NX11.0.0.

License requirements : nx_electrode_wizard ("NX Electrode Wizard")

NXOpen::TaggedObject* NXOpen::Tooling::ElectrodeInitializationBuilder::GetMsetPart ( int  listIndex)

Gets the machine set part in machine set tree list.

Returns

Created in NX11.0.2.

License requirements : nx_electrode_wizard ("NX Electrode Wizard")
Parameters
listIndexindex of machine set node in machine set tree list
NXOpen::TaggedObject* NXOpen::Tooling::ElectrodeInitializationBuilder::GetWorkingPart ( NXOpen::TaggedObject msetPartTag)

Gets the working part in mset.

Returns

Created in NX9.0.1.

License requirements : nx_electrode_wizard ("NX Electrode Wizard")
Parameters
msetPartTagmsetparttag
void NXOpen::Tooling::ElectrodeInitializationBuilder::InitalizeProjectParameter ( NXOpen::NXObject rootPartTag)

Initialize the parameters of the project that need no machine set part.


Created in NX11.0.2.

License requirements : nx_electrode_wizard ("NX Electrode Wizard")

Parameters
rootPartTagroot part object
void NXOpen::Tooling::ElectrodeInitializationBuilder::InitLinkObjects ( NXOpen::TaggedObject workingPartTag)

Links the selected objects to the working component of Electrode assembly.


Created in NX9.0.1.

License requirements : nx_electrode_wizard ("NX Electrode Wizard")

Parameters
workingPartTagworkingparttag
NXString NXOpen::Tooling::ElectrodeInitializationBuilder::InputName ( )

Returns the input name as project name.


Created in NX8.0.0.

License requirements : nx_electrode_wizard ("NX Electrode Wizard")

NXString NXOpen::Tooling::ElectrodeInitializationBuilder::PathBrowser ( )

Returns the path browser.


Created in NX8.0.0.

License requirements : nx_electrode_wizard ("NX Electrode Wizard")

void NXOpen::Tooling::ElectrodeInitializationBuilder::RemoveSelectedMsetNode ( NXOpen::TaggedObject msetPartTag)

Remove a selected machine set node.


Created in NX12.0.0.

License requirements : nx_electrode_wizard ("NX Electrode Wizard")

Parameters
msetPartTagmsetparttag
bool NXOpen::Tooling::ElectrodeInitializationBuilder::Rename ( )

Returns the component name can be defined in the part name management.


Created in NX8.0.0.

License requirements : nx_electrode_wizard ("NX Electrode Wizard")

void NXOpen::Tooling::ElectrodeInitializationBuilder::SetActionType ( NXOpen::Tooling::ElectrodeInitializationBuilder::Method  actionType)

Sets the initialize method of initialize electrode project.


Created in NX11.0.1.

License requirements : nx_electrode_wizard ("NX Electrode Wizard")

Parameters
actionTypeactiontype
void NXOpen::Tooling::ElectrodeInitializationBuilder::SetCloneMethod ( int  cloneMethod)

Set clone method.


Created in NX11.0.2.

License requirements : nx_electrode_wizard ("NX Electrode Wizard")

Parameters
cloneMethodclone method
void NXOpen::Tooling::ElectrodeInitializationBuilder::SetConfigurationData ( const NXString configName,
const NXString topPartName,
const NXString msetPartName,
const NXString workingPartName,
const NXString subdir,
int  cloneMethod 
)

Sets details of the configuration data.


Created in NX11.0.1.

License requirements : nx_electrode_wizard ("NX Electrode Wizard")

Parameters
configNameconfiguration name
topPartNametop part name
msetPartNamemachine set part name
workingPartNameworking part name
subdirsub direction
cloneMethodcloning method
void NXOpen::Tooling::ElectrodeInitializationBuilder::SetConfigurationData ( const char *  configName,
const char *  topPartName,
const char *  msetPartName,
const char *  workingPartName,
const char *  subdir,
int  cloneMethod 
)

Sets details of the configuration data.


Created in NX11.0.1.

License requirements : nx_electrode_wizard ("NX Electrode Wizard")

Parameters
configNameconfiguration name
topPartNametop part name
msetPartNamemachine set part name
workingPartNameworking part name
subdirsub direction
cloneMethodcloning method
void NXOpen::Tooling::ElectrodeInitializationBuilder::SetCurrentMset ( NXOpen::TaggedObject mset)

Sets the machine set part which is the working part.


Created in NX8.0.0.

License requirements : nx_electrode_wizard ("NX Electrode Wizard")

Parameters
msetmachine set part
void NXOpen::Tooling::ElectrodeInitializationBuilder::SetInputName ( const NXString inputName)

Sets the input name as project name.


Created in NX8.0.0.

License requirements : nx_electrode_wizard ("NX Electrode Wizard")

Parameters
inputNameinputname
void NXOpen::Tooling::ElectrodeInitializationBuilder::SetInputName ( const char *  inputName)

Sets the input name as project name.


Created in NX8.0.0.

License requirements : nx_electrode_wizard ("NX Electrode Wizard")

Parameters
inputNameinputname
void NXOpen::Tooling::ElectrodeInitializationBuilder::SetMsetCsysMatrixOrigin ( const NXOpen::Matrix3x3 matrix,
const NXOpen::Point3d origin 
)

Sets csys matrix and origin.


Created in NX8.5.0.

License requirements : nx_electrode_wizard ("NX Electrode Wizard")

Parameters
matrixcsys matrix
origincsys origin
void NXOpen::Tooling::ElectrodeInitializationBuilder::SetMsetCsysOriginToFaceCenter ( )

Sets MSET CSYS origin to center of the selected faces.


Created in NX9.0.1.

License requirements : nx_electrode_wizard ("NX Electrode Wizard")

void NXOpen::Tooling::ElectrodeInitializationBuilder::SetPathBrowser ( const NXString foldername)

Sets the path browser.


Created in NX8.0.0.

License requirements : nx_electrode_wizard ("NX Electrode Wizard")

Parameters
foldernamefoldername
void NXOpen::Tooling::ElectrodeInitializationBuilder::SetPathBrowser ( const char *  foldername)

Sets the path browser.


Created in NX8.0.0.

License requirements : nx_electrode_wizard ("NX Electrode Wizard")

Parameters
foldernamefoldername
void NXOpen::Tooling::ElectrodeInitializationBuilder::SetRename ( bool  rename)

Sets the component name can be defined in the part name management.


Created in NX8.0.0.

License requirements : nx_electrode_wizard ("NX Electrode Wizard")

Parameters
renamerename
NXOpen::SelectBody* NXOpen::Tooling::ElectrodeInitializationBuilder::Workpiece ( )

Returns the utility to get the workpiece to create an electrode design project.


Created in NX8.0.0.

License requirements : None

NXOpen::SelectBodyList* NXOpen::Tooling::ElectrodeInitializationBuilder::WorkpieceList ( )

Returns the utility to get the workpiece list to create an electrode design project.


Created in NX8.5.3.

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.