ValidCheckBuilder Class¶
-
class
NXOpen.Tooling.
ValidCheckBuilder
¶ Bases:
NXOpen.Builder
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 New in version NX6.0.0.
Properties¶
Property | Description |
---|---|
AnalyMode | Returns or sets the analysis mode |
BlankBody | Returns or sets the blank body, to specify if blanked bodies in a component needs to be searched |
CheckType | Returns or sets the check type |
ClrSetName | Returns or sets the clearance set name |
ClrZone | Returns or sets the clearance zone |
ObjSelectTarget | Returns the target object selection list |
ObjSelectTool | Returns the tool object selection list |
ObjSelectType | Returns or sets the object selection type |
ScrewCheck | Returns or sets the screw check, to specify if screw check algorithm needs to be used |
SelectDatasetsName | Returns or sets the box list selected sets name |
SelectStandardSetsSpreadsheet | Returns or sets the standard sets spreadsheet |
SubAssembly | Returns or sets the sub-assembly, to specify if sub-assembly needs to be searched |
Tag | Returns the Tag for this object. |
Methods¶
Method | Description |
---|---|
Commit | Commits any edits that have been applied to the builder. |
Destroy | Deletes the builder, and cleans up any objects created by the builder. |
GetCommittedObjects | For builders that create more than one object, this method returns the objects that are created by commit. |
GetObject | Returns the object currently being edited by this builder. |
RemoveDataSet | The action to delete a data set |
ShowResults | Updates the model to reflect the result of an edit to the model for all builders that support showing results. |
StdAddUserSets | Adds standard part into user defined set |
StdLoadFile | Loads standard attribute list |
Validate | Validate whether the inputs to the component are sufficient for commit to be called. |
Enumerations¶
ValidCheckBuilderAnalysisMode Enumeration | the analysis mode, including solid-based mode and facet-based mode |
ValidCheckBuilderCheckingType Enumeration | the checking type, including true body, false body or both |
ValidCheckBuilderSelMode Enumeration | the selection type, including component and solid body |
Property Detail¶
AnalyMode¶
-
ValidCheckBuilder.
AnalyMode
¶ Returns or sets the analysis mode
-------------------------------------
Getter Method
Signature
AnalyMode
Returns: Retruns analysis mode to do checking Return type: NXOpen.Tooling.ValidCheckBuilderAnalysisMode
New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
AnalyMode
Parameters: analyMode ( NXOpen.Tooling.ValidCheckBuilderAnalysisMode
) – Indicates analysis mode to do checkingNew in version NX6.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”)
BlankBody¶
-
ValidCheckBuilder.
BlankBody
¶ Returns or sets the blank body, to specify if blanked bodies in a component needs to be searched
-------------------------------------
Getter Method
Signature
BlankBody
Returns: Get if blanked body is included while doing checking Return type: bool New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
BlankBody
Parameters: blankBody (bool) – Indicates if blanked body is included while doing checking New in version NX6.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”)
CheckType¶
-
ValidCheckBuilder.
CheckType
¶ Returns or sets the check type
-------------------------------------
Getter Method
Signature
CheckType
Returns: Retruns checking type Return type: NXOpen.Tooling.ValidCheckBuilderCheckingType
New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
CheckType
Parameters: checkType ( NXOpen.Tooling.ValidCheckBuilderCheckingType
) – Indicates checking typeNew in version NX6.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”)
ClrSetName¶
-
ValidCheckBuilder.
ClrSetName
¶ Returns or sets the clearance set name
-------------------------------------
Getter Method
Signature
ClrSetName
Returns: Retruns clearance set name Return type: str New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ClrSetName
Parameters: clrSetName (str) – Specifies a user defined clearance set name New in version NX6.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”)
ClrZone¶
-
ValidCheckBuilder.
ClrZone
¶ Returns or sets the clearance zone
-------------------------------------
Getter Method
Signature
ClrZone
Returns: Retruns clearance zone value Return type: float New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ClrZone
Parameters: clrZone (float) – Specifies clearance zone value New in version NX6.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”)
ObjSelectTarget¶
-
ValidCheckBuilder.
ObjSelectTarget
¶ Returns the target object selection list
-------------------------------------
Getter Method
Signature
ObjSelectTarget
Returns: Retruns target objects list to do checking Return type: NXOpen.SelectNXObjectList
New in version NX6.0.0.
License requirements: None.
ObjSelectTool¶
-
ValidCheckBuilder.
ObjSelectTool
¶ Returns the tool object selection list
-------------------------------------
Getter Method
Signature
ObjSelectTool
Returns: Retruns tool objects list to do checking Return type: NXOpen.SelectNXObjectList
New in version NX6.0.0.
License requirements: None.
ObjSelectType¶
-
ValidCheckBuilder.
ObjSelectType
¶ Returns or sets the object selection type
-------------------------------------
Getter Method
Signature
ObjSelectType
Returns: Retruns selection type Return type: NXOpen.Tooling.ValidCheckBuilderSelMode
New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ObjSelectType
Parameters: objSelectType ( NXOpen.Tooling.ValidCheckBuilderSelMode
) – Indicates selection typeNew in version NX6.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”)
ScrewCheck¶
-
ValidCheckBuilder.
ScrewCheck
¶ Returns or sets the screw check, to specify if screw check algorithm needs to be used
-------------------------------------
Getter Method
Signature
ScrewCheck
Returns: Retruns the flag if screw checking algorithm is used while doing checking Return type: bool New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ScrewCheck
Parameters: screwCheck (bool) – Indicates if screw checking algorithm is used while doing checking New in version NX6.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”)
SelectDatasetsName¶
-
ValidCheckBuilder.
SelectDatasetsName
¶ Returns or sets the box list selected sets name
-------------------------------------
Getter Method
Signature
SelectDatasetsName
Returns: Retruns selected data set name Return type: str New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
SelectDatasetsName
Parameters: selDataSetName (str) – Specifies a user selected data set name New in version NX6.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”)
SelectStandardSetsSpreadsheet¶
-
ValidCheckBuilder.
SelectStandardSetsSpreadsheet
¶ Returns or sets the standard sets spreadsheet
-------------------------------------
Getter Method
Signature
SelectStandardSetsSpreadsheet
Returns: Return type: str New in version NX11.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
SelectStandardSetsSpreadsheet
Parameters: filename (str) – New in version NX11.0.0.
License requirements: ug_mold_design (“UG MOLD”) OR prog_die_wizard (“UG/Progressive Die Wizard”)
SubAssembly¶
-
ValidCheckBuilder.
SubAssembly
¶ Returns or sets the sub-assembly, to specify if sub-assembly needs to be searched
-------------------------------------
Getter Method
Signature
SubAssembly
Returns: Retruns the flag if sub-assembly is included while doing checking Return type: bool New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
SubAssembly
Parameters: subAssembly (bool) – Indicates if sub-assembly is included while doing checking New in version NX6.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”)
Method Detail¶
RemoveDataSet¶
-
ValidCheckBuilder.
RemoveDataSet
¶ The action to delete a data set
Signature
RemoveDataSet(dataSetName)
Parameters: dataSetName (str) – New in version NX11.0.0.
License requirements: ug_mold_design (“UG MOLD”) OR prog_die_wizard (“UG/Progressive Die Wizard”)
StdAddUserSets¶
-
ValidCheckBuilder.
StdAddUserSets
¶ Adds standard part into user defined set
Signature
StdAddUserSets()
New in version NX6.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”)
StdLoadFile¶
-
ValidCheckBuilder.
StdLoadFile
¶ Loads standard attribute list
Signature
StdLoadFile()
New in version NX6.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”)
Validate¶
-
ValidCheckBuilder.
Validate
¶ Validate whether the inputs to the component are sufficient for commit to be called.
If the component is not in a state to commit then an exception is thrown. For example, if the component requires you to set some property, this method will throw an exception if you haven’t set it. This method throws a not-yet-implemented NXException for some components.
Signature
Validate()
Returns: Was self validation successful Return type: bool New in version NX3.0.1.
License requirements: None.