GapFlushnessBuilder Class¶
-
class
NXOpen.GeometricAnalysis.
GapFlushnessBuilder
¶ Bases:
NXOpen.Builder
GapFlushnessBuilder class
To create a new instance of this class, use
NXOpen.GeometricAnalysis.AnalysisObjectCollection.CreateGapFlushnessBuilder()
Default values.
Property Value SampleNumber 10 New in version NX5.0.0.
Properties¶
Property | Description |
---|---|
BasePanelFaces | Returns the Base Panel face selection |
BasePanelInnerContactCurves | Returns the Base Panel inner contact section |
BasePanelOuterContactCurves | Returns the Base Panel outer contact section |
BasePanelType | Returns or sets the Base Panel type |
CrossSectionCurveOption | Returns or sets the cross section curve option |
CrossSectionCurves | Returns the Cross Section Curves |
EvaluationMode | Returns or sets the evaluation Method |
EvaluationPoint | Returns or sets the evaluation point |
EvaluationType | Returns or sets the evaluation type |
IsNegativeToleranceLabelDisplayed | Returns or sets the Label Display negative tolerance |
IsNominalLabelDisplayed | Returns or sets the Label Display Nominal |
IsPositiveToleranceLabelDisplayed | Returns or sets the Label Display positive tolerance |
LabelDisplayOption | Returns or sets the display option type |
NegativeFlushnessTolerance | Returns or sets the negative tolerance for flushness |
NegativeGapTolerance | Returns or sets the negative tolerance for gap |
NominalFlushness | Returns or sets the nominal value for flushness |
NominalGap | Returns or sets the nominal value for gap |
PositiveFlushnessTolerance | Returns or sets the positive tolerance for flushness |
PositiveGapTolerance | Returns or sets the positive tolerance for gap |
PreviewOption | Returns or sets the preview option |
SampleDistance | Returns the Sample Distance |
SampleNumber | Returns or sets the sample number |
SecondPanelFaces | Returns the Second Panel face selection |
SecondPanelInnerContactCurves | Returns the Second Panel inner contact section |
SecondPanelOuterContactCurves | Returns the Second Panel outer contact section |
SecondPanelType | Returns or sets the Second Panel type |
SectionAlignment | Returns or sets the Section Alignment |
SectionAlignmentDirection | Returns or sets the section alignment vector |
ShowOutRangeLabels | Returns or sets the show out of range labels |
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. |
ShowResults | Updates the model to reflect the result of an edit to the model for all builders that support showing results. |
Validate | Validate whether the inputs to the component are sufficient for commit to be called. |
Enumerations¶
GapFlushnessBuilderDisplayOptions Enumeration | This enum represents Label Display Option type |
GapFlushnessBuilderEvaluationModes Enumeration | This enum represents evaluation mode |
GapFlushnessBuilderEvaluationTypes Enumeration | This enum represents the Gap and Flushness Analysis Object evaluation types |
GapFlushnessBuilderPanelTypes Enumeration | This enum represents panel type |
GapFlushnessBuilderSectionAlignments Enumeration | This enum represents cross-section alignment type |
GapFlushnessBuilderSectionCurveOptions Enumeration | This enum represents Cross Section Curves Options |
Property Detail¶
BasePanelFaces¶
-
GapFlushnessBuilder.
BasePanelFaces
¶ Returns the Base Panel face selection
-------------------------------------
Getter Method
Signature
BasePanelFaces
Returns: Face collector Return type: NXOpen.ScCollector
New in version NX5.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”)
BasePanelInnerContactCurves¶
-
GapFlushnessBuilder.
BasePanelInnerContactCurves
¶ Returns the Base Panel inner contact section
-------------------------------------
Getter Method
Signature
BasePanelInnerContactCurves
Returns: curve/edge collector Return type: NXOpen.Section
New in version NX5.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”)
BasePanelOuterContactCurves¶
-
GapFlushnessBuilder.
BasePanelOuterContactCurves
¶ Returns the Base Panel outer contact section
-------------------------------------
Getter Method
Signature
BasePanelOuterContactCurves
Returns: curve/edge collector Return type: NXOpen.Section
New in version NX5.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”)
BasePanelType¶
-
GapFlushnessBuilder.
BasePanelType
¶ Returns or sets the Base Panel type
-------------------------------------
Getter Method
Signature
BasePanelType
Returns: Return type: NXOpen.GeometricAnalysis.GapFlushnessBuilderPanelTypes
New in version NX5.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”)
-------------------------------------
Setter Method
Signature
BasePanelType
Parameters: panelType ( NXOpen.GeometricAnalysis.GapFlushnessBuilderPanelTypes
) –New in version NX5.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”)
CrossSectionCurveOption¶
-
GapFlushnessBuilder.
CrossSectionCurveOption
¶ Returns or sets the cross section curve option
-------------------------------------
Getter Method
Signature
CrossSectionCurveOption
Returns: Return type: NXOpen.GeometricAnalysis.GapFlushnessBuilderSectionCurveOptions
New in version NX5.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”)
-------------------------------------
Setter Method
Signature
CrossSectionCurveOption
Parameters: sectionCurveOption ( NXOpen.GeometricAnalysis.GapFlushnessBuilderSectionCurveOptions
) –New in version NX5.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”)
CrossSectionCurves¶
-
GapFlushnessBuilder.
CrossSectionCurves
¶ Returns the Cross Section Curves
-------------------------------------
Getter Method
Signature
CrossSectionCurves
Returns: curve/edge collector Return type: NXOpen.Section
New in version NX5.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”)
EvaluationMode¶
-
GapFlushnessBuilder.
EvaluationMode
¶ Returns or sets the evaluation Method
-------------------------------------
Getter Method
Signature
EvaluationMode
Returns: Return type: NXOpen.GeometricAnalysis.GapFlushnessBuilderEvaluationModes
New in version NX5.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”)
-------------------------------------
Setter Method
Signature
EvaluationMode
Parameters: evaluationMode ( NXOpen.GeometricAnalysis.GapFlushnessBuilderEvaluationModes
) –New in version NX5.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”)
EvaluationPoint¶
-
GapFlushnessBuilder.
EvaluationPoint
¶ Returns or sets the evaluation point
-------------------------------------
Getter Method
Signature
EvaluationPoint
Returns: Evaluation point Return type: NXOpen.Point
New in version NX5.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”)
-------------------------------------
Setter Method
Signature
EvaluationPoint
Parameters: evaluationPoint ( NXOpen.Point
) – Evaluation pointNew in version NX5.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”)
EvaluationType¶
-
GapFlushnessBuilder.
EvaluationType
¶ Returns or sets the evaluation type
-------------------------------------
Getter Method
Signature
EvaluationType
Returns: Return type: NXOpen.GeometricAnalysis.GapFlushnessBuilderEvaluationTypes
New in version NX5.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”)
-------------------------------------
Setter Method
Signature
EvaluationType
Parameters: evaluationType ( NXOpen.GeometricAnalysis.GapFlushnessBuilderEvaluationTypes
) –New in version NX5.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”)
IsNegativeToleranceLabelDisplayed¶
-
GapFlushnessBuilder.
IsNegativeToleranceLabelDisplayed
¶ Returns or sets the Label Display negative tolerance
-------------------------------------
Getter Method
Signature
IsNegativeToleranceLabelDisplayed
Returns: Return type: bool New in version NX5.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”)
-------------------------------------
Setter Method
Signature
IsNegativeToleranceLabelDisplayed
Parameters: showlabelNegative (bool) – New in version NX5.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”)
IsNominalLabelDisplayed¶
-
GapFlushnessBuilder.
IsNominalLabelDisplayed
¶ Returns or sets the Label Display Nominal
-------------------------------------
Getter Method
Signature
IsNominalLabelDisplayed
Returns: Return type: bool New in version NX5.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”)
-------------------------------------
Setter Method
Signature
IsNominalLabelDisplayed
Parameters: showlabelNominal (bool) – New in version NX5.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”)
IsPositiveToleranceLabelDisplayed¶
-
GapFlushnessBuilder.
IsPositiveToleranceLabelDisplayed
¶ Returns or sets the Label Display positive tolerance
-------------------------------------
Getter Method
Signature
IsPositiveToleranceLabelDisplayed
Returns: Return type: bool New in version NX5.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”)
-------------------------------------
Setter Method
Signature
IsPositiveToleranceLabelDisplayed
Parameters: showlabelPositive (bool) – New in version NX5.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”)
LabelDisplayOption¶
-
GapFlushnessBuilder.
LabelDisplayOption
¶ Returns or sets the display option type
-------------------------------------
Getter Method
Signature
LabelDisplayOption
Returns: Return type: NXOpen.GeometricAnalysis.GapFlushnessBuilderDisplayOptions
New in version NX5.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”)
-------------------------------------
Setter Method
Signature
LabelDisplayOption
Parameters: displayOption ( NXOpen.GeometricAnalysis.GapFlushnessBuilderDisplayOptions
) –New in version NX5.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”)
NegativeFlushnessTolerance¶
-
GapFlushnessBuilder.
NegativeFlushnessTolerance
¶ Returns or sets the negative tolerance for flushness
-------------------------------------
Getter Method
Signature
NegativeFlushnessTolerance
Returns: Return type: float New in version NX5.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”)
-------------------------------------
Setter Method
Signature
NegativeFlushnessTolerance
Parameters: negativeTolFlush (float) – New in version NX5.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”)
NegativeGapTolerance¶
-
GapFlushnessBuilder.
NegativeGapTolerance
¶ Returns or sets the negative tolerance for gap
-------------------------------------
Getter Method
Signature
NegativeGapTolerance
Returns: Return type: float New in version NX5.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”)
-------------------------------------
Setter Method
Signature
NegativeGapTolerance
Parameters: negativeTolGap (float) – New in version NX5.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”)
NominalFlushness¶
-
GapFlushnessBuilder.
NominalFlushness
¶ Returns or sets the nominal value for flushness
-------------------------------------
Getter Method
Signature
NominalFlushness
Returns: Return type: float New in version NX5.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”)
-------------------------------------
Setter Method
Signature
NominalFlushness
Parameters: nominalFlush (float) – New in version NX5.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”)
NominalGap¶
-
GapFlushnessBuilder.
NominalGap
¶ Returns or sets the nominal value for gap
-------------------------------------
Getter Method
Signature
NominalGap
Returns: Return type: float New in version NX5.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”)
-------------------------------------
Setter Method
Signature
NominalGap
Parameters: nominalGap (float) – New in version NX5.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”)
PositiveFlushnessTolerance¶
-
GapFlushnessBuilder.
PositiveFlushnessTolerance
¶ Returns or sets the positive tolerance for flushness
-------------------------------------
Getter Method
Signature
PositiveFlushnessTolerance
Returns: Return type: float New in version NX5.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”)
-------------------------------------
Setter Method
Signature
PositiveFlushnessTolerance
Parameters: positiveTolFlush (float) – New in version NX5.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”)
PositiveGapTolerance¶
-
GapFlushnessBuilder.
PositiveGapTolerance
¶ Returns or sets the positive tolerance for gap
-------------------------------------
Getter Method
Signature
PositiveGapTolerance
Returns: Return type: float New in version NX5.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”)
-------------------------------------
Setter Method
Signature
PositiveGapTolerance
Parameters: positiveTolGap (float) – New in version NX5.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”)
PreviewOption¶
-
GapFlushnessBuilder.
PreviewOption
¶ Returns or sets the preview option
-------------------------------------
Getter Method
Signature
PreviewOption
Returns: Return type: bool New in version NX5.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”)
-------------------------------------
Setter Method
Signature
PreviewOption
Parameters: previewOption (bool) – New in version NX5.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”)
SampleDistance¶
-
GapFlushnessBuilder.
SampleDistance
¶ Returns the Sample Distance
-------------------------------------
Getter Method
Signature
SampleDistance
Returns: Sample distance Return type: NXOpen.Expression
New in version NX5.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”)
SampleNumber¶
-
GapFlushnessBuilder.
SampleNumber
¶ Returns or sets the sample number
-------------------------------------
Getter Method
Signature
SampleNumber
Returns: Return type: int New in version NX5.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”)
-------------------------------------
Setter Method
Signature
SampleNumber
Parameters: sampleNumber (int) – New in version NX5.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”)
SecondPanelFaces¶
-
GapFlushnessBuilder.
SecondPanelFaces
¶ Returns the Second Panel face selection
-------------------------------------
Getter Method
Signature
SecondPanelFaces
Returns: Face collector Return type: NXOpen.ScCollector
New in version NX5.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”)
SecondPanelInnerContactCurves¶
-
GapFlushnessBuilder.
SecondPanelInnerContactCurves
¶ Returns the Second Panel inner contact section
-------------------------------------
Getter Method
Signature
SecondPanelInnerContactCurves
Returns: curve/edge collector Return type: NXOpen.Section
New in version NX5.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”)
SecondPanelOuterContactCurves¶
-
GapFlushnessBuilder.
SecondPanelOuterContactCurves
¶ Returns the Second Panel outer contact section
-------------------------------------
Getter Method
Signature
SecondPanelOuterContactCurves
Returns: curve/edge collector Return type: NXOpen.Section
New in version NX5.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”)
SecondPanelType¶
-
GapFlushnessBuilder.
SecondPanelType
¶ Returns or sets the Second Panel type
-------------------------------------
Getter Method
Signature
SecondPanelType
Returns: Return type: NXOpen.GeometricAnalysis.GapFlushnessBuilderPanelTypes
New in version NX5.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”)
-------------------------------------
Setter Method
Signature
SecondPanelType
Parameters: panelType ( NXOpen.GeometricAnalysis.GapFlushnessBuilderPanelTypes
) –New in version NX5.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”)
SectionAlignment¶
-
GapFlushnessBuilder.
SectionAlignment
¶ Returns or sets the Section Alignment
-------------------------------------
Getter Method
Signature
SectionAlignment
Returns: Return type: NXOpen.GeometricAnalysis.GapFlushnessBuilderSectionAlignments
New in version NX5.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”)
-------------------------------------
Setter Method
Signature
SectionAlignment
Parameters: sectionAlignment ( NXOpen.GeometricAnalysis.GapFlushnessBuilderSectionAlignments
) –New in version NX5.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”)
SectionAlignmentDirection¶
-
GapFlushnessBuilder.
SectionAlignmentDirection
¶ Returns or sets the section alignment vector
-------------------------------------
Getter Method
Signature
SectionAlignmentDirection
Returns: Section Alignment Direction vector Return type: NXOpen.Direction
New in version NX5.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”)
-------------------------------------
Setter Method
Signature
SectionAlignmentDirection
Parameters: sectionAlignmentDirection ( NXOpen.Direction
) – Section Alignment Direction vectorNew in version NX5.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”)
ShowOutRangeLabels¶
-
GapFlushnessBuilder.
ShowOutRangeLabels
¶ Returns or sets the show out of range labels
-------------------------------------
Getter Method
Signature
ShowOutRangeLabels
Returns: Return type: bool New in version NX5.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”)
-------------------------------------
Setter Method
Signature
ShowOutRangeLabels
Parameters: showOutRangeLabels (bool) – New in version NX5.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”)
Method Detail¶
Validate¶
-
GapFlushnessBuilder.
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.