InspectionGraphicalReportBuilder Class¶
-
class
NXOpen.CAM.
InspectionGraphicalReportBuilder
¶ Bases:
NXOpen.CAM.OperationBuilder
Represents the builder for the CMM Inspection Graphical Report Operation
To create a new instance of this class, use
NXOpen.CAM.InspectionOperationCollection.CreateGraphicalReportBuilder()
New in version NX10.0.3.
Properties¶
Property | Description |
---|---|
AvailableSelection | Returns the available objects screen selection button |
Camera | Returns or sets the camera to use |
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 |
EndUdeSet | Returns the end ude set |
FilterEnum | Returns or sets the filter enum |
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 |
MotionOutputBuilder | Returns the motion output builder |
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 |
PostToolPathExit | Returns or sets the environment variable that points to the post tool path generation library which has the exit |
ReportFilterObject | Returns or sets the report filter object |
ReportFilterType | Returns or sets the report filter type |
ReportName | Returns or sets the report operation name |
ReportTitle | Returns or sets the report title |
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 |
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 |
Methods¶
Method | Description |
---|---|
ActivateView | Activate the specified view. |
CaptureCurrentView | Capture the current view. |
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. |
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. |
RestoreOriginalView | Restore the original view. |
SaveViewCacheSettings | Cache the current view settings. |
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¶
InspectionGraphicalReportBuilderGraphicalReportFilter Enumeration | Filters for specifying report objects |
InspectionGraphicalReportBuilderGraphicalReportFilterType Enumeration | Types of graphical reports |
Property Detail¶
AvailableSelection¶
-
InspectionGraphicalReportBuilder.
AvailableSelection
¶ Returns the available objects screen selection button
-------------------------------------
Getter Method
Signature
AvailableSelection
Returns: Return type: NXOpen.SelectNXObjectList
New in version NX10.0.3.
License requirements: None.
Camera¶
-
InspectionGraphicalReportBuilder.
Camera
¶ Returns or sets the camera to use
-------------------------------------
Getter Method
Signature
Camera
Returns: Return type: str New in version NX10.0.3.
License requirements: None.
-------------------------------------
Setter Method
Signature
Camera
Parameters: camera (str) – New in version NX10.0.3.
License requirements: insp_programming (“INSPECTION PROGRAMMING”)
FilterEnum¶
-
InspectionGraphicalReportBuilder.
FilterEnum
¶ Returns or sets the filter enum
-------------------------------------
Getter Method
Signature
FilterEnum
Returns: Return type: NXOpen.CAM.InspectionGraphicalReportBuilderGraphicalReportFilter
New in version NX10.0.3.
License requirements: None.
-------------------------------------
Setter Method
Signature
FilterEnum
Parameters: filterEnum ( NXOpen.CAM.InspectionGraphicalReportBuilderGraphicalReportFilter
) –New in version NX10.0.3.
License requirements: insp_programming (“INSPECTION PROGRAMMING”)
ReportFilterObject¶
-
InspectionGraphicalReportBuilder.
ReportFilterObject
¶ Returns or sets the report filter object
-------------------------------------
Getter Method
Signature
ReportFilterObject
Returns: Return type: str New in version NX10.0.3.
License requirements: None.
-------------------------------------
Setter Method
Signature
ReportFilterObject
Parameters: reportFilterObject (str) – New in version NX10.0.3.
License requirements: insp_programming (“INSPECTION PROGRAMMING”)
ReportFilterType¶
-
InspectionGraphicalReportBuilder.
ReportFilterType
¶ Returns or sets the report filter type
-------------------------------------
Getter Method
Signature
ReportFilterType
Returns: Return type: NXOpen.CAM.InspectionGraphicalReportBuilderGraphicalReportFilterType
New in version NX10.0.3.
License requirements: None.
-------------------------------------
Setter Method
Signature
ReportFilterType
Parameters: reportFilterType ( NXOpen.CAM.InspectionGraphicalReportBuilderGraphicalReportFilterType
) –New in version NX10.0.3.
License requirements: insp_programming (“INSPECTION PROGRAMMING”)
ReportName¶
-
InspectionGraphicalReportBuilder.
ReportName
¶ Returns or sets the report operation name
-------------------------------------
Getter Method
Signature
ReportName
Returns: Return type: str New in version NX10.0.3.
License requirements: None.
-------------------------------------
Setter Method
Signature
ReportName
Parameters: reportName (str) – New in version NX10.0.3.
License requirements: insp_programming (“INSPECTION PROGRAMMING”)
ReportTitle¶
-
InspectionGraphicalReportBuilder.
ReportTitle
¶ Returns or sets the report title
-------------------------------------
Getter Method
Signature
ReportTitle
Returns: Return type: str New in version NX10.0.3.
License requirements: None.
-------------------------------------
Setter Method
Signature
ReportTitle
Parameters: reportTitle (str) – New in version NX10.0.3.
License requirements: insp_programming (“INSPECTION PROGRAMMING”)
Method Detail¶
ActivateView¶
-
InspectionGraphicalReportBuilder.
ActivateView
¶ Activate the specified view.
Signature
ActivateView()
New in version NX10.0.3.
License requirements: insp_programming (“INSPECTION PROGRAMMING”)
CaptureCurrentView¶
-
InspectionGraphicalReportBuilder.
CaptureCurrentView
¶ Capture the current view.
Signature
CaptureCurrentView()
New in version NX10.0.3.
License requirements: insp_programming (“INSPECTION PROGRAMMING”)
RestoreOriginalView¶
-
InspectionGraphicalReportBuilder.
RestoreOriginalView
¶ Restore the original view.
Signature
RestoreOriginalView()
New in version NX10.0.3.
License requirements: insp_programming (“INSPECTION PROGRAMMING”)
SaveViewCacheSettings¶
-
InspectionGraphicalReportBuilder.
SaveViewCacheSettings
¶ Cache the current view settings.
Signature
SaveViewCacheSettings()
New in version NX10.0.3.
License requirements: insp_programming (“INSPECTION PROGRAMMING”)
Validate¶
-
InspectionGraphicalReportBuilder.
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.