NX Open C++ Reference Guide
Public Types | Public Member Functions | List of all members
NXOpen::CAM::InspectionGraphicalReportBuilder Class Reference

Represents the builder for the CMM Inspection Graphical Report Operation
To create a new instance of this class, use NXOpen::CAM::InspectionOperationCollection::CreateGraphicalReportBuilder

Created in NX10.0.3. More...

Inheritance diagram for NXOpen::CAM::InspectionGraphicalReportBuilder:
NXOpen::CAM::OperationBuilder NXOpen::CAM::ParamBuilder NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Types

enum  GraphicalReportFilter { GraphicalReportFilterNone }
 Filters for specifying report objects. More...
 
enum  GraphicalReportFilterType { GraphicalReportFilterTypeTolerances, GraphicalReportFilterTypePoints }
 Types of graphical reports. More...
 
- Public Types inherited from NXOpen::CAM::OperationBuilder
enum  HoleAxisTypes { HoleAxisTypesVector, HoleAxisTypesRule, HoleAxisTypesRuleIfNoVector }
 Available types for Hole Axis Type in feature milling and hole making. More...
 
enum  HoleDepthTypes { HoleDepthTypesPoint, HoleDepthTypesRule }
 Available types for Hole Depth Type in feature milling and hole making. More...
 
enum  OptimizationBasedOnTypes { OptimizationBasedOnTypesDist, OptimizationBasedOnTypesOrient }
 Available types for optimization based on in operation. More...
 
enum  OptimizationDistanceTypes { OptimizationDistanceTypesDirect, OptimizationDistanceTypesTransition }
 Available types for optimization distance method in operation. More...
 
enum  OptimizationLevelTypes { OptimizationLevelTypesStandard, OptimizationLevelTypesAdvanced }
 Available types for optimization level in operation. More...
 
- Public Types inherited from NXOpen::CAM::ParamBuilder
enum  OptimizationTypes { OptimizationTypesNone, OptimizationTypesMinimizeTravel, OptimizationTypesBand }
 Available types for Optimization Method in operation. More...
 

Public Member Functions

void ActivateView ()
 Activate the specified view. More...
 
NXOpen::SelectNXObjectListAvailableSelection ()
 Returns the available objects screen selection button
Created in NX10.0.3. More...
 
NXString Camera ()
 Returns the camera to use
Created in NX10.0.3. More...
 
void CaptureCurrentView ()
 Capture the current view. More...
 
NXOpen::CAM::InspectionGraphicalReportBuilder::GraphicalReportFilter FilterEnum ()
 Returns the filter enum
Created in NX10.0.3. More...
 
NXString ReportFilterObject ()
 Returns the report filter object
Created in NX10.0.3. More...
 
NXOpen::CAM::InspectionGraphicalReportBuilder::GraphicalReportFilterType ReportFilterType ()
 Returns the report filter type
Created in NX10.0.3. More...
 
NXString ReportName ()
 Returns the report operation name
Created in NX10.0.3. More...
 
NXString ReportTitle ()
 Returns the report title
Created in NX10.0.3. More...
 
void RestoreOriginalView ()
 Restore the original view. More...
 
void SaveViewCacheSettings ()
 Cache the current view settings. More...
 
void SetCamera (const NXString &camera)
 Sets the camera to use
Created in NX10.0.3. More...
 
void SetCamera (const char *camera)
 Sets the camera to use
Created in NX10.0.3. More...
 
void SetFilterEnum (NXOpen::CAM::InspectionGraphicalReportBuilder::GraphicalReportFilter filterEnum)
 Sets the filter enum
Created in NX10.0.3. More...
 
void SetReportFilterObject (const NXString &reportFilterObject)
 Sets the report filter object
Created in NX10.0.3. More...
 
void SetReportFilterObject (const char *reportFilterObject)
 Sets the report filter object
Created in NX10.0.3. More...
 
void SetReportFilterType (NXOpen::CAM::InspectionGraphicalReportBuilder::GraphicalReportFilterType reportFilterType)
 Sets the report filter type
Created in NX10.0.3. More...
 
void SetReportName (const NXString &reportName)
 Sets the report operation name
Created in NX10.0.3. More...
 
void SetReportName (const char *reportName)
 Sets the report operation name
Created in NX10.0.3. More...
 
void SetReportTitle (const NXString &reportTitle)
 Sets the report title
Created in NX10.0.3. More...
 
void SetReportTitle (const char *reportTitle)
 Sets the report title
Created in NX10.0.3. More...
 
- Public Member Functions inherited from NXOpen::CAM::OperationBuilder
NXString ChannelName ()
 Returns the channel's name
