SearchCriteriaSurfaceFinishBuilder Class

class NXOpen.Annotations.SearchCriteriaSurfaceFinishBuilder

Bases: NXOpen.Builder

Represents SearchCriteriaSurfaceFinishBuilder

To create a new instance of this class, use NXOpen.Annotations.SearchModelViewCollection.CreateSearchCriteriaSurfaceFinishBuilder()

New in version NX7.5.0.

Properties

Property	Description
ByCutoff	Returns or sets the cutoff toggle
ByLaySymbol	Returns or sets the lay symbol toggle
ByLowerText	Returns or sets the lower text toggle
ByLowerTolerance	Returns or sets the lower tolerance toggle
ByMachining	Returns or sets the machining toggle
ByMachiningToleranceType	Returns or sets the tolerance type toggle
ByProductionProcess	Returns or sets the production process toggle
ByRoughness	Returns or sets the roughness toggle
BySecondaryRoughness	Returns or sets the secondary roughness toggle
BySurfaceFinishType	Returns or sets the surface finish type toggle
ByTertiaryRoughness	Returns or sets the option to decide if searching the surface finish by the tertiary roughness
ByTolerance	Returns or sets the tolerance toggle
ByUpperText	Returns or sets the upper text toggle
ByUpperTolerance	Returns or sets the upper tolerance toggle
ByWavinessText	Returns or sets the waviness text toggle
CutoffText	Returns or sets the cutoff text
CutoffType	Returns or sets the cutoff enum
LaySymbolText	Returns or sets the lay symbol text
LaySymbolType	Returns or sets the lay symbol enum
LowerTextText	Returns or sets the lower text text
LowerTextType	Returns or sets the lower text enum
LowerToleranceType	Returns or sets the lower tolerance enum
LowerToleranceValue	Returns or sets the lower tolerance value
MachiningText	Returns or sets the machining text
MachiningToleranceType	Returns or sets the tolerance type enum
MachiningType	Returns or sets the machining enum
ProductionProcessText	Returns or sets the production process text
ProductionProcessType	Returns or sets the production process enum
RoughnessText	Returns or sets the roughness text
RoughnessType	Returns or sets the roughness enum
SecondaryRoughnessText	Returns or sets the secondary roughness text
SecondaryRoughnessType	Returns or sets the secondary roughness enum
SurfaceFinishType	Returns or sets the surface finish type
Tag	Returns the Tag for this object.
TertiaryRoughnessText	Returns or sets the tertiary roughness text
TertiaryRoughnessType	Returns or sets the tertiary roughness enum
ToleranceType	Returns or sets the tolerance enum
ToleranceValue	Returns or sets the tolerance value
UpperTextText	Returns or sets the upper text text
UpperTextType	Returns or sets the upper text enum
UpperToleranceType	Returns or sets the upper tolerance enum
UpperToleranceValue	Returns or sets the upper tolerance value
WavinessText	Returns or sets the waviness text
WavinessTextType	Returns or sets the waviness text enum

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

SearchCriteriaSurfaceFinishBuilderSurfaceFinishTypes Enumeration	Lists the search pmi surface finish type
SearchCriteriaSurfaceFinishBuilderToleranceTypeOptions Enumeration	Lists the Tolerance type of surface finish value

Property Detail

ByCutoff

SearchCriteriaSurfaceFinishBuilder.ByCutoff

Returns or sets the cutoff toggle

-------------------------------------

Getter Method

Signature ByCutoff

Returns: Return type:bool

New in version NX7.5.0.

License requirements: None.

-------------------------------------

Setter Method

Signature ByCutoff

Parameters:cutoff (bool) –

New in version NX7.5.0.

License requirements: None.

ByLaySymbol

SearchCriteriaSurfaceFinishBuilder.ByLaySymbol

Returns or sets the lay symbol toggle

-------------------------------------

Getter Method

Signature ByLaySymbol

Returns: Return type:bool

New in version NX7.5.0.

License requirements: None.

-------------------------------------

Setter Method

