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

Electrode Checking builder to check the touch status of all electrode. More...

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

Public Member Functions

NXOpen::Assemblies::SelectComponentListElectrode ()
 Returns the electrode part to be checked with the workpiece part. More...
 
NXString ElectrodeNameFilter ()
 Returns the wildcard string to filter out the electrode part name. More...
 
bool InterSolid ()
 Returns the option for generating the interference solid body. More...
 
bool MapFaceColor ()
 Returns the option for mapping color of the touched face pair from workpiece to electrode. More...
 
bool SameParent ()
 Returns the option for checking the workpiece and electrode part under the same part or not. More...
 
bool SaveResultsInPart ()
 Returns the option for saving checking results in part. More...
 
void SetElectrodeNameFilter (const NXString &electrodeNameFilter)
 Sets the wildcard string to filter out the electrode part name. More...
 
void SetElectrodeNameFilter (const char *electrodeNameFilter)
 Sets the wildcard string to filter out the electrode part name. More...
 
void SetInterSolid (bool interSolid)
 Sets the option for generating the interference solid body. More...
 
void SetMapFaceColor (bool mapFaceColor)
 Sets the option for mapping color of the touched face pair from workpiece to electrode. More...
 
void SetSameParent (bool sameParent)
 Sets the option for checking the workpiece and electrode part under the same part or not. More...
 
void SetSaveResultsInPart (bool saveResultsInPart)
 Sets the option for saving checking results in part. More...
 
void SetTouchArea (bool touchArea)
 Sets the option for calculating the area of the touch sheet body. More...
 
void SetTouchBody (bool touchBody)
 Sets the option for generating the touch sheet body. More...
 
void SetWorkpieceNameFilter (const NXString &workpieceNameFilter)
 Sets the wildcard string to filter out the workpiece part name. More...
 
void SetWorkpieceNameFilter (const char *workpieceNameFilter)
 Sets the wildcard string to filter out the workpiece part name. More...
 
bool TouchArea ()
 Returns the option for calculating the area of the touch sheet body. More...
 
bool TouchBody ()
 Returns the option for generating the touch sheet body. More...
 
NXOpen::Assemblies::SelectComponentListWorkpiece ()
 Returns the workpiece part to be checked with the electrode part. More...
 
NXString WorkpieceNameFilter ()
 Returns the wildcard string to filter out the workpiece part name. 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 Checking builder to check the touch status of all electrode.


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

Property Value

InterSolid

1

MapFaceColor

1

SameParent

1

TouchArea

0

TouchBody

1


Created in NX8.0.0.

Member Function Documentation

NXOpen::Assemblies::SelectComponentList* NXOpen::Tooling::ElectrodeCheckingBuilder::Electrode ( )

Returns the electrode part to be checked with the workpiece part.


Created in NX8.0.0.

License requirements : None

NXString NXOpen::Tooling::ElectrodeCheckingBuilder::ElectrodeNameFilter ( )

Returns the wildcard string to filter out the electrode part name.


Created in NX8.0.0.

License requirements : None

bool NXOpen::Tooling::ElectrodeCheckingBuilder::InterSolid ( )

Returns the option for generating the interference solid body.


Created in NX8.0.0.

License requirements : None

bool NXOpen::Tooling::ElectrodeCheckingBuilder::MapFaceColor ( )

Returns the option for mapping color of the touched face pair from workpiece to electrode.


Created in NX8.0.0.

License requirements : None

bool NXOpen::Tooling::ElectrodeCheckingBuilder::SameParent ( )

Returns the option for checking the workpiece and electrode part under the same part or not.


Created in NX8.0.0.

License requirements : None

bool NXOpen::Tooling::ElectrodeCheckingBuilder::SaveResultsInPart ( )

Returns the option for saving checking results in part.


Created in NX8.0.0.

License requirements : None

void NXOpen::Tooling::ElectrodeCheckingBuilder::SetElectrodeNameFilter ( const NXString electrodeNameFilter)

Sets the wildcard string to filter out the electrode part name.


Created in NX8.0.0.

License requirements : nx_electrode_wizard ("NX Electrode Wizard")

Parameters
electrodeNameFilterelectrodenamefilter
void NXOpen::Tooling::ElectrodeCheckingBuilder::SetElectrodeNameFilter ( const char *  electrodeNameFilter)

Sets the wildcard string to filter out the electrode part name.


Created in NX8.0.0.

License requirements : nx_electrode_wizard ("NX Electrode Wizard")

Parameters
electrodeNameFilterelectrodenamefilter
void NXOpen::Tooling::ElectrodeCheckingBuilder::SetInterSolid ( bool  interSolid)

Sets the option for generating the interference solid body.


Created in NX8.0.0.

License requirements : nx_electrode_wizard ("NX Electrode Wizard")

Parameters
interSolidintersolid
void NXOpen::Tooling::ElectrodeCheckingBuilder::SetMapFaceColor ( bool  mapFaceColor)

Sets the option for mapping color of the touched face pair from workpiece to electrode.


Created in NX8.0.0.

License requirements : nx_electrode_wizard ("NX Electrode Wizard")

Parameters
mapFaceColormapfacecolor
void NXOpen::Tooling::ElectrodeCheckingBuilder::SetSameParent ( bool  sameParent)

Sets the option for checking the workpiece and electrode part under the same part or not.


Created in NX8.0.0.

License requirements : nx_electrode_wizard ("NX Electrode Wizard")

Parameters
sameParentsameparent
void NXOpen::Tooling::ElectrodeCheckingBuilder::SetSaveResultsInPart ( bool  saveResultsInPart)

Sets the option for saving checking results in part.


Created in NX8.0.0.

License requirements : nx_electrode_wizard ("NX Electrode Wizard")

Parameters
saveResultsInPartsaveresultsinpart
void NXOpen::Tooling::ElectrodeCheckingBuilder::SetTouchArea ( bool  touchArea)

Sets the option for calculating the area of the touch sheet body.


Created in NX8.0.0.

License requirements : nx_electrode_wizard ("NX Electrode Wizard")

Parameters
touchAreatoucharea
void NXOpen::Tooling::ElectrodeCheckingBuilder::SetTouchBody ( bool  touchBody)

Sets the option for generating the touch sheet body.


Created in NX8.0.0.

License requirements : nx_electrode_wizard ("NX Electrode Wizard")

Parameters
touchBodytouchbody
void NXOpen::Tooling::ElectrodeCheckingBuilder::SetWorkpieceNameFilter ( const NXString workpieceNameFilter)

Sets the wildcard string to filter out the workpiece part name.


Created in NX8.0.0.

License requirements : nx_electrode_wizard ("NX Electrode Wizard")

Parameters
workpieceNameFilterworkpiecenamefilter
void NXOpen::Tooling::ElectrodeCheckingBuilder::SetWorkpieceNameFilter ( const char *  workpieceNameFilter)

Sets the wildcard string to filter out the workpiece part name.


Created in NX8.0.0.

License requirements : nx_electrode_wizard ("NX Electrode Wizard")

Parameters
workpieceNameFilterworkpiecenamefilter
bool NXOpen::Tooling::ElectrodeCheckingBuilder::TouchArea ( )

Returns the option for calculating the area of the touch sheet body.


Created in NX8.0.0.

License requirements : None

bool NXOpen::Tooling::ElectrodeCheckingBuilder::TouchBody ( )

Returns the option for generating the touch sheet body.


Created in NX8.0.0.

License requirements : None

NXOpen::Assemblies::SelectComponentList* NXOpen::Tooling::ElectrodeCheckingBuilder::Workpiece ( )

Returns the workpiece part to be checked with the electrode part.


Created in NX8.0.0.

License requirements : None

NXString NXOpen::Tooling::ElectrodeCheckingBuilder::WorkpieceNameFilter ( )

Returns the wildcard string to filter out the workpiece part name.


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.