InspectionLineFeatureBuilder Class¶
-
class
NXOpen.CAM.InspectionLineFeatureBuilder¶ Bases:
NXOpen.CAM.OperationBuilderRepresents a CMM Inspection Line Feature builder
To create a new instance of this class, use
NXOpen.CAM.InspectionOperationCollection.CreateInspectionLineFeatureBuilder()New in version NX7.0.0.
Properties¶
| Property | Description |
|---|---|
| ChannelName | Returns or sets the channel’s name |
| CsysRefType | Returns or sets the coordinate system reference type |
| CycleEvent | Returns the cycle event |
| CycleTable | Returns the cycle |
| Description | Returns or sets the description |
| EndOfPath | Returns the end event builder |
| EndUdeSet | Returns the end ude set |
| ExtentType | Returns or sets the extent type of the line (bounded or unbounded) |
| 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 |
| ILine | Returns or sets the I component of the lines direction vector |
| INormal | Returns or sets the I component of the lines normal vector as determined by an underlying surface |
| JLine | Returns or sets the J component of the lines direction vector |
| JNormal | Returns or sets the J component of the lines normal vector as determined by an underlying surface |
| KLine | Returns or sets the K component of the lines direction vector |
| KNormal | Returns or sets the K component of the lines normal vector as determined by an underlying surface |
| LayoutAndLayer | Returns the Layer and Layout |
| Length | Returns or sets the length of the line |
| LineDirection | Returns or sets the line direction vector |
| MotionOutputBuilder | Returns the motion output builder |
| Name | Returns or sets the name of the line feature |
| Notes | Returns the notes builder |
| OffsetDistance | Returns the offset distance |
| 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 |
| PostToolPathExit | Returns or sets the environment variable that points to the post tool path generation library which has the exit |
| 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 button |
| SafeClearance | Returns the safe clearance builder |
| SelectLine | Returns the selected line |
| SelectNormalSurface | Returns the underlying surface used to determine the normal and approach direction vectors |
| SelectToolFlag | Returns or sets the user selected tool |
| StartOfPath | Returns the start event builder |
| StartUdeSet | Returns the start ude set |
| Tag | Returns the Tag for this object. |
| ToolChangeSetting | Returns the tool change builder |
| ToolPathEditor | Returns the Tool Path Editor Builder |
| ToolPathSplitParametersBuilder | Returns the tool path split Parameters |
| NXOpen.CAM.InspectionLineFeatureBuilder.X | Returns or sets the X coordinate of one end of a bounded line or any point on an unbounded line |
| NXOpen.CAM.InspectionLineFeatureBuilder.Y | Returns or sets the Y coordinate of one end of a bounded line or any point on an unbounded line |
| NXOpen.CAM.InspectionLineFeatureBuilder.Z | Returns or sets the Z coordinate of one end of a bounded line or any point on an unbounded line |
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. |
| FlipLineDirection | Flips direction of line. |
| FlipNormal | Flips normal of underlying surface |
| GetCommittedObjects | For builders that create more than one object, this method returns the objects that are created by commit. |
| GetCustomizableItemBuilder | Returns the customizable item builder for the given customizable item name |
| GetCustomizableItemNames | Returns the names for all customizable item ids |
| GetHoleAxisValues | Get the Hole Axis values |
| GetObject | Returns the object currently being edited by this builder. |
| ReverseOffsetDirection | Reverses the offset direction |
| SetHoleAxisValues | Set the Hole Axis values |
| SetNormalSurface | Sets the underlying normal surface |
| ShowResults | Updates the model to reflect the result of an edit to the model for all builders that support showing results. |
| UpdateNormal | Updates normal vector for line based on selection of underlying plane |
| UpdateOffset | Updates line inspection feature characteristic parameters based on offset distance |
| UpdateParams | Updates line inspection feature characteristic parameters based on selected geometry |
| Validate | Validate whether the inputs to the component are sufficient for commit to be called. |
Property Detail¶
CsysRefType¶
-
InspectionLineFeatureBuilder.CsysRefType¶ Returns or sets the coordinate system reference type
-------------------------------------Getter Method
Signature
CsysRefTypeReturns: Return type: NXOpen.CAM.CamInspectionOperationCsysreferencetypesNew in version NX7.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
CsysRefTypeParameters: csysRefType ( NXOpen.CAM.CamInspectionOperationCsysreferencetypes) –New in version NX7.0.0.
License requirements: insp_programming (“INSPECTION PROGRAMMING”)
ExtentType¶
-
InspectionLineFeatureBuilder.ExtentType¶ Returns or sets the extent type of the line (bounded or unbounded)
-------------------------------------Getter Method
Signature
ExtentTypeReturns: Return type: NXOpen.CAM.CamInspectionOperationExtenttypesNew in version NX7.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
ExtentTypeParameters: extentType ( NXOpen.CAM.CamInspectionOperationExtenttypes) –New in version NX7.0.0.
License requirements: insp_programming (“INSPECTION PROGRAMMING”)
ILine¶
-
InspectionLineFeatureBuilder.ILine¶ Returns or sets the I component of the lines direction vector
-------------------------------------Getter Method
Signature
ILineReturns: Return type: float New in version NX7.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
ILineParameters: iLine (float) – New in version NX7.0.0.
License requirements: insp_programming (“INSPECTION PROGRAMMING”)
INormal¶
-
InspectionLineFeatureBuilder.INormal¶ Returns or sets the I component of the lines normal vector as determined by an underlying surface
-------------------------------------Getter Method
Signature
INormalReturns: Return type: float New in version NX7.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
INormalParameters: iNormal (float) – New in version NX7.0.0.
License requirements: insp_programming (“INSPECTION PROGRAMMING”)
JLine¶
-
InspectionLineFeatureBuilder.JLine¶ Returns or sets the J component of the lines direction vector
-------------------------------------Getter Method
Signature
JLineReturns: Return type: float New in version NX7.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
JLineParameters: jLine (float) – New in version NX7.0.0.
License requirements: insp_programming (“INSPECTION PROGRAMMING”)
JNormal¶
-
InspectionLineFeatureBuilder.JNormal¶ Returns or sets the J component of the lines normal vector as determined by an underlying surface
-------------------------------------Getter Method
Signature
JNormalReturns: Return type: float New in version NX7.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
JNormalParameters: jNormal (float) – New in version NX7.0.0.
License requirements: insp_programming (“INSPECTION PROGRAMMING”)
KLine¶
-
InspectionLineFeatureBuilder.KLine¶ Returns or sets the K component of the lines direction vector
-------------------------------------Getter Method
Signature
KLineReturns: Return type: float New in version NX7.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
KLineParameters: kLine (float) – New in version NX7.0.0.
License requirements: insp_programming (“INSPECTION PROGRAMMING”)
KNormal¶
-
InspectionLineFeatureBuilder.KNormal¶ Returns or sets the K component of the lines normal vector as determined by an underlying surface
-------------------------------------Getter Method
Signature
KNormalReturns: Return type: float New in version NX7.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
KNormalParameters: kNormal (float) – New in version NX7.0.0.
License requirements: insp_programming (“INSPECTION PROGRAMMING”)
Length¶
-
InspectionLineFeatureBuilder.Length¶ Returns or sets the length of the line
-------------------------------------Getter Method
Signature
LengthReturns: Return type: float New in version NX7.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
LengthParameters: length (float) – New in version NX7.0.0.
License requirements: insp_programming (“INSPECTION PROGRAMMING”)
LineDirection¶
-
InspectionLineFeatureBuilder.LineDirection¶ Returns or sets the line direction vector
-------------------------------------Getter Method
Signature
LineDirectionReturns: Return type: NXOpen.DirectionNew in version NX7.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
LineDirectionParameters: lineDirection ( NXOpen.Direction) –New in version NX7.0.0.
License requirements: insp_programming (“INSPECTION PROGRAMMING”)
Name¶
-
InspectionLineFeatureBuilder.Name¶ Returns or sets the name of the line feature
-------------------------------------Getter Method
Signature
NameReturns: Return type: str New in version NX7.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
NameParameters: name (str) – New in version NX7.0.0.
License requirements: insp_programming (“INSPECTION PROGRAMMING”)
OffsetDistance¶
-
InspectionLineFeatureBuilder.OffsetDistance¶ Returns the offset distance
-------------------------------------Getter Method
Signature
OffsetDistanceReturns: Return type: NXOpen.CAM.InheritableDoubleBuilderNew in version NX9.0.0.
License requirements: None.
ReverseDirection¶
-
InspectionLineFeatureBuilder.ReverseDirection¶ Returns or sets the reverse direction button
-------------------------------------Getter Method
Signature
ReverseDirectionReturns: Return type: bool New in version NX7.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
ReverseDirectionParameters: reverseDirection (bool) – New in version NX7.0.0.
License requirements: insp_programming (“INSPECTION PROGRAMMING”)
SelectLine¶
-
InspectionLineFeatureBuilder.SelectLine¶ Returns the selected line
-------------------------------------Getter Method
Signature
SelectLineReturns: Return type: NXOpen.SelectNXObjectNew in version NX7.0.0.
License requirements: None.
SelectNormalSurface¶
-
InspectionLineFeatureBuilder.SelectNormalSurface¶ Returns the underlying surface used to determine the normal and approach direction vectors
-------------------------------------Getter Method
Signature
SelectNormalSurfaceReturns: Return type: NXOpen.SelectNXObjectNew in version NX7.0.0.
License requirements: None.
X¶
-
InspectionLineFeatureBuilder.X¶ Returns or sets the X coordinate of one end of a bounded line or any point on an unbounded line
-------------------------------------Getter Method
Signature
XReturns: Return type: float New in version NX7.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
XParameters: x (float) – New in version NX7.0.0.
License requirements: insp_programming (“INSPECTION PROGRAMMING”)
Y¶
-
InspectionLineFeatureBuilder.Y¶ Returns or sets the Y coordinate of one end of a bounded line or any point on an unbounded line
-------------------------------------Getter Method
Signature
YReturns: Return type: float New in version NX7.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
YParameters: y (float) – New in version NX7.0.0.
License requirements: insp_programming (“INSPECTION PROGRAMMING”)
Z¶
-
InspectionLineFeatureBuilder.Z¶ Returns or sets the Z coordinate of one end of a bounded line or any point on an unbounded line
-------------------------------------Getter Method
Signature
ZReturns: Return type: float New in version NX7.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
ZParameters: z (float) – New in version NX7.0.0.
License requirements: insp_programming (“INSPECTION PROGRAMMING”)
Method Detail¶
FlipLineDirection¶
-
InspectionLineFeatureBuilder.FlipLineDirection¶ Flips direction of line.
Moves xyz location to other end of line
Signature
FlipLineDirection()New in version NX7.0.0.
License requirements: insp_programming (“INSPECTION PROGRAMMING”)
FlipNormal¶
-
InspectionLineFeatureBuilder.FlipNormal¶ Flips normal of underlying surface
Signature
FlipNormal()New in version NX7.0.0.
License requirements: insp_programming (“INSPECTION PROGRAMMING”)
ReverseOffsetDirection¶
-
InspectionLineFeatureBuilder.ReverseOffsetDirection¶ Reverses the offset direction
Signature
ReverseOffsetDirection()New in version NX9.0.0.
License requirements: insp_programming (“INSPECTION PROGRAMMING”)
SetNormalSurface¶
-
InspectionLineFeatureBuilder.SetNormalSurface¶ Sets the underlying normal surface
Signature
SetNormalSurface(normalSurface)Parameters: normalSurface ( NXOpen.Face) –New in version NX9.0.0.
License requirements: insp_programming (“INSPECTION PROGRAMMING”)
UpdateNormal¶
-
InspectionLineFeatureBuilder.UpdateNormal¶ Updates normal vector for line based on selection of underlying plane
Signature
UpdateNormal()New in version NX7.0.0.
License requirements: insp_programming (“INSPECTION PROGRAMMING”)
UpdateOffset¶
-
InspectionLineFeatureBuilder.UpdateOffset¶ Updates line inspection feature characteristic parameters based on offset distance
Signature
UpdateOffset()New in version NX9.0.0.
License requirements: insp_programming (“INSPECTION PROGRAMMING”)
UpdateParams¶
-
InspectionLineFeatureBuilder.UpdateParams¶ Updates line inspection feature characteristic parameters based on selected geometry
Signature
UpdateParams()New in version NX7.0.0.
License requirements: insp_programming (“INSPECTION PROGRAMMING”)
Validate¶
-
InspectionLineFeatureBuilder.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.