Signature ByLaySymbol

Parameters:laySymbol (bool) –

New in version NX7.5.0.

License requirements: None.

ByLowerText

SearchCriteriaSurfaceFinishBuilder.ByLowerText

Returns or sets the lower text toggle

-------------------------------------

Getter Method

Signature ByLowerText

Returns: Return type:bool

New in version NX7.5.0.

License requirements: None.

-------------------------------------

Setter Method

Signature ByLowerText

Parameters:lowerText (bool) –

New in version NX7.5.0.

License requirements: None.

ByLowerTolerance

SearchCriteriaSurfaceFinishBuilder.ByLowerTolerance

Returns or sets the lower tolerance toggle

-------------------------------------

Getter Method

Signature ByLowerTolerance

Returns: Return type:bool

New in version NX7.5.0.

License requirements: None.

-------------------------------------

Setter Method

Signature ByLowerTolerance

Parameters:lowerTolerance (bool) –

New in version NX7.5.0.

License requirements: None.

ByMachining

SearchCriteriaSurfaceFinishBuilder.ByMachining

Returns or sets the machining toggle

-------------------------------------

Getter Method

Signature ByMachining

Returns: Return type:bool

New in version NX7.5.0.

License requirements: None.

-------------------------------------

Setter Method

Signature ByMachining

Parameters:machining (bool) –

New in version NX7.5.0.

License requirements: None.

ByMachiningToleranceType

SearchCriteriaSurfaceFinishBuilder.ByMachiningToleranceType

Returns or sets the tolerance type toggle

-------------------------------------

Getter Method

Signature ByMachiningToleranceType

Returns: Return type:bool

New in version NX7.5.0.

License requirements: None.

-------------------------------------

Setter Method

Signature ByMachiningToleranceType

Parameters:byMachiningToleranceType (bool) –

New in version NX7.5.0.

License requirements: None.

ByProductionProcess

SearchCriteriaSurfaceFinishBuilder.ByProductionProcess

Returns or sets the production process toggle

-------------------------------------

Getter Method

Signature ByProductionProcess

Returns: Return type:bool

New in version NX7.5.0.

License requirements: None.

-------------------------------------

Setter Method

Signature ByProductionProcess

Parameters:productionProcess (bool) –

New in version NX7.5.0.

License requirements: None.

ByRoughness

SearchCriteriaSurfaceFinishBuilder.ByRoughness

Returns or sets the roughness toggle

-------------------------------------

Getter Method

Signature ByRoughness

Returns: Return type:bool

New in version NX7.5.0.

License requirements: None.

-------------------------------------

Setter Method

Signature ByRoughness

Parameters:roughness (bool) –

New in version NX7.5.0.

License requirements: None.

BySecondaryRoughness

SearchCriteriaSurfaceFinishBuilder.BySecondaryRoughness

Returns or sets the secondary roughness toggle

-------------------------------------

Getter Method

Signature BySecondaryRoughness

Returns: Return type:bool

New in version NX7.5.0.

License requirements: None.

-------------------------------------

Setter Method

Signature BySecondaryRoughness

Parameters:secondaryRoughness (bool) –

New in version NX7.5.0.

License requirements: None.

BySurfaceFinishType

SearchCriteriaSurfaceFinishBuilder.BySurfaceFinishType

Returns or sets the surface finish type toggle

-------------------------------------

Getter Method

Signature BySurfaceFinishType

Returns: Return type:bool

New in version NX7.5.0.

License requirements: None.

-------------------------------------

Setter Method

Signature BySurfaceFinishType

Parameters:surfaceFinishType (bool) –

New in version NX7.5.0.

License requirements: None.

ByTertiaryRoughness

SearchCriteriaSurfaceFinishBuilder.ByTertiaryRoughness

Returns or sets the option to decide if searching the surface finish by the tertiary roughness

-------------------------------------

Getter Method

Signature ByTertiaryRoughness

Returns: Return type:bool

New in version NX9.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature ByTertiaryRoughness

Parameters:tertiaryRoughness (bool) –

