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

This is the JA builder for static interference check
To create a new instance of this class, use NXOpen::Tooling::ValidCheckCollection::CreateValidCheckBuilder
Default values. More...

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

Public Types

enum  AnalysisMode { AnalysisModeSolidBased, AnalysisModeFacetBased }
 the analysis mode, including solid-based mode and facet-based mode More...
 
enum  CheckingType { CheckingTypeTrueBody, CheckingTypeFalseBody, CheckingTypeBoth }
 the checking type, including true body, false body or both More...
 
enum  SelMode { SelModeComponent, SelModeBody }
 the selection type, including component and solid body More...
 

Public Member Functions

NXOpen::Tooling::ValidCheckBuilder::AnalysisMode AnalyMode ()
 Returns the analysis mode
Created in NX6.0.0. More...
 
bool BlankBody ()
 Returns the blank body, to specify if blanked bodies in a component needs to be searched
Created in NX6.0.0. More...
 
NXOpen::Tooling::ValidCheckBuilder::CheckingType CheckType ()
 Returns the check type
Created in NX6.0.0. More...
 
NXString ClrSetName ()
 Returns the clearance set name
Created in NX6.0.0. More...
 
double ClrZone ()
 Returns the clearance zone
Created in NX6.0.0. More...
 
NXOpen::SelectNXObjectListObjSelectTarget ()
 Returns the target object selection list
Created in NX6.0.0. More...
 
NXOpen::SelectNXObjectListObjSelectTool ()
 Returns the tool object selection list
Created in NX6.0.0. More...
 
NXOpen::Tooling::ValidCheckBuilder::SelMode ObjSelectType ()
 Returns the object selection type
Created in NX6.0.0. More...
 
void RemoveDataSet (const NXString &dataSetName)
 The action to delete a data set
Created in NX11.0.0. More...
 
void RemoveDataSet (const char *dataSetName)
 The action to delete a data set
Created in NX11.0.0. More...
 
bool ScrewCheck ()
 Returns the screw check, to specify if screw check algorithm needs to be used
Created in NX6.0.0. More...
 
NXString SelectDatasetsName ()
 Returns the box list selected sets name
Created in NX6.0.0. More...
 
NXString SelectStandardSetsSpreadsheet ()
 Returns the standard sets spreadsheet
Created in NX11.0.0. More...
 
void SetAnalyMode (NXOpen::Tooling::ValidCheckBuilder::AnalysisMode analyMode)
 Sets the analysis mode
Created in NX6.0.0. More...
 
void SetBlankBody (bool blankBody)
 Sets the blank body, to specify if blanked bodies in a component needs to be searched
Created in NX6.0.0. More...
 
void SetCheckType (NXOpen::Tooling::ValidCheckBuilder::CheckingType checkType)
 Sets the check type
Created in NX6.0.0. More...
 
void SetClrSetName (const NXString &clrSetName)
 Sets the clearance set name
Created in NX6.0.0. More...
 
void SetClrSetName (const char *clrSetName)
 Sets the clearance set name
Created in NX6.0.0. More...
 
void SetClrZone (double clrZone)
 Sets the clearance zone
Created in NX6.0.0. More...
 
void SetObjSelectType (NXOpen::Tooling::ValidCheckBuilder::SelMode objSelectType)
 Sets the object selection type
Created in NX6.0.0. More...
 
void SetScrewCheck (bool screwCheck)
 Sets the screw check, to specify if screw check algorithm needs to be used
Created in NX6.0.0. More...
 
void SetSelectDatasetsName (const NXString &selDataSetName)
 Sets the box list selected sets name
Created in NX6.0.0. More...
 
void SetSelectDatasetsName (const char *selDataSetName)
 Sets the box list selected sets name
Created in NX6.0.0. More...
 
void SetSelectStandardSetsSpreadsheet (const NXString &filename)
 Sets the standard sets spreadsheet
Created in NX11.0.0. More...
 
void SetSelectStandardSetsSpreadsheet (const char *filename)
 Sets the standard sets spreadsheet
Created in NX11.0.0. More...
 
void SetSubAssembly (bool subAssembly)
 Sets the sub-assembly, to specify if sub-assembly needs to be searched
Created in NX6.0.0. More...
 
void StdAddUserSets ()
 Adds standard part into user defined set
Created in NX6.0.0. More...
 
void StdLoadFile ()
 Loads standard attribute list
