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

Electrode component builder to install holder and pallet. More...

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

Public Types

enum  Chuck { ChuckUnknown = -1, ChuckHolder, ChuckPallet }
 Represents the electrode chuck type. More...
 

Public Member Functions

NXOpen::Tooling::ElectrodeComponentBuilder::Chuck ChuckType ()
 Returns the electrode chuck type. More...
 
NXOpen::Matrix3x3 ComponentMatrix ()
 Returns the component matrix. More...
 
NXOpen::SelectFaceFace ()
 Returns the face whose center will be the origin of the machine set csys. More...
 
NXOpen::Assemblies::SelectComponentFixture ()
 Returns the part which is an electrode fixture to be edited. More...
 
NXOpen::NXObjectInstallComponentPart (NXOpen::Tooling::SpreadsheetData *templateData, const NXString &libraryName, const NXString &catalogName, const NXString &classificationName, const NXString &titleName)
 Install a holder or a pallet part. More...
 
NXOpen::NXObjectInstallComponentPart (NXOpen::Tooling::SpreadsheetData *templateData, const char *libraryName, const char *catalogName, const char *classificationName, const char *titleName)
 Install a holder or a pallet part. More...
 
NXOpen::NXObjectMateCsys ()
 Returns the current machine set CSYS. More...
 
NXOpen::Assemblies::SelectComponentParent ()
 Returns the part which is the assembly parent to install an electrode chuck. More...
 
NXOpen::Point3d ReferenceCenter ()
 Returns the component reference point. More...
 
bool ReferPart ()
 Returns the option to install a chuck by referring to the template part directly or not. More...
 
bool Rename ()
 Returns the option to use the part name management dialog box or not. More...
 
void SetChuckType (NXOpen::Tooling::ElectrodeComponentBuilder::Chuck chuck)
 Sets the electrode chuck type. More...
 
void SetComponentMatrix (const NXOpen::Matrix3x3 &matrix)
 Sets the component matrix. More...
 
void SetMateCsys (NXOpen::NXObject *csys)
 Sets the current machine set CSYS. More...
 
void SetReferenceCenter (const NXOpen::Point3d &point)
 Sets the component reference point. More...
 
void SetReferPart (bool referPart)
 Sets the option to install a chuck by referring to the template part directly or not. More...
 
void SetRename (bool rename)
 Sets the option to use the part name management dialog box or not. More...
 
void SetStandardData (const NXString &standardData)
 Sets the electrode standard data spraedsheet. More...
 
void SetStandardData (const char *standardData)
 Sets the electrode standard data spraedsheet. More...
 
void SetStandardPart (const NXString &standardPart)
 Sets the electrode standard part to be installed. More...
 
void SetStandardPart (const char *standardPart)
 Sets the electrode standard part to be installed. More...
 
void SetTemplateDataName (const NXString &templateDataName)
 The template data name of holder or pallet. More...
 
void SetTemplateDataName (const char *templateDataName)
 The template data name of holder or pallet. More...
 
void SetTemplatePartName (const NXString &templatePartName)
 The template part name of holder or pallet. More...
 
void SetTemplatePartName (const char *templatePartName)
 The template part name of holder or pallet. More...
 
NXString StandardData ()
 Returns the electrode standard data spraedsheet. More...
 
NXString StandardPart ()
 Returns the electrode standard part to be installed. 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 component builder to install holder and pallet.


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

Property Value

ReferPart

0

Rename

0


Created in NX8.0.0.

Member Enumeration Documentation

Represents the electrode chuck type.

Enumerator
ChuckUnknown 

unknown

ChuckHolder 

holder

ChuckPallet 

pallet

Member Function Documentation

NXOpen::Tooling::ElectrodeComponentBuilder::Chuck NXOpen::Tooling::ElectrodeComponentBuilder::ChuckType ( )

Returns the electrode chuck type.


Created in NX8.0.0.

License requirements : None

NXOpen::Matrix3x3 NXOpen::Tooling::ElectrodeComponentBuilder::ComponentMatrix ( )

Returns the component matrix.


Created in NX12.0.0.

License requirements : None

NXOpen::SelectFace* NXOpen::Tooling::ElectrodeComponentBuilder::Face ( )

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


Created in NX8.0.0.

License requirements : None

NXOpen::Assemblies::SelectComponent* NXOpen::Tooling::ElectrodeComponentBuilder::Fixture ( )

Returns the part which is an electrode fixture to be edited.


Created in NX8.0.0.

License requirements : None

NXOpen::NXObject* NXOpen::Tooling::ElectrodeComponentBuilder::InstallComponentPart ( NXOpen::Tooling::SpreadsheetData templateData,
const NXString libraryName,
const NXString catalogName,
const NXString classificationName,
const NXString titleName 
)

Install a holder or a pallet part.

Returns

Created in NX12.0.0.

License requirements : nx_electrode_wizard ("NX Electrode Wizard")
Parameters
templateDataspread sheet data of the standard part
libraryNamelibrary name of the standard part
catalogNamecatalog name of the standard part
classificationNameclassification name of the standard part
titleNametitle name of the standard part
NXOpen::NXObject* NXOpen::Tooling::ElectrodeComponentBuilder::InstallComponentPart ( NXOpen::Tooling::SpreadsheetData templateData,
const char *  libraryName,
const char *  catalogName,
const char *  classificationName,
const char *  titleName 
)

Install a holder or a pallet part.

Returns

Created in NX12.0.0.