New in version NX9.0.0.

License requirements: None.

ByTolerance

SearchCriteriaSurfaceFinishBuilder.ByTolerance

Returns or sets the tolerance toggle

-------------------------------------

Getter Method

Signature ByTolerance

Returns: Return type:bool

New in version NX7.5.0.

License requirements: None.

-------------------------------------

Setter Method

Signature ByTolerance

Parameters:tolerance (bool) –

New in version NX7.5.0.

License requirements: None.

ByUpperText

SearchCriteriaSurfaceFinishBuilder.ByUpperText

Returns or sets the upper text toggle

-------------------------------------

Getter Method

Signature ByUpperText

Returns: Return type:bool

New in version NX7.5.0.

License requirements: None.

-------------------------------------

Setter Method

Signature ByUpperText

Parameters:upperText (bool) –

New in version NX7.5.0.

License requirements: None.

ByUpperTolerance

SearchCriteriaSurfaceFinishBuilder.ByUpperTolerance

Returns or sets the upper tolerance toggle

-------------------------------------

Getter Method

Signature ByUpperTolerance

Returns: Return type:bool

New in version NX7.5.0.

License requirements: None.

-------------------------------------

Setter Method

Signature ByUpperTolerance

Parameters:upperTolerance (bool) –

New in version NX7.5.0.

License requirements: None.

ByWavinessText

SearchCriteriaSurfaceFinishBuilder.ByWavinessText

Returns or sets the waviness text toggle

-------------------------------------

Getter Method

Signature ByWavinessText

Returns: Return type:bool

New in version NX7.5.0.

License requirements: None.

-------------------------------------

Setter Method

Signature ByWavinessText

Parameters:wavinessText (bool) –

New in version NX7.5.0.

License requirements: None.

CutoffText

SearchCriteriaSurfaceFinishBuilder.CutoffText

Returns or sets the cutoff text

-------------------------------------

Getter Method

Signature CutoffText

Returns: Return type:str

New in version NX7.5.0.

License requirements: None.

-------------------------------------

Setter Method

Signature CutoffText

Parameters:cutoffText (str) –

New in version NX7.5.0.

License requirements: None.

CutoffType

SearchCriteriaSurfaceFinishBuilder.CutoffType

Returns or sets the cutoff enum

-------------------------------------

Getter Method

Signature CutoffType

Returns: Return type:NXOpen.Annotations.SearchModelViewBuilderTextComparisionOptions

New in version NX7.5.0.

License requirements: None.

-------------------------------------

Setter Method

Signature CutoffType

Parameters:cutoffType (NXOpen.Annotations.SearchModelViewBuilderTextComparisionOptions) –

New in version NX7.5.0.

License requirements: None.

LaySymbolText

SearchCriteriaSurfaceFinishBuilder.LaySymbolText

Returns or sets the lay symbol text

-------------------------------------

Getter Method

Signature LaySymbolText

Returns: Return type:str

New in version NX7.5.0.

License requirements: None.

-------------------------------------

Setter Method

Signature LaySymbolText

Parameters:laySymbolText (str) –

New in version NX7.5.0.

License requirements: None.

LaySymbolType

SearchCriteriaSurfaceFinishBuilder.LaySymbolType

Returns or sets the lay symbol enum

-------------------------------------

Getter Method

Signature LaySymbolType

Returns: Return type:NXOpen.Annotations.SearchModelViewBuilderTextComparisionOptions

New in version NX7.5.0.

License requirements: None.

-------------------------------------

Setter Method

Signature LaySymbolType

Parameters:laySymbolType (NXOpen.Annotations.SearchModelViewBuilderTextComparisionOptions) –

New in version NX7.5.0.

License requirements: None.

LowerTextText

SearchCriteriaSurfaceFinishBuilder.LowerTextText

Returns or sets the lower text text

-------------------------------------

Getter Method

Signature LowerTextText

Returns: Return type:str

New in version NX7.5.0.

License requirements: None.

-------------------------------------

Setter Method

