InspectionSurfaceFeatureBuilder Class¶
-
class
NXOpen.CAM.
InspectionSurfaceFeatureBuilder
¶ Bases:
NXOpen.CAM.OperationBuilder
Represents a CMM Inspection Curve Feature builder
To create a new instance of this class, use
NXOpen.CAM.InspectionOperationCollection.CreateInspectionSurfaceFeatureBuilder
New in version NX7.0.0.
Properties¶
Property | Description |
---|---|
ChannelName | Returns or sets the channel’s name |
CycleEvent | Returns the cycle event |
CycleTable | Returns the cycle |
Description | Returns or sets the description |
EndOfPath | Returns the end event builder |
EndUDistance | Returns or sets the end distance in the U direction |
EndUPercent | Returns or sets the end percent in the U direction |
EndUdeSet | Returns the end ude set |
EndVDistance | Returns or sets the end distance in the V direction |
EndVPercent | Returns or sets the end percent in the V direction |
Geometry | Returns the geometry builder |
GougeChecking | Returns or sets the gouge checking flag |
HoleAxisType | Returns or sets the Hole Axis Type |
HoleDepth | Returns the max depth distance builder |
HoleDepthType | Returns or sets the Hole Depth Type |
IsPointDefinitionChanged | Returns or sets the point data definition changed flag |
LayoutAndLayer | Returns the Layer and Layout |
MotionOutputBuilder | Returns the motion output builder |
Name | Returns or sets the name |
Notes | Returns the notes builder |
NumberOfUPoints | Returns or sets the number of U points |
NumberOfVPoints | Returns or sets the number of V points |
OptimizationBasedOn | Returns or sets the optimization based on in operation |
OptimizationDistanceMethod | Returns or sets the optimization distance method in operation |
OptimizationLevel | Returns or sets the optimization level in operation |
OptimizationMethod | Returns or sets the optim method |
PathDisplayOptions | Returns the path display options builder |
PointDataDefinition | Returns or sets the point data definition type |
PointSelector | Returns the user specified point selector |
RetractDistance | Returns the Retract Distance builder (inheritable double) |
RetractDistanceOnToolAxisChange | Returns the Retract Distance on Tool Axis Change builder (inheritable double) |
ReverseDirection | Returns or sets the reverse direction |
SafeClearance | Returns the safe clearance builder |
SelectToolFlag | Returns or sets the user selected tool |
SelectedFace | Returns the selected face |
StartOfPath | Returns the start event builder |
StartUDistance | Returns or sets the start distance in the U direction |
StartUPercent | Returns or sets the start percent in the U direction |
StartUdeSet | Returns the start ude set |
StartVDistance | Returns or sets the start distance n the V direction |
StartVPercent | Returns or sets the start percent n the V direction |
Tag | Returns the Tag for this object. |
ToolChangeSetting | Returns the tool change builder |
ToolPathSplitParametersBuilder | Returns the tool path split Parameters |
UStartEndMode | Returns or sets the U start end mode |
VStartEndMode | Returns or sets the V start end mode |
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. |
ErasePointDefinitionDisplay | Erases display of point definition data |
GetCommittedObjects | For builders that create more than one object, this method returns the objects that are created by commit. |
GetHoleAxisValues | Get the Hole Axis values @return the Hole Axis values |
GetObject | Returns the object currently being edited by this builder. |
PreviewPointData | Creates preview of point definition data |
SetHoleAxisValues | Set the Hole Axis values |
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¶
InspectionSurfaceFeatureBuilderPointDataDefinitionType Enumeration | The method used to define point data |
InspectionSurfaceFeatureBuilderStartEndModeType Enumeration | the method used to define the start and end points |
Property Detail¶
EndUDistance¶
-
InspectionSurfaceFeatureBuilder.
EndUDistance
¶ Returns or sets the end distance in the U direction
-------------------------------------
Getter Method
Signature
EndUDistance()
Returns: Return type: float New in version NX8.5.1.
License requirements: None.
-------------------------------------
Setter Method
Signature
EndUDistance(endUDistance)
Parameters: endUDistance (float) – New in version NX8.5.1.
License requirements: insp_programming (“INSPECTION PROGRAMMING”)
EndUPercent¶
-
InspectionSurfaceFeatureBuilder.
EndUPercent
¶ Returns or sets the end percent in the U direction
-------------------------------------
Getter Method
Signature
EndUPercent()
Returns: Return type: float New in version NX8.5.1.
License requirements: None.
-------------------------------------
Setter Method
Signature
EndUPercent(endUPercent)
Parameters: endUPercent (float) – New in version NX8.5.1.
License requirements: insp_programming (“INSPECTION PROGRAMMING”)
EndVDistance¶
-
InspectionSurfaceFeatureBuilder.
EndVDistance
¶ Returns or sets the end distance in the V direction
-------------------------------------
Getter Method
Signature
EndVDistance()
Returns: Return type: float New in version NX8.5.1.
License requirements: None.
-------------------------------------
Setter Method
Signature
EndVDistance(endVDistance)
Parameters: endVDistance (float) – New in version NX8.5.1.
License requirements: insp_programming (“INSPECTION PROGRAMMING”)
EndVPercent¶
-
InspectionSurfaceFeatureBuilder.
EndVPercent
¶ Returns or sets the end percent in the V direction
-------------------------------------
Getter Method
Signature
EndVPercent()
Returns: Return type: float New in version NX8.5.1.
License requirements: None.
-------------------------------------
Setter Method
Signature
EndVPercent(endVPercent)
Parameters: endVPercent (float) – New in version NX8.5.1.
License requirements: insp_programming (“INSPECTION PROGRAMMING”)
IsPointDefinitionChanged¶
-
InspectionSurfaceFeatureBuilder.
IsPointDefinitionChanged
¶ Returns or sets the point data definition changed flag
-------------------------------------
Getter Method
Signature
IsPointDefinitionChanged()
Returns: Return type: bool New in version NX9.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
IsPointDefinitionChanged(isChanged)
Parameters: isChanged (bool) – New in version NX9.0.0.
License requirements: insp_programming (“INSPECTION PROGRAMMING”)
Name¶
-
InspectionSurfaceFeatureBuilder.
Name
¶ Returns or sets the name
-------------------------------------
Getter Method
Signature
Name()
Returns: Return type: str New in version NX7.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
Name(name)
Parameters: name (str) – New in version NX7.0.0.
License requirements: insp_programming (“INSPECTION PROGRAMMING”)
NumberOfUPoints¶
-
InspectionSurfaceFeatureBuilder.
NumberOfUPoints
¶ Returns or sets the number of U points
-------------------------------------
Getter Method
Signature
NumberOfUPoints()
Returns: Return type: int New in version NX8.5.1.
License requirements: None.
-------------------------------------
Setter Method
Signature
NumberOfUPoints(numberOfUPoints)
Parameters: numberOfUPoints (int) – New in version NX8.5.1.
License requirements: insp_programming (“INSPECTION PROGRAMMING”)
NumberOfVPoints¶
-
InspectionSurfaceFeatureBuilder.
NumberOfVPoints
¶ Returns or sets the number of V points
-------------------------------------
Getter Method
Signature
NumberOfVPoints()
Returns: Return type: int New in version NX8.5.1.
License requirements: None.
-------------------------------------
Setter Method
Signature
NumberOfVPoints(numberOfVPoints)
Parameters: numberOfVPoints (int) – New in version NX8.5.1.
License requirements: insp_programming (“INSPECTION PROGRAMMING”)
PointDataDefinition¶
-
InspectionSurfaceFeatureBuilder.
PointDataDefinition
¶ Returns or sets the point data definition type
-------------------------------------
Getter Method
Signature
PointDataDefinition()
Returns: Return type: NXOpen.CAM.InspectionSurfaceFeatureBuilderPointDataDefinitionType
New in version NX8.5.1.
License requirements: None.
-------------------------------------
Setter Method
Signature
PointDataDefinition(pointDataDefinition)
Parameters: pointDataDefinition ( NXOpen.CAM.InspectionSurfaceFeatureBuilderPointDataDefinitionType
) –New in version NX8.5.1.
License requirements: insp_programming (“INSPECTION PROGRAMMING”)
PointSelector¶
-
InspectionSurfaceFeatureBuilder.
PointSelector
¶ Returns the user specified point selector
-------------------------------------
Getter Method
Signature
PointSelector()
Returns: Return type: NXOpen.SelectPointList
New in version NX8.5.1.
License requirements: None.
ReverseDirection¶
-
InspectionSurfaceFeatureBuilder.
ReverseDirection
¶ Returns or sets the reverse direction
-------------------------------------
Getter Method
Signature
ReverseDirection()
Returns: Return type: bool New in version NX7.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ReverseDirection(reverseDirection)
Parameters: reverseDirection (bool) – New in version NX7.0.0.
License requirements: insp_programming (“INSPECTION PROGRAMMING”)
SelectedFace¶
-
InspectionSurfaceFeatureBuilder.
SelectedFace
¶ Returns the selected face
-------------------------------------
Getter Method
Signature
SelectedFace()
Returns: Return type: NXOpen.SelectFace
New in version NX7.0.0.
License requirements: None.
StartUDistance¶
-
InspectionSurfaceFeatureBuilder.
StartUDistance
¶ Returns or sets the start distance in the U direction
-------------------------------------
Getter Method
Signature
StartUDistance()
Returns: Return type: float New in version NX8.5.1.
License requirements: None.
-------------------------------------
Setter Method
Signature
StartUDistance(startUDistance)
Parameters: startUDistance (float) – New in version NX8.5.1.
License requirements: insp_programming (“INSPECTION PROGRAMMING”)
StartUPercent¶
-
InspectionSurfaceFeatureBuilder.
StartUPercent
¶ Returns or sets the start percent in the U direction
-------------------------------------
Getter Method
Signature
StartUPercent()
Returns: Return type: float New in version NX8.5.1.
License requirements: None.
-------------------------------------
Setter Method
Signature
StartUPercent(startUPercent)
Parameters: startUPercent (float) – New in version NX8.5.1.
License requirements: insp_programming (“INSPECTION PROGRAMMING”)
StartVDistance¶
-
InspectionSurfaceFeatureBuilder.
StartVDistance
¶ Returns or sets the start distance n the V direction
-------------------------------------
Getter Method
Signature
StartVDistance()
Returns: Return type: float New in version NX8.5.1.
License requirements: None.
-------------------------------------
Setter Method
Signature
StartVDistance(startVDistance)
Parameters: startVDistance (float) – New in version NX8.5.1.
License requirements: insp_programming (“INSPECTION PROGRAMMING”)
StartVPercent¶
-
InspectionSurfaceFeatureBuilder.
StartVPercent
¶ Returns or sets the start percent n the V direction
-------------------------------------
Getter Method
Signature
StartVPercent()
Returns: Return type: float New in version NX8.5.1.
License requirements: None.
-------------------------------------
Setter Method
Signature
StartVPercent(startVPercent)
Parameters: startVPercent (float) – New in version NX8.5.1.
License requirements: insp_programming (“INSPECTION PROGRAMMING”)
UStartEndMode¶
-
InspectionSurfaceFeatureBuilder.
UStartEndMode
¶ Returns or sets the U start end mode
-------------------------------------
Getter Method
Signature
UStartEndMode()
Returns: Return type: NXOpen.CAM.InspectionSurfaceFeatureBuilderStartEndModeType
New in version NX8.5.1.
License requirements: None.
-------------------------------------
Setter Method
Signature
UStartEndMode(uStartEndMode)
Parameters: uStartEndMode ( NXOpen.CAM.InspectionSurfaceFeatureBuilderStartEndModeType
) –New in version NX8.5.1.
License requirements: insp_programming (“INSPECTION PROGRAMMING”)
VStartEndMode¶
-
InspectionSurfaceFeatureBuilder.
VStartEndMode
¶ Returns or sets the V start end mode
-------------------------------------
Getter Method
Signature
VStartEndMode()
Returns: Return type: NXOpen.CAM.InspectionSurfaceFeatureBuilderStartEndModeType
New in version NX8.5.1.
License requirements: None.
-------------------------------------
Setter Method
Signature
VStartEndMode(vStartEndMode)
Parameters: vStartEndMode ( NXOpen.CAM.InspectionSurfaceFeatureBuilderStartEndModeType
) –New in version NX8.5.1.
License requirements: insp_programming (“INSPECTION PROGRAMMING”)
Method Detail¶
ErasePointDefinitionDisplay¶
-
InspectionSurfaceFeatureBuilder.
ErasePointDefinitionDisplay
¶ Erases display of point definition data
Signature
ErasePointDefinitionDisplay()
New in version NX9.0.0.
License requirements: insp_programming (“INSPECTION PROGRAMMING”)
PreviewPointData¶
-
InspectionSurfaceFeatureBuilder.
PreviewPointData
¶ Creates preview of point definition data
Signature
PreviewPointData(showExisting)
Parameters: showExisting (bool) – New in version NX9.0.0.
License requirements: insp_programming (“INSPECTION PROGRAMMING”)
Validate¶
-
InspectionSurfaceFeatureBuilder.
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.