Created in NX6.0.0. More...
 
bool SubAssembly ()
 Returns the sub-assembly, to specify if sub-assembly needs to be searched
Created in NX6.0.0. 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

This is the JA builder for static interference check
To create a new instance of this class, use NXOpen::Tooling::ValidCheckCollection::CreateValidCheckBuilder
Default values.

Property Value

AnalyMode

SolidBased

BlankBody

0

CheckType

TrueBody

ClrZone

0

ObjSelectType

Component

ScrewCheck

0

SubAssembly

0


Created in NX6.0.0.

Member Enumeration Documentation

the analysis mode, including solid-based mode and facet-based mode

Enumerator
AnalysisModeSolidBased 

Solid body will be used to do checking.

AnalysisModeFacetBased 

Facet body will be used to do checking.

the checking type, including true body, false body or both

Enumerator
CheckingTypeTrueBody 

True body will be used to do checking.

CheckingTypeFalseBody 

False body will be used to do checking.

CheckingTypeBoth 

Both types of body will be used to do checking.

the selection type, including component and solid body

Enumerator
SelModeComponent 

Selection type will be set to component.

SelModeBody 

Selection type will be set to body.

Member Function Documentation

NXOpen::Tooling::ValidCheckBuilder::AnalysisMode NXOpen::Tooling::ValidCheckBuilder::AnalyMode ( )

Returns the analysis mode
Created in NX6.0.0.



License requirements : None

bool NXOpen::Tooling::ValidCheckBuilder::BlankBody ( )

Returns the blank body, to specify if blanked bodies in a component needs to be searched
Created in NX6.0.0.



License requirements : None

NXOpen::Tooling::ValidCheckBuilder::CheckingType NXOpen::Tooling::ValidCheckBuilder::CheckType ( )

Returns the check type
Created in NX6.0.0.



License requirements : None

NXString NXOpen::Tooling::ValidCheckBuilder::ClrSetName ( )

Returns the clearance set name
Created in NX6.0.0.



License requirements : None

double NXOpen::Tooling::ValidCheckBuilder::ClrZone ( )

Returns the clearance zone
Created in NX6.0.0.



License requirements : None

NXOpen::SelectNXObjectList* NXOpen::Tooling::ValidCheckBuilder::ObjSelectTarget ( )

Returns the target object selection list
Created in NX6.0.0.



License requirements : None

NXOpen::SelectNXObjectList* NXOpen::Tooling::ValidCheckBuilder::ObjSelectTool ( )

Returns the tool object selection list
Created in NX6.0.0.



License requirements : None

NXOpen::Tooling::ValidCheckBuilder::SelMode NXOpen::Tooling::ValidCheckBuilder::ObjSelectType ( )

Returns the object selection type
Created in NX6.0.0.



License requirements : None

void NXOpen::Tooling::ValidCheckBuilder::RemoveDataSet ( const NXString dataSetName)

The action to delete a data set
Created in NX11.0.0.



License requirements : ug_mold_design ("UG MOLD") OR prog_die_wizard ("UG/Progressive Die Wizard")

Parameters
dataSetNamedatasetname
void NXOpen::Tooling::ValidCheckBuilder::RemoveDataSet ( const char *  dataSetName)

The action to delete a data set
Created in NX11.0.0.



License requirements : ug_mold_design ("UG MOLD") OR prog_die_wizard ("UG/Progressive Die Wizard")

Parameters
dataSetNamedatasetname
bool NXOpen::Tooling::ValidCheckBuilder::ScrewCheck ( )

Returns the screw check, to specify if screw check algorithm needs to be used
Created in NX6.0.0.



License requirements : None

NXString NXOpen::Tooling::ValidCheckBuilder::SelectDatasetsName ( )

Returns the box list selected sets name
Created in NX6.0.0.



License requirements : None

NXString NXOpen::Tooling::ValidCheckBuilder::SelectStandardSetsSpreadsheet ( )

Returns the standard sets spreadsheet
Created in NX11.0.0.



License requirements : None

void NXOpen::Tooling::ValidCheckBuilder::SetAnalyMode ( NXOpen::Tooling::ValidCheckBuilder::AnalysisMode  analyMode)

Sets the analysis mode
Created in NX6.0.0.



License requirements : solid_modeling ("SOLIDS MODELING")

Parameters
analyModeIndicates analysis mode to do checking
void NXOpen::Tooling::ValidCheckBuilder::SetBlankBody ( bool  blankBody)