Signature LowerTextText

Parameters:lowerTextText (str) –

New in version NX7.5.0.

License requirements: None.

LowerTextType

SearchCriteriaSurfaceFinishBuilder.LowerTextType

Returns or sets the lower text enum

-------------------------------------

Getter Method

Signature LowerTextType

Returns: Return type:NXOpen.Annotations.SearchModelViewBuilderTextComparisionOptions

New in version NX7.5.0.

License requirements: None.

-------------------------------------

Setter Method

Signature LowerTextType

Parameters:lowerTextType (NXOpen.Annotations.SearchModelViewBuilderTextComparisionOptions) –

New in version NX7.5.0.

License requirements: None.

LowerToleranceType

SearchCriteriaSurfaceFinishBuilder.LowerToleranceType

Returns or sets the lower tolerance enum

-------------------------------------

Getter Method

Signature LowerToleranceType

Returns: Return type:NXOpen.Annotations.SearchModelViewBuilderValueComparisionOptions

New in version NX7.5.0.

License requirements: None.

-------------------------------------

Setter Method

Signature LowerToleranceType

Parameters:lowerToleranceType (NXOpen.Annotations.SearchModelViewBuilderValueComparisionOptions) –

New in version NX7.5.0.

License requirements: None.

LowerToleranceValue

SearchCriteriaSurfaceFinishBuilder.LowerToleranceValue

Returns or sets the lower tolerance value

-------------------------------------

Getter Method

Signature LowerToleranceValue

Returns: Return type:float

New in version NX7.5.0.

License requirements: None.

-------------------------------------

Setter Method

Signature LowerToleranceValue

Parameters:lowerToleranceValue (float) –

New in version NX7.5.0.

License requirements: None.

MachiningText

SearchCriteriaSurfaceFinishBuilder.MachiningText

Returns or sets the machining text

-------------------------------------

Getter Method

Signature MachiningText

Returns: Return type:str

New in version NX7.5.0.

License requirements: None.

-------------------------------------

Setter Method

Signature MachiningText

Parameters:machiningText (str) –

New in version NX7.5.0.

License requirements: None.

MachiningToleranceType

SearchCriteriaSurfaceFinishBuilder.MachiningToleranceType

Returns or sets the tolerance type enum

-------------------------------------

Getter Method

Signature MachiningToleranceType

Returns: Return type:NXOpen.Annotations.SearchCriteriaSurfaceFinishBuilderToleranceTypeOptions

New in version NX7.5.0.

License requirements: None.

-------------------------------------

Setter Method

Signature MachiningToleranceType

Parameters:machiningToleranceType (NXOpen.Annotations.SearchCriteriaSurfaceFinishBuilderToleranceTypeOptions) –

New in version NX7.5.0.

License requirements: None.

MachiningType

SearchCriteriaSurfaceFinishBuilder.MachiningType

Returns or sets the machining enum

-------------------------------------

Getter Method

Signature MachiningType

Returns: Return type:NXOpen.Annotations.SearchModelViewBuilderTextComparisionOptions

New in version NX7.5.0.

License requirements: None.

-------------------------------------

Setter Method

Signature MachiningType

Parameters:machiningType (NXOpen.Annotations.SearchModelViewBuilderTextComparisionOptions) –

New in version NX7.5.0.

License requirements: None.

ProductionProcessText

SearchCriteriaSurfaceFinishBuilder.ProductionProcessText

Returns or sets the production process text

-------------------------------------

Getter Method

Signature ProductionProcessText

Returns: Return type:str

New in version NX7.5.0.

License requirements: None.

-------------------------------------

Setter Method

Signature ProductionProcessText

Parameters:productionProcessText (str) –

New in version NX7.5.0.

License requirements: None.

ProductionProcessType

SearchCriteriaSurfaceFinishBuilder.ProductionProcessType

Returns or sets the production process enum

-------------------------------------

Getter Method

Signature ProductionProcessType

Returns: Return type:NXOpen.Annotations.SearchModelViewBuilderTextComparisionOptions

