InspectionConstructedFeatureBuilder Class¶
-
class
NXOpen.CAM.
InspectionConstructedFeatureBuilder
¶ Bases:
NXOpen.CAM.OperationBuilder
Represents a CMM Inspection Constructed Feature Builder
To create a new instance of this class, use
NXOpen.CAM.InspectionOperationCollection.CreateInspectionConstructedFeatureBuilder
New in version NX7.0.0.
Properties¶
Property | Description |
---|---|
AvailFilterToggle | Returns or sets the toggle to filter available features |
AvailStateEnum | Returns or sets the available feature state (nominal or actual) |
AvailableSelection | Returns the available feature screen selection button |
ChannelName | Returns or sets the channel’s name |
ConstName | Returns or sets the constructed feature name |
CurrentStateEnum | Returns or sets the current feature state (nominal or actual) |
CycleEvent | Returns the cycle event |
CycleTable | Returns the cycle |
Description | Returns or sets the description |
DesignCreation | Returns or sets the design feature creation type |
DesignOffsetGeometry | Returns or sets the offset design feature geometry |
DestinationPcsEnum | Returns or sets the destination part coordinate system type |
DirectionSpecifiedEnum | Returns or sets the type of direction specified (direction vector or radial) |
DirectionVector | Returns or sets the direction vector |
EndOfPath | Returns the end event builder |
EndUdeSet | Returns the end ude set |
ExtractEdgeDistance | Returns or sets the extract edge distance type type |
ExtractEndDistance | Returns or sets the extract end edge distance |
ExtractStartDistance | Returns or sets the extract start edge distance |
FeatureTypeEnum | Returns or sets the feature type to be constructed |
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 |
LayoutAndLayer | Returns the Layer and Layout |
MethodEnum | Returns or sets the construction method to be used |
MotionOutputBuilder | Returns the motion output builder |
MoveDistance | Returns or sets the move distance |
NominalName | Returns or sets the nominal feature name |
Notes | Returns the notes builder |
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 |
PcsName | Returns or sets the part coordinate system name |
RetractDistance | Returns the Retract Distance builder (inheritable double) |
RetractDistanceOnToolAxisChange | Returns the Retract Distance on Tool Axis Change builder (inheritable double) |
SafeClearance | Returns the safe clearance builder |
SelectNominalFeature | Returns the select nominal feature button |
SelectToolFlag | Returns or sets the user selected tool |
StartOfPath | Returns the start event builder |
StartUdeSet | Returns the start ude set |
StepSize | Returns or sets the extract step size |
SubFeat1Filter | Returns or sets the filter toggle for the first list of subfeatures |
SubFeat1Name | Returns or sets the name of the first subfeature |
SubFeat1Select | Returns the first subfeature selection button |
SubFeat1StateEnum | Returns or sets the state of features in the first subfeature list |
SubFeat2Filter | Returns or sets the filter toggle for the second list of subfeatures |
SubFeat2Name | Returns or sets the name of the first subfeature |
SubFeat2Select | Returns the second subfeature selection button |
SubFeat2StateEnum | Returns or sets the state of features in the second subfeature list |
Tag | Returns the Tag for this object. |
ToolChangeSetting | Returns the tool change builder |
ToolPathSplitParametersBuilder | Returns the tool path split Parameters |
Methods¶
Method | Description |
---|---|
Commit | Commits any edits that have been applied to the builder. |
CreateNominal | The button used to create the nominal constructed feature |
CycleSolution | The button used to cycle through possible solutions |
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. |
GetHoleAxisValues | Get the Hole Axis values @return the Hole Axis values |
GetObject | Returns the object currently being edited by this builder. |
GetSubFeatureStates | Get the current subfeature states. |
GetSubFeatures | Get the current subfeatures @return Current subfeatures |
SetHoleAxisValues | Set the Hole Axis values |
SetSubFeatureStates | Set the current subfeature states. |
SetSubFeatures | Set the current subfeatures |
ShowResults | Updates the model to reflect the result of an edit to the model for all builders that support showing results. |
UpdateDirectionVector | The constructed inspection feature direction vector based on selected vector |
Validate | Validate whether the inputs to the component are sufficient for commit to be called. |
Enumerations¶
Property Detail¶
AvailFilterToggle¶
-
InspectionConstructedFeatureBuilder.
AvailFilterToggle
¶ Returns or sets the toggle to filter available features
-------------------------------------
Getter Method
Signature
AvailFilterToggle()
Returns: Return type: bool New in version NX7.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
AvailFilterToggle(availFilterToggle)
Parameters: availFilterToggle (bool) – New in version NX7.0.0.
License requirements: insp_programming (“INSPECTION PROGRAMMING”)
AvailStateEnum¶
-
InspectionConstructedFeatureBuilder.
AvailStateEnum
¶ Returns or sets the available feature state (nominal or actual)
-------------------------------------
Getter Method
Signature
AvailStateEnum()
Returns: Return type: NXOpen.CAM.InspectionConstructedFeatureBuilderAvailableStateType
New in version NX7.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
AvailStateEnum(availStateEnum)
Parameters: availStateEnum ( NXOpen.CAM.InspectionConstructedFeatureBuilderAvailableStateType
) –New in version NX7.0.0.
License requirements: insp_programming (“INSPECTION PROGRAMMING”)
AvailableSelection¶
-
InspectionConstructedFeatureBuilder.
AvailableSelection
¶ Returns the available feature screen selection button
-------------------------------------
Getter Method
Signature
AvailableSelection()
Returns: Return type: NXOpen.SelectNXObjectList
New in version NX7.0.0.
License requirements: None.
ConstName¶
-
InspectionConstructedFeatureBuilder.
ConstName
¶ Returns or sets the constructed feature name
-------------------------------------
Getter Method
Signature
ConstName()
Returns: Return type: str New in version NX7.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ConstName(constName)
Parameters: constName (str) – New in version NX7.0.0.
License requirements: insp_programming (“INSPECTION PROGRAMMING”)
CurrentStateEnum¶
-
InspectionConstructedFeatureBuilder.
CurrentStateEnum
¶ Returns or sets the current feature state (nominal or actual)
-------------------------------------
Getter Method
Signature
CurrentStateEnum()
Returns: Return type: NXOpen.CAM.InspectionConstructedFeatureBuilderCurrentStateType
New in version NX7.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
CurrentStateEnum(currentStateEnum)
Parameters: currentStateEnum ( NXOpen.CAM.InspectionConstructedFeatureBuilderCurrentStateType
) –New in version NX7.0.0.
License requirements: insp_programming (“INSPECTION PROGRAMMING”)
DesignCreation¶
-
InspectionConstructedFeatureBuilder.
DesignCreation
¶ Returns or sets the design feature creation type
-------------------------------------
Getter Method
Signature
DesignCreation()
Returns: Return type: NXOpen.CAM.InspectionConstructedFeatureBuilderDesignCreationType
New in version NX7.5.3.
License requirements: None.
-------------------------------------
Setter Method
Signature
DesignCreation(creationType)
Parameters: creationType ( NXOpen.CAM.InspectionConstructedFeatureBuilderDesignCreationType
) –New in version NX7.5.3.
License requirements: insp_programming (“INSPECTION PROGRAMMING”)
DesignOffsetGeometry¶
-
InspectionConstructedFeatureBuilder.
DesignOffsetGeometry
¶ Returns or sets the offset design feature geometry
-------------------------------------
Getter Method
Signature
DesignOffsetGeometry()
Returns: Return type: NXOpen.NXObject
New in version NX7.5.3.
License requirements: None.
-------------------------------------
Setter Method
Signature
DesignOffsetGeometry(designOffset)
Parameters: designOffset ( NXOpen.NXObject
) –New in version NX7.5.3.
License requirements: insp_programming (“INSPECTION PROGRAMMING”)
DestinationPcsEnum¶
-
InspectionConstructedFeatureBuilder.
DestinationPcsEnum
¶ Returns or sets the destination part coordinate system type
-------------------------------------
Getter Method
Signature
DestinationPcsEnum()
Returns: Return type: NXOpen.CAM.InspectionConstructedFeatureBuilderDestPcsEnumType
New in version NX7.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
DestinationPcsEnum(destinationPcsEnum)
Parameters: destinationPcsEnum ( NXOpen.CAM.InspectionConstructedFeatureBuilderDestPcsEnumType
) –New in version NX7.0.0.
License requirements: insp_programming (“INSPECTION PROGRAMMING”)
DirectionSpecifiedEnum¶
-
InspectionConstructedFeatureBuilder.
DirectionSpecifiedEnum
¶ Returns or sets the type of direction specified (direction vector or radial)
-------------------------------------
Getter Method
Signature
DirectionSpecifiedEnum()
Returns: Return type: NXOpen.CAM.InspectionConstructedFeatureBuilderDirectionType
New in version NX7.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
DirectionSpecifiedEnum(directionSpecifiedEnum)
Parameters: directionSpecifiedEnum ( NXOpen.CAM.InspectionConstructedFeatureBuilderDirectionType
) –New in version NX7.0.0.
License requirements: insp_programming (“INSPECTION PROGRAMMING”)
DirectionVector¶
-
InspectionConstructedFeatureBuilder.
DirectionVector
¶ Returns or sets the direction vector
-------------------------------------
Getter Method
Signature
DirectionVector()
Returns: Return type: NXOpen.Direction
New in version NX7.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
DirectionVector(directionVector)
Parameters: directionVector ( NXOpen.Direction
) –New in version NX7.0.0.
License requirements: insp_programming (“INSPECTION PROGRAMMING”)
ExtractEdgeDistance¶
-
InspectionConstructedFeatureBuilder.
ExtractEdgeDistance
¶ Returns or sets the extract edge distance type type
-------------------------------------
Getter Method
Signature
ExtractEdgeDistance()
Returns: Return type: NXOpen.CAM.InspectionConstructedFeatureBuilderExtractEdgeDistanceType
New in version NX8.0.1.
License requirements: None.
-------------------------------------
Setter Method
Signature
ExtractEdgeDistance(distanceType)
Parameters: distanceType ( NXOpen.CAM.InspectionConstructedFeatureBuilderExtractEdgeDistanceType
) –New in version NX8.0.1.
License requirements: insp_programming (“INSPECTION PROGRAMMING”)
ExtractEndDistance¶
-
InspectionConstructedFeatureBuilder.
ExtractEndDistance
¶ Returns or sets the extract end edge distance
-------------------------------------
Getter Method
Signature
ExtractEndDistance()
Returns: Return type: float New in version NX8.0.1.
License requirements: None.
-------------------------------------
Setter Method
Signature
ExtractEndDistance(endDistance)
Parameters: endDistance (float) – New in version NX8.0.1.
License requirements: insp_programming (“INSPECTION PROGRAMMING”)
ExtractStartDistance¶
-
InspectionConstructedFeatureBuilder.
ExtractStartDistance
¶ Returns or sets the extract start edge distance
-------------------------------------
Getter Method
Signature
ExtractStartDistance()
Returns: Return type: float New in version NX8.0.1.
License requirements: None.
-------------------------------------
Setter Method
Signature
ExtractStartDistance(startDistance)
Parameters: startDistance (float) – New in version NX8.0.1.
License requirements: insp_programming (“INSPECTION PROGRAMMING”)
FeatureTypeEnum¶
-
InspectionConstructedFeatureBuilder.
FeatureTypeEnum
¶ Returns or sets the feature type to be constructed
-------------------------------------
Getter Method
Signature
FeatureTypeEnum()
Returns: Return type: NXOpen.CAM.InspectionConstructedFeatureBuilderConstFeatType
New in version NX7.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
FeatureTypeEnum(featureTypeEnum)
Parameters: featureTypeEnum ( NXOpen.CAM.InspectionConstructedFeatureBuilderConstFeatType
) –New in version NX7.0.0.
License requirements: insp_programming (“INSPECTION PROGRAMMING”)
MethodEnum¶
-
InspectionConstructedFeatureBuilder.
MethodEnum
¶ Returns or sets the construction method to be used
-------------------------------------
Getter Method
Signature
MethodEnum()
Returns: Return type: NXOpen.CAM.InspectionConstructedFeatureBuilderMethodEnumType
New in version NX7.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
MethodEnum(methodEnum)
Parameters: methodEnum ( NXOpen.CAM.InspectionConstructedFeatureBuilderMethodEnumType
) –New in version NX7.0.0.
License requirements: insp_programming (“INSPECTION PROGRAMMING”)
MoveDistance¶
-
InspectionConstructedFeatureBuilder.
MoveDistance
¶ Returns or sets the move distance
-------------------------------------
Getter Method
Signature
MoveDistance()
Returns: Return type: float New in version NX7.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
MoveDistance(moveDistance)
Parameters: moveDistance (float) – New in version NX7.0.0.
License requirements: insp_programming (“INSPECTION PROGRAMMING”)
NominalName¶
-
InspectionConstructedFeatureBuilder.
NominalName
¶ Returns or sets the nominal feature name
-------------------------------------
Getter Method
Signature
NominalName()
Returns: Return type: str New in version NX7.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
NominalName(nominalName)
Parameters: nominalName (str) – New in version NX7.0.0.
License requirements: insp_programming (“INSPECTION PROGRAMMING”)
PcsName¶
-
InspectionConstructedFeatureBuilder.
PcsName
¶ Returns or sets the part coordinate system name
-------------------------------------
Getter Method
Signature
PcsName()
Returns: Return type: str New in version NX7.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
PcsName(pcsName)
Parameters: pcsName (str) – New in version NX7.0.0.
License requirements: insp_programming (“INSPECTION PROGRAMMING”)
SelectNominalFeature¶
-
InspectionConstructedFeatureBuilder.
SelectNominalFeature
¶ Returns the select nominal feature button
-------------------------------------
Getter Method
Signature
SelectNominalFeature()
Returns: Return type: NXOpen.SelectNXObject
New in version NX7.0.0.
License requirements: None.
StepSize¶
-
InspectionConstructedFeatureBuilder.
StepSize
¶ Returns or sets the extract step size
-------------------------------------
Getter Method
Signature
StepSize()
Returns: Return type: float New in version NX8.0.1.
License requirements: None.
-------------------------------------
Setter Method
Signature
StepSize(stepSize)
Parameters: stepSize (float) – New in version NX8.0.1.
License requirements: insp_programming (“INSPECTION PROGRAMMING”)
SubFeat1Filter¶
-
InspectionConstructedFeatureBuilder.
SubFeat1Filter
¶ Returns or sets the filter toggle for the first list of subfeatures
-------------------------------------
Getter Method
Signature
SubFeat1Filter()
Returns: Return type: bool New in version NX7.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
SubFeat1Filter(subFeat1Filter)
Parameters: subFeat1Filter (bool) – New in version NX7.0.0.
License requirements: insp_programming (“INSPECTION PROGRAMMING”)
SubFeat1Name¶
-
InspectionConstructedFeatureBuilder.
SubFeat1Name
¶ Returns or sets the name of the first subfeature
-------------------------------------
Getter Method
Signature
SubFeat1Name()
Returns: Return type: str New in version NX7.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
SubFeat1Name(subFeat1Name)
Parameters: subFeat1Name (str) – New in version NX7.0.0.
License requirements: insp_programming (“INSPECTION PROGRAMMING”)
SubFeat1Select¶
-
InspectionConstructedFeatureBuilder.
SubFeat1Select
¶ Returns the first subfeature selection button
-------------------------------------
Getter Method
Signature
SubFeat1Select()
Returns: Return type: NXOpen.SelectNXObject
New in version NX7.0.0.
License requirements: None.
SubFeat1StateEnum¶
-
InspectionConstructedFeatureBuilder.
SubFeat1StateEnum
¶ Returns or sets the state of features in the first subfeature list
-------------------------------------
Getter Method
Signature
SubFeat1StateEnum()
Returns: Return type: NXOpen.CAM.InspectionConstructedFeatureBuilderSubFeat1StateType
New in version NX7.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
SubFeat1StateEnum(subFeat1StateEnum)
Parameters: subFeat1StateEnum ( NXOpen.CAM.InspectionConstructedFeatureBuilderSubFeat1StateType
) –New in version NX7.0.0.
License requirements: insp_programming (“INSPECTION PROGRAMMING”)
SubFeat2Filter¶
-
InspectionConstructedFeatureBuilder.
SubFeat2Filter
¶ Returns or sets the filter toggle for the second list of subfeatures
-------------------------------------
Getter Method
Signature
SubFeat2Filter()
Returns: Return type: bool New in version NX7.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
SubFeat2Filter(subFeat2Filter)
Parameters: subFeat2Filter (bool) – New in version NX7.0.0.
License requirements: insp_programming (“INSPECTION PROGRAMMING”)
SubFeat2Name¶
-
InspectionConstructedFeatureBuilder.
SubFeat2Name
¶ Returns or sets the name of the first subfeature
-------------------------------------
Getter Method
Signature
SubFeat2Name()
Returns: Return type: str New in version NX7.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
SubFeat2Name(subFeat2Name)
Parameters: subFeat2Name (str) – New in version NX7.0.0.
License requirements: insp_programming (“INSPECTION PROGRAMMING”)
SubFeat2Select¶
-
InspectionConstructedFeatureBuilder.
SubFeat2Select
¶ Returns the second subfeature selection button
-------------------------------------
Getter Method
Signature
SubFeat2Select()
Returns: Return type: NXOpen.SelectNXObject
New in version NX7.0.0.
License requirements: None.
SubFeat2StateEnum¶
-
InspectionConstructedFeatureBuilder.
SubFeat2StateEnum
¶ Returns or sets the state of features in the second subfeature list
-------------------------------------
Getter Method
Signature
SubFeat2StateEnum()
Returns: Return type: NXOpen.CAM.InspectionConstructedFeatureBuilderSubFeat2StateType
New in version NX7.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
SubFeat2StateEnum(subFeat2StateEnum)
Parameters: subFeat2StateEnum ( NXOpen.CAM.InspectionConstructedFeatureBuilderSubFeat2StateType
) –New in version NX7.0.0.
License requirements: insp_programming (“INSPECTION PROGRAMMING”)
Method Detail¶
CreateNominal¶
-
InspectionConstructedFeatureBuilder.
CreateNominal
¶ The button used to create the nominal constructed feature
Signature
CreateNominal()
New in version NX7.0.0.
License requirements: insp_programming (“INSPECTION PROGRAMMING”)
CycleSolution¶
-
InspectionConstructedFeatureBuilder.
CycleSolution
¶ The button used to cycle through possible solutions
Signature
CycleSolution()
New in version NX7.0.0.
License requirements: insp_programming (“INSPECTION PROGRAMMING”)
GetSubFeatureStates¶
-
InspectionConstructedFeatureBuilder.
GetSubFeatureStates
¶ Get the current subfeature states.
Signature
GetSubFeatureStates()
Returns: Current subfeature states Return type: list of NXOpen.CAM.InspectionConstructedFeatureBuilderCurrentStateType
New in version NX7.5.3.
License requirements: None.
GetSubFeatures¶
-
InspectionConstructedFeatureBuilder.
GetSubFeatures
¶ Get the current subfeatures
Signature
GetSubFeatures()
Returns: Current subfeatures Return type: list of str New in version NX7.5.1.
License requirements: None.
SetSubFeatureStates¶
-
InspectionConstructedFeatureBuilder.
SetSubFeatureStates
¶ Set the current subfeature states.
Signature
SetSubFeatureStates(subFeatureStates)
Parameters: subFeatureStates (list of NXOpen.CAM.InspectionConstructedFeatureBuilderCurrentStateType
) – Current subfeature statesNew in version NX7.5.3.
License requirements: insp_programming (“INSPECTION PROGRAMMING”)
SetSubFeatures¶
-
InspectionConstructedFeatureBuilder.
SetSubFeatures
¶ Set the current subfeatures
Signature
SetSubFeatures(subFeatures)
Parameters: subFeatures (list of str) – Current subfeatures NOTE: The full Unicode character set is not supported for this parameter. New in version NX7.5.1.
License requirements: insp_programming (“INSPECTION PROGRAMMING”)
UpdateDirectionVector¶
-
InspectionConstructedFeatureBuilder.
UpdateDirectionVector
¶ The constructed inspection feature direction vector based on selected vector
Signature
UpdateDirectionVector(vector)
Parameters: vector ( NXOpen.Vector3d
) – The vector data to use for updateNew in version NX7.5.2.
License requirements: insp_programming (“INSPECTION PROGRAMMING”)
Validate¶
-
InspectionConstructedFeatureBuilder.
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.