License requirements : nx_electrode_wizard ("NX Electrode Wizard")
Parameters
templateDataspread sheet data of the standard part
libraryNamelibrary name of the standard part
catalogNamecatalog name of the standard part
classificationNameclassification name of the standard part
titleNametitle name of the standard part
NXOpen::NXObject* NXOpen::Tooling::ElectrodeComponentBuilder::MateCsys ( )

Returns the current machine set CSYS.


Created in NX8.0.0.

License requirements : None

NXOpen::Assemblies::SelectComponent* NXOpen::Tooling::ElectrodeComponentBuilder::Parent ( )

Returns the part which is the assembly parent to install an electrode chuck.


Created in NX8.0.0.

License requirements : None

NXOpen::Point3d NXOpen::Tooling::ElectrodeComponentBuilder::ReferenceCenter ( )

Returns the component reference point.


Created in NX12.0.0.

License requirements : None

bool NXOpen::Tooling::ElectrodeComponentBuilder::ReferPart ( )

Returns the option to install a chuck by referring to the template part directly or not.


Created in NX8.0.0.

License requirements : None

bool NXOpen::Tooling::ElectrodeComponentBuilder::Rename ( )

Returns the option to use the part name management dialog box or not.


Created in NX8.0.0.

License requirements : None

void NXOpen::Tooling::ElectrodeComponentBuilder::SetChuckType ( NXOpen::Tooling::ElectrodeComponentBuilder::Chuck  chuck)

Sets the electrode chuck type.


Created in NX8.0.0.

License requirements : nx_electrode_wizard ("NX Electrode Wizard")

Parameters
chuckchuck
void NXOpen::Tooling::ElectrodeComponentBuilder::SetComponentMatrix ( const NXOpen::Matrix3x3 matrix)

Sets the component matrix.


Created in NX12.0.0.

License requirements : nx_electrode_wizard ("NX Electrode Wizard")

Parameters
matrixcomponent matrix
void NXOpen::Tooling::ElectrodeComponentBuilder::SetMateCsys ( NXOpen::NXObject csys)

Sets the current machine set CSYS.


Created in NX8.0.0.

License requirements : nx_electrode_wizard ("NX Electrode Wizard")

Parameters
csyscsys
void NXOpen::Tooling::ElectrodeComponentBuilder::SetReferenceCenter ( const NXOpen::Point3d point)

Sets the component reference point.


Created in NX12.0.0.

License requirements : nx_electrode_wizard ("NX Electrode Wizard")

Parameters
pointcomponent position
void NXOpen::Tooling::ElectrodeComponentBuilder::SetReferPart ( bool  referPart)

Sets the option to install a chuck by referring to the template part directly or not.


Created in NX8.0.0.

License requirements : nx_electrode_wizard ("NX Electrode Wizard")

Parameters
referPartreferpart
void NXOpen::Tooling::ElectrodeComponentBuilder::SetRename ( bool  rename)

Sets the option to use the part name management dialog box or not.


Created in NX8.0.0.

License requirements : nx_electrode_wizard ("NX Electrode Wizard")

Parameters
renamerename
void NXOpen::Tooling::ElectrodeComponentBuilder::SetStandardData ( const NXString standardData)

Sets the electrode standard data spraedsheet.


Created in NX8.0.0.

License requirements : nx_electrode_wizard ("NX Electrode Wizard")

Parameters
standardDatastandarddata
void NXOpen::Tooling::ElectrodeComponentBuilder::SetStandardData ( const char *  standardData)

Sets the electrode standard data spraedsheet.


Created in NX8.0.0.

License requirements : nx_electrode_wizard ("NX Electrode Wizard")

Parameters
standardDatastandarddata
void NXOpen::Tooling::ElectrodeComponentBuilder::SetStandardPart ( const NXString standardPart)

Sets the electrode standard part to be installed.


Created in NX8.0.0.

License requirements : nx_electrode_wizard ("NX Electrode Wizard")

Parameters
standardPartstandardpart
void NXOpen::Tooling::ElectrodeComponentBuilder::SetStandardPart ( const char *  standardPart)

Sets the electrode standard part to be installed.


Created in NX8.0.0.

License requirements : nx_electrode_wizard ("NX Electrode Wizard")

Parameters
standardPartstandardpart
void NXOpen::Tooling::ElectrodeComponentBuilder::SetTemplateDataName ( const NXString templateDataName)

The template data name of holder or pallet.


Created in NX12.0.0.

License requirements : nx_electrode_wizard ("NX Electrode Wizard")

Parameters
templateDataNametemplatedataname
void NXOpen::Tooling::ElectrodeComponentBuilder::SetTemplateDataName ( const char *  templateDataName)

The template data name of holder or pallet.


Created in NX12.0.0.

License requirements : nx_electrode_wizard ("NX Electrode Wizard")

Parameters
templateDataNametemplatedataname
void NXOpen::Tooling::ElectrodeComponentBuilder::SetTemplatePartName ( const NXString templatePartName)

The template part name of holder or pallet.


Created in NX12.0.0.

License requirements : nx_electrode_wizard ("NX Electrode Wizard")

Parameters
templatePartNametemplatepartname
void NXOpen::Tooling::ElectrodeComponentBuilder::SetTemplatePartName ( const char *  templatePartName)

The template part name of holder or pallet.


Created in NX12.0.0.

License requirements : nx_electrode_wizard ("NX Electrode Wizard")

Parameters
templatePartNametemplatepartname
NXString NXOpen::Tooling::ElectrodeComponentBuilder::StandardData ( )

Returns the electrode standard data spraedsheet.


Created in NX8.0.0.

License requirements : None

NXString NXOpen::Tooling::ElectrodeComponentBuilder::StandardPart ( )

Returns the electrode standard part to be installed.


Created in NX8.0.0.

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.