New in version NX7.5.0.

License requirements: None.

-------------------------------------

Setter Method

Signature ProductionProcessType

Parameters:productionProcessType (NXOpen.Annotations.SearchModelViewBuilderTextComparisionOptions) –

New in version NX7.5.0.

License requirements: None.

RoughnessText

SearchCriteriaSurfaceFinishBuilder.RoughnessText

Returns or sets the roughness text

-------------------------------------

Getter Method

Signature RoughnessText

Returns: Return type:str

New in version NX7.5.0.

License requirements: None.

-------------------------------------

Setter Method

Signature RoughnessText

Parameters:roughnessText (str) –

New in version NX7.5.0.

License requirements: None.

RoughnessType

SearchCriteriaSurfaceFinishBuilder.RoughnessType

Returns or sets the roughness enum

-------------------------------------

Getter Method

Signature RoughnessType

Returns: Return type:NXOpen.Annotations.SearchModelViewBuilderTextComparisionOptions

New in version NX7.5.0.

License requirements: None.

-------------------------------------

Setter Method

Signature RoughnessType

Parameters:roughnessType (NXOpen.Annotations.SearchModelViewBuilderTextComparisionOptions) –

New in version NX7.5.0.

License requirements: None.

SecondaryRoughnessText

SearchCriteriaSurfaceFinishBuilder.SecondaryRoughnessText

Returns or sets the secondary roughness text

-------------------------------------

Getter Method

Signature SecondaryRoughnessText

Returns: Return type:str

New in version NX7.5.0.

License requirements: None.

-------------------------------------

Setter Method

Signature SecondaryRoughnessText

Parameters:secondaryRoughnessText (str) –

New in version NX7.5.0.

License requirements: None.

SecondaryRoughnessType

SearchCriteriaSurfaceFinishBuilder.SecondaryRoughnessType

Returns or sets the secondary roughness enum

-------------------------------------

Getter Method

Signature SecondaryRoughnessType

Returns: Return type:NXOpen.Annotations.SearchModelViewBuilderTextComparisionOptions

New in version NX7.5.0.

License requirements: None.

-------------------------------------

Setter Method

Signature SecondaryRoughnessType

Parameters:secondaryRoughnessType (NXOpen.Annotations.SearchModelViewBuilderTextComparisionOptions) –

New in version NX7.5.0.

License requirements: None.

SurfaceFinishType

SearchCriteriaSurfaceFinishBuilder.SurfaceFinishType

Returns or sets the surface finish type

-------------------------------------

Getter Method

Signature SurfaceFinishType

Returns: Return type:NXOpen.Annotations.SearchCriteriaSurfaceFinishBuilderSurfaceFinishTypes

New in version NX7.5.0.

License requirements: None.

-------------------------------------

Setter Method

Signature SurfaceFinishType

Parameters:surfaceFinishType (NXOpen.Annotations.SearchCriteriaSurfaceFinishBuilderSurfaceFinishTypes) –

New in version NX7.5.0.

License requirements: None.

TertiaryRoughnessText

SearchCriteriaSurfaceFinishBuilder.TertiaryRoughnessText

Returns or sets the tertiary roughness text

-------------------------------------

Getter Method

Signature TertiaryRoughnessText

Returns: Return type:str

New in version NX9.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature TertiaryRoughnessText

Parameters:tertiaryRoughnessText (str) –

New in version NX9.0.0.

License requirements: None.

TertiaryRoughnessType

SearchCriteriaSurfaceFinishBuilder.TertiaryRoughnessType

Returns or sets the tertiary roughness enum

-------------------------------------

Getter Method

Signature TertiaryRoughnessType

Returns: Return type:NXOpen.Annotations.SearchModelViewBuilderTextComparisionOptions

New in version NX9.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature TertiaryRoughnessType

Parameters:tertiaryRoughnessType (NXOpen.Annotations.SearchModelViewBuilderTextComparisionOptions) –

New in version NX9.0.0.

License requirements: None.

ToleranceType