Sets the blank body, to specify if blanked bodies in a component needs to be searched
Created in NX6.0.0.



License requirements : solid_modeling ("SOLIDS MODELING")

Parameters
blankBodyIndicates if blanked body is included while doing checking
void NXOpen::Tooling::ValidCheckBuilder::SetCheckType ( NXOpen::Tooling::ValidCheckBuilder::CheckingType  checkType)

Sets the check type
Created in NX6.0.0.



License requirements : solid_modeling ("SOLIDS MODELING")

Parameters
checkTypeIndicates checking type
void NXOpen::Tooling::ValidCheckBuilder::SetClrSetName ( const NXString clrSetName)

Sets the clearance set name
Created in NX6.0.0.



License requirements : solid_modeling ("SOLIDS MODELING")

Parameters
clrSetNameSpecifies a user defined clearance set name
void NXOpen::Tooling::ValidCheckBuilder::SetClrSetName ( const char *  clrSetName)

Sets the clearance set name
Created in NX6.0.0.



License requirements : solid_modeling ("SOLIDS MODELING")

Parameters
clrSetNameSpecifies a user defined clearance set name
void NXOpen::Tooling::ValidCheckBuilder::SetClrZone ( double  clrZone)

Sets the clearance zone
Created in NX6.0.0.



License requirements : solid_modeling ("SOLIDS MODELING")

Parameters
clrZoneSpecifies clearance zone value
void NXOpen::Tooling::ValidCheckBuilder::SetObjSelectType ( NXOpen::Tooling::ValidCheckBuilder::SelMode  objSelectType)

Sets the object selection type
Created in NX6.0.0.



License requirements : solid_modeling ("SOLIDS MODELING")

Parameters
objSelectTypeIndicates selection type
void NXOpen::Tooling::ValidCheckBuilder::SetScrewCheck ( bool  screwCheck)

Sets the screw check, to specify if screw check algorithm needs to be used
Created in NX6.0.0.



License requirements : solid_modeling ("SOLIDS MODELING")

Parameters
screwCheckIndicates if screw checking algorithm is used while doing checking
void NXOpen::Tooling::ValidCheckBuilder::SetSelectDatasetsName ( const NXString selDataSetName)

Sets the box list selected sets name
Created in NX6.0.0.



License requirements : solid_modeling ("SOLIDS MODELING")

Parameters
selDataSetNameSpecifies a user selected data set name
void NXOpen::Tooling::ValidCheckBuilder::SetSelectDatasetsName ( const char *  selDataSetName)

Sets the box list selected sets name
Created in NX6.0.0.



License requirements : solid_modeling ("SOLIDS MODELING")

Parameters
selDataSetNameSpecifies a user selected data set name
void NXOpen::Tooling::ValidCheckBuilder::SetSelectStandardSetsSpreadsheet ( const NXString filename)

Sets the standard sets spreadsheet
Created in NX11.0.0.



License requirements : ug_mold_design ("UG MOLD") OR prog_die_wizard ("UG/Progressive Die Wizard")

Parameters
filenamefilename
void NXOpen::Tooling::ValidCheckBuilder::SetSelectStandardSetsSpreadsheet ( const char *  filename)

Sets the standard sets spreadsheet
Created in NX11.0.0.



License requirements : ug_mold_design ("UG MOLD") OR prog_die_wizard ("UG/Progressive Die Wizard")

Parameters
filenamefilename
void NXOpen::Tooling::ValidCheckBuilder::SetSubAssembly ( bool  subAssembly)

Sets the sub-assembly, to specify if sub-assembly needs to be searched
Created in NX6.0.0.



License requirements : solid_modeling ("SOLIDS MODELING")

Parameters
subAssemblyIndicates if sub-assembly is included while doing checking
void NXOpen::Tooling::ValidCheckBuilder::StdAddUserSets ( )

Adds standard part into user defined set
Created in NX6.0.0.



License requirements : solid_modeling ("SOLIDS MODELING")

void NXOpen::Tooling::ValidCheckBuilder::StdLoadFile ( )

Loads standard attribute list
Created in NX6.0.0.



License requirements : solid_modeling ("SOLIDS MODELING")

bool NXOpen::Tooling::ValidCheckBuilder::SubAssembly ( )

Returns the sub-assembly, to specify if sub-assembly needs to be searched
Created in NX6.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.