Created in NX7.5.0. More...
 
NXString Description ()
 Returns the description
Created in NX9.0.0. More...
 
NXOpen::CAM::PostEventsCiBuilderEndOfPath ()
 Returns the end event builder
Created in NX5.0.1. More...
 
NXOpen::CAM::UdeSetEndUdeSet ()
 Returns the end ude set
Created in NX7.5.0. More...
 
NXOpen::CAM::GeometryCiBuilderGeometry ()
 Returns the geometry builder
Created in NX5.0.0. More...
 
std::vector< double > GetHoleAxisValues ()
 Get the Hole Axis values. More...
 
bool GougeChecking ()
 Returns the gouge checking flag
Created in NX9.0.0. More...
 
NXOpen::CAM::OperationBuilder::HoleAxisTypes HoleAxisType ()
 Returns the Hole Axis Type
Created in NX5.0.0. More...
 
NXOpen::CAM::InheritableDoubleBuilderHoleDepth ()
 Returns the max depth distance builder
Created in NX5.0.0. More...
 
NXOpen::CAM::OperationBuilder::HoleDepthTypes HoleDepthType ()
 Returns the Hole Depth Type
Created in NX5.0.0. More...
 
NXOpen::CAM::LayoutCiBuilderLayoutAndLayer ()
 Returns the Layer and Layout
Created in NX9.0.1. More...
 
NXOpen::CAM::ArcOutputTypeCiBuilderMotionOutputBuilder ()
 Returns the motion output builder
Created in NX8.0.0. More...
 
NXOpen::CAM::NotesNotes ()
 Returns the notes builder
Created in NX9.0.0. More...
 
NXOpen::CAM::OperationBuilder::OptimizationBasedOnTypes OptimizationBasedOn ()
 Returns the optimization based on in operation
Created in NX5.0.0. More...
 
NXOpen::CAM::OperationBuilder::OptimizationDistanceTypes OptimizationDistanceMethod ()
 Returns the optimization distance method in operation
Created in NX5.0.0. More...
 
NXOpen::CAM::OperationBuilder::OptimizationLevelTypes OptimizationLevel ()
 Returns the optimization level in operation
Created in NX5.0.0. More...
 
NXOpen::CAM::OperationDisplayOptionsBuilderPathDisplayOptions ()
 Returns the path display options builder
Created in NX6.0.0. More...
 
NXString PostToolPathExit ()
 Returns the environment variable that points to the post tool path generation library which has the exit
Created in NX9.0.3. More...
 
NXOpen::CAM::InheritableDoubleBuilderRetractDistance ()
 Returns the Retract Distance builder (inheritable double)
Created in NX5.0.0. More...
 
NXOpen::CAM::InheritableDoubleBuilderRetractDistanceOnToolAxisChange ()
 Returns the Retract Distance on Tool Axis Change builder (inheritable double)
Created in NX5.0.0. More...
 
NXOpen::CAM::InheritableDoubleBuilderSafeClearance ()
 Returns the safe clearance builder
Created in NX6.0.0. More...
 
bool SelectToolFlag ()
 Returns the user selected tool
Created in NX5.0.0. More...
 
void SetChannelName (const NXString &channel)
 Sets the channel's name
Created in NX7.5.0. More...
 
void SetChannelName (const char *channel)
 Sets the channel's name
Created in NX7.5.0. More...
 
void SetDescription (const NXString &description)
 Sets the description
Created in NX9.0.0. More...
 
void SetDescription (const char *description)
 Sets the description
Created in NX9.0.0. More...
 
void SetGougeChecking (bool gougeChecking)
 Sets the gouge checking flag
Created in NX9.0.0. More...
 
void SetHoleAxisType (NXOpen::CAM::OperationBuilder::HoleAxisTypes types)
 Sets the Hole Axis Type
Created in NX5.0.0. More...
 
void SetHoleAxisValues (const std::vector< double > &holeAxis)
 Set the Hole Axis values
Created in NX5.0.0. More...
 
void SetHoleDepthType (NXOpen::CAM::OperationBuilder::HoleDepthTypes types)
 Sets the Hole Depth Type
Created in NX5.0.0. More...
 
void SetOptimizationBasedOn (NXOpen::CAM::OperationBuilder::OptimizationBasedOnTypes optimBasedOn)
 Sets the optimization based on in operation
Created in NX5.0.0. More...
 
void SetOptimizationDistanceMethod (NXOpen::CAM::OperationBuilder::OptimizationDistanceTypes optimDistance)
 Sets the optimization distance method in operation
Created in NX5.0.0. More...
 
void SetOptimizationLevel (NXOpen::CAM::OperationBuilder::OptimizationLevelTypes optimType)
 Sets the optimization level in operation
Created in NX5.0.0. More...
 
void SetPostToolPathExit (const NXString &exitName)
 Sets the environment variable that points to the post tool path generation library which has the exit
Created in NX9.0.3. More...
 
void SetPostToolPathExit (const char *exitName)
 Sets the environment variable that points to the post tool path generation library which has the exit
Created in NX9.0.3. More...
 
void SetSelectToolFlag (bool selToolFlag)
 Sets the user selected tool
Created in NX5.0.0. More...
 
NXOpen::CAM::PostEventsCiBuilderStartOfPath ()
 Returns the start event builder
Created in NX5.0.1. More...
 
NXOpen::CAM::UdeSetStartUdeSet ()
 Returns the start ude set
Created in NX7.5.0. More...
 
NXOpen::CAM::ToolChangeCiBuilderToolChangeSetting ()
 Returns the tool change builder
Created in NX5.0.0. More...
 
NXOpen::CAM::ToolPathEditorBuilderToolPathEditor ()
 Returns the Tool Path Editor Builder
Created in NX9.0.3. More...
 
NXOpen::CAM::ToolPathSplitParametersBuilderToolPathSplitParametersBuilder ()
 Returns the tool path split Parameters
Created in NX9.0.0. More...
 
- Public Member Functions inherited from NXOpen::CAM::ParamBuilder
NXOpen::CAM::UdeCycleEvent ()
 Returns the cycle event
Created in NX7.5.0. More...
 
NXOpen::CAM::CycleCycleTable ()
 Returns the cycle
Created in NX9.0.0. More...
 
NXOpen::TaggedObjectGetCustomizableItemBuilder (const NXString &name)
 Returns the customizable item builder for the given customizable item name. More...
 
NXOpen::TaggedObjectGetCustomizableItemBuilder (const char *name)
 Returns the customizable item builder for the given customizable item name. More...
 
std::vector< NXStringGetCustomizableItemNames ()
 Returns the names for all customizable item ids. More...
 
NXOpen::CAM::ParamBuilder::OptimizationTypes OptimizationMethod ()
 Returns the optim method
Created in NX5.0.0. More...
 
void SetOptimizationMethod (NXOpen::CAM::ParamBuilder::OptimizationTypes optimMethod)
 Sets the optim method
Created in NX5.0.0. More...
 
- Public Member Functions inherited from NXOpen::Builder
NXOpen::NXObjectCommit ()
 Commits any edits that have been applied to the builder. More...
 
void Destroy ()
 Deletes the builder, and cleans up any objects created by the builder. More...
 
std::vector< NXOpen::NXObject * > GetCommittedObjects ()
 For builders that create more than one object, this method returns the objects that are created by commit. More...
 
NXOpen::NXObjectGetObject ()
 Returns the object currently being edited by this builder. More...
 
void ShowResults ()
 Updates the model to reflect the result of an edit to the model for all builders that support showing results. More...
 
virtual bool Validate ()
 Validate whether the inputs to the component are sufficient for commit to be called. More...
 
- Public Member Functions inherited from NXOpen::TaggedObject
tag_t Tag () const
 Returns the tag of this object. More...
 

Detailed Description

Represents the builder for the CMM Inspection Graphical Report Operation
To create a new instance of this class, use NXOpen::CAM::InspectionOperationCollection::CreateGraphicalReportBuilder

Created in NX10.0.3.


Member Enumeration Documentation

Filters for specifying report objects.

Enumerator
GraphicalReportFilterNone 

No filter.

Types of graphical reports.

Enumerator
GraphicalReportFilterTypeTolerances 

Tolerance based.

GraphicalReportFilterTypePoints 

Point based.

Member Function Documentation

void NXOpen::CAM::InspectionGraphicalReportBuilder::ActivateView ( )

Activate the specified view.


Created in NX10.0.3.

License requirements : insp_programming ("INSPECTION PROGRAMMING")

NXOpen::SelectNXObjectList* NXOpen::CAM::InspectionGraphicalReportBuilder::AvailableSelection ( )

Returns the available objects screen selection button
Created in NX10.0.3.



License requirements : None

NXString NXOpen::CAM::InspectionGraphicalReportBuilder::Camera ( )

Returns the camera to use
Created in NX10.0.3.



License requirements : None

void NXOpen::CAM::InspectionGraphicalReportBuilder::CaptureCurrentView ( )

Capture the current view.


Created in NX10.0.3.

License requirements : insp_programming ("INSPECTION PROGRAMMING")

NXOpen::CAM::InspectionGraphicalReportBuilder::GraphicalReportFilter NXOpen::CAM::InspectionGraphicalReportBuilder::FilterEnum ( )

Returns the filter enum
Created in NX10.0.3.



License requirements : None

NXString NXOpen::CAM::InspectionGraphicalReportBuilder::ReportFilterObject ( )

Returns the report filter object
Created in NX10.0.3.



License requirements : None

NXOpen::CAM::InspectionGraphicalReportBuilder::GraphicalReportFilterType NXOpen::CAM::InspectionGraphicalReportBuilder::ReportFilterType ( )

Returns the report filter type
Created in NX10.0.3.



License requirements : None

NXString NXOpen::CAM::InspectionGraphicalReportBuilder::ReportName ( )

Returns the report operation name
Created in NX10.0.3.



License requirements : None

NXString NXOpen::CAM::InspectionGraphicalReportBuilder::ReportTitle ( )

Returns the report title
Created in NX10.0.3.



License requirements : None

void NXOpen::CAM::InspectionGraphicalReportBuilder::RestoreOriginalView ( )

Restore the original view.


Created in NX10.0.3.

License requirements : insp_programming ("INSPECTION PROGRAMMING")

void NXOpen::CAM::InspectionGraphicalReportBuilder::SaveViewCacheSettings ( )

Cache the current view settings.


Created in NX10.0.3.

License requirements : insp_programming ("INSPECTION PROGRAMMING")

void NXOpen::CAM::InspectionGraphicalReportBuilder::SetCamera ( const NXString camera)

Sets the camera to use
Created in NX10.0.3.



License requirements : insp_programming ("INSPECTION PROGRAMMING")

Parameters
cameracamera
void NXOpen::CAM::InspectionGraphicalReportBuilder::SetCamera ( const char *  camera)

Sets the camera to use
Created in NX10.0.3.



License requirements : insp_programming ("INSPECTION PROGRAMMING")

Parameters
cameracamera
void NXOpen::CAM::InspectionGraphicalReportBuilder::SetFilterEnum ( NXOpen::CAM::InspectionGraphicalReportBuilder::GraphicalReportFilter  filterEnum)

Sets the filter enum
Created in NX10.0.3.



License requirements : insp_programming ("INSPECTION PROGRAMMING")

Parameters
filterEnumfilterenum
void NXOpen::CAM::InspectionGraphicalReportBuilder::SetReportFilterObject ( const NXString reportFilterObject)

Sets the report filter object
Created in NX10.0.3.



License requirements : insp_programming ("INSPECTION PROGRAMMING")

Parameters
reportFilterObjectreportfilterobject
void NXOpen::CAM::InspectionGraphicalReportBuilder::SetReportFilterObject ( const char *  reportFilterObject)

Sets the report filter object
Created in NX10.0.3.



License requirements : insp_programming ("INSPECTION PROGRAMMING")

Parameters
reportFilterObjectreportfilterobject
void NXOpen::CAM::InspectionGraphicalReportBuilder::SetReportFilterType ( NXOpen::CAM::InspectionGraphicalReportBuilder::GraphicalReportFilterType  reportFilterType)

Sets the report filter type
Created in NX10.0.3.



License requirements : insp_programming ("INSPECTION PROGRAMMING")

Parameters
reportFilterTypereportfiltertype
void NXOpen::CAM::InspectionGraphicalReportBuilder::SetReportName ( const NXString reportName)

Sets the report operation name
Created in NX10.0.3.



License requirements : insp_programming ("INSPECTION PROGRAMMING")

Parameters
reportNamereportname
void NXOpen::CAM::InspectionGraphicalReportBuilder::SetReportName ( const char *  reportName)

Sets the report operation name
Created in NX10.0.3.



License requirements : insp_programming ("INSPECTION PROGRAMMING")

Parameters
reportNamereportname
void NXOpen::CAM::InspectionGraphicalReportBuilder::SetReportTitle ( const NXString reportTitle)

Sets the report title
Created in NX10.0.3.



License requirements : insp_programming ("INSPECTION PROGRAMMING")

Parameters
reportTitlereporttitle
void NXOpen::CAM::InspectionGraphicalReportBuilder::SetReportTitle ( const char *  reportTitle)

Sets the report title
Created in NX10.0.3.



License requirements : insp_programming ("INSPECTION PROGRAMMING")

Parameters
reportTitlereporttitle

The documentation for this class was generated from the following file:
Copyright 2017 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.