SearchCriteriaSurfaceFinishBuilder.ToleranceType

Returns or sets the tolerance enum

-------------------------------------

Getter Method

Signature ToleranceType

Returns: Return type:NXOpen.Annotations.SearchModelViewBuilderValueComparisionOptions

New in version NX7.5.0.

License requirements: None.

-------------------------------------

Setter Method

Signature ToleranceType

Parameters:toleranceType (NXOpen.Annotations.SearchModelViewBuilderValueComparisionOptions) –

New in version NX7.5.0.

License requirements: None.

ToleranceValue

SearchCriteriaSurfaceFinishBuilder.ToleranceValue

Returns or sets the tolerance value

-------------------------------------

Getter Method

Signature ToleranceValue

Returns: Return type:float

New in version NX7.5.0.

License requirements: None.

-------------------------------------

Setter Method

Signature ToleranceValue

Parameters:toleranceValue (float) –

New in version NX7.5.0.

License requirements: None.

UpperTextText

SearchCriteriaSurfaceFinishBuilder.UpperTextText

Returns or sets the upper text text

-------------------------------------

Getter Method

Signature UpperTextText

Returns: Return type:str

New in version NX7.5.0.

License requirements: None.

-------------------------------------

Setter Method

Signature UpperTextText

Parameters:upperTextText (str) –

New in version NX7.5.0.

License requirements: None.

UpperTextType

SearchCriteriaSurfaceFinishBuilder.UpperTextType

Returns or sets the upper text enum

-------------------------------------

Getter Method

Signature UpperTextType

Returns: Return type:NXOpen.Annotations.SearchModelViewBuilderTextComparisionOptions

New in version NX7.5.0.

License requirements: None.

-------------------------------------

Setter Method

Signature UpperTextType

Parameters:upperTextType (NXOpen.Annotations.SearchModelViewBuilderTextComparisionOptions) –

New in version NX7.5.0.

License requirements: None.

UpperToleranceType

SearchCriteriaSurfaceFinishBuilder.UpperToleranceType

Returns or sets the upper tolerance enum

-------------------------------------

Getter Method

Signature UpperToleranceType

Returns: Return type:NXOpen.Annotations.SearchModelViewBuilderValueComparisionOptions

New in version NX7.5.0.

License requirements: None.

-------------------------------------

Setter Method

Signature UpperToleranceType

Parameters:upperToleranceType (NXOpen.Annotations.SearchModelViewBuilderValueComparisionOptions) –

New in version NX7.5.0.

License requirements: None.

UpperToleranceValue

SearchCriteriaSurfaceFinishBuilder.UpperToleranceValue

Returns or sets the upper tolerance value

-------------------------------------

Getter Method

Signature UpperToleranceValue

Returns: Return type:float

New in version NX7.5.0.

License requirements: None.

-------------------------------------

Setter Method

Signature UpperToleranceValue

Parameters:upperToleranceValue (float) –

New in version NX7.5.0.

License requirements: None.

WavinessText

SearchCriteriaSurfaceFinishBuilder.WavinessText

Returns or sets the waviness text

-------------------------------------

Getter Method

Signature WavinessText

Returns: Return type:str

New in version NX7.5.0.

License requirements: None.

-------------------------------------

Setter Method

Signature WavinessText

Parameters:wavinessText (str) –

New in version NX7.5.0.

License requirements: None.

WavinessTextType

SearchCriteriaSurfaceFinishBuilder.WavinessTextType

Returns or sets the waviness text enum

-------------------------------------

Getter Method

Signature WavinessTextType

Returns: Return type:NXOpen.Annotations.SearchModelViewBuilderTextComparisionOptions

New in version NX7.5.0.

License requirements: None.

-------------------------------------

Setter Method

Signature WavinessTextType

Parameters:wavinessTextType (NXOpen.Annotations.SearchModelViewBuilderTextComparisionOptions) –

New in version NX7.5.0.

License requirements: None.

Method Detail

Validate

SearchCriteriaSurfaceFinishBuilder.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.