Represents a Opr Builder
This is an abstract class, and cannot be instantiated. More...

Inheritance diagram for NXOpen::CAM::OperationBuilder:

Public Types
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
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::PostEventsCiBuilder *	EndOfPath ()
	Returns the end event builder Created in NX5.0.1. More...

NXOpen::CAM::UdeSet *	EndUdeSet ()
	Returns the end ude set Created in NX7.5.0. More...

NXOpen::CAM::GeometryCiBuilder *	Geometry ()
	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::InheritableDoubleBuilder *	HoleDepth ()
	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::LayoutCiBuilder *	LayoutAndLayer ()
	Returns the Layer and Layout Created in NX9.0.1. More...

NXOpen::CAM::ArcOutputTypeCiBuilder *	MotionOutputBuilder ()
	Returns the motion output builder Created in NX8.0.0. More...

NXOpen::CAM::Notes *	Notes ()
	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::OperationDisplayOptionsBuilder *	PathDisplayOptions ()
	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::InheritableDoubleBuilder *	RetractDistance ()
	Returns the Retract Distance builder (inheritable double) Created in NX5.0.0. More...

NXOpen::CAM::InheritableDoubleBuilder *	RetractDistanceOnToolAxisChange ()
	Returns the Retract Distance on Tool Axis Change builder (inheritable double) Created in NX5.0.0. More...

NXOpen::CAM::InheritableDoubleBuilder *	SafeClearance ()
	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::PostEventsCiBuilder *	StartOfPath ()
	Returns the start event builder Created in NX5.0.1. More...

NXOpen::CAM::UdeSet *	StartUdeSet ()
	Returns the start ude set Created in NX7.5.0. More...

NXOpen::CAM::ToolChangeCiBuilder *	ToolChangeSetting ()
	Returns the tool change builder Created in NX5.0.0. More...

NXOpen::CAM::ToolPathEditorBuilder *	ToolPathEditor ()
	Returns the Tool Path Editor Builder Created in NX9.0.3. More...

NXOpen::CAM::ToolPathSplitParametersBuilder *	ToolPathSplitParametersBuilder ()
	Returns the tool path split Parameters Created in NX9.0.0. More...

Public Member Functions inherited from NXOpen::CAM::ParamBuilder
NXOpen::CAM::Ude *	CycleEvent ()
	Returns the cycle event Created in NX7.5.0. More...

NXOpen::CAM::Cycle *	CycleTable ()
	Returns the cycle Created in NX9.0.0. More...

NXOpen::TaggedObject *	GetCustomizableItemBuilder (const NXString &name)
	Returns the customizable item builder for the given customizable item name. More...

NXOpen::TaggedObject *	GetCustomizableItemBuilder (const char *name)
	Returns the customizable item builder for the given customizable item name. More...

std::vector< NXString >	GetCustomizableItemNames ()
	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::NXObject *	Commit ()
	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::NXObject *	GetObject ()
	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 a Opr Builder
This is an abstract class, and cannot be instantiated.

Default values.

Property

Value

ToolPathEditor.DeltaXC

0

ToolPathEditor.DeltaYC

0

ToolPathEditor.DeltaZC

0

ToolPathEditor.ExtendMethod

Linear

ToolPathEditor.GougeCheckClearanceMethod

Specify

ToolPathEditor.HolderCheck

1

ToolPathEditor.MotionMethod

Delta

ToolPathEditor.MoveStartPoint

1

ToolPathEditor.TransformCircles

0

Created in NX5.0.0.

Member Enumeration Documentation

enum NXOpen::CAM::OperationBuilder::HoleAxisTypes

Available types for Hole Axis Type in feature milling and hole making.

Enumerator
HoleAxisTypesVector	Vector.
HoleAxisTypesRule	Rule.
HoleAxisTypesRuleIfNoVector	Rule if no vector.

enum NXOpen::CAM::OperationBuilder::HoleDepthTypes

Available types for Hole Depth Type in feature milling and hole making.

Enumerator
HoleDepthTypesPoint	Smart Point.
HoleDepthTypesRule	Depth/Rule.

enum NXOpen::CAM::OperationBuilder::OptimizationBasedOnTypes

Available types for optimization based on in operation.

Enumerator
OptimizationBasedOnTypesDist	dist
OptimizationBasedOnTypesOrient	orient

enum NXOpen::CAM::OperationBuilder::OptimizationDistanceTypes

Available types for optimization distance method in operation.

Enumerator
OptimizationDistanceTypesDirect	direct
OptimizationDistanceTypesTransition	transition

enum NXOpen::CAM::OperationBuilder::OptimizationLevelTypes

Available types for optimization level in operation.

Enumerator
OptimizationLevelTypesStandard	standard
OptimizationLevelTypesAdvanced	advanced

Member Function Documentation

NXString NXOpen::CAM::OperationBuilder::ChannelName ( )

Returns the channel's name
Created in NX7.5.0.

License requirements : None

NXString NXOpen::CAM::OperationBuilder::Description ( )

Returns the description
Created in NX9.0.0.

License requirements : cam_base ("CAM BASE")

NXOpen::CAM::PostEventsCiBuilder* NXOpen::CAM::OperationBuilder::EndOfPath ( )

Returns the end event builder
Created in NX5.0.1.

License requirements : None

NXOpen::CAM::UdeSet* NXOpen::CAM::OperationBuilder::EndUdeSet ( )

Returns the end ude set
Created in NX7.5.0.

License requirements : None

NXOpen::CAM::GeometryCiBuilder* NXOpen::CAM::OperationBuilder::Geometry ( )

Returns the geometry builder
Created in NX5.0.0.

License requirements : None

std::vector<double> NXOpen::CAM::OperationBuilder::GetHoleAxisValues ( )

Get the Hole Axis values.

Returns: the Hole Axis values
Created in NX5.0.0.

License requirements : None

bool NXOpen::CAM::OperationBuilder::GougeChecking ( )

Returns the gouge checking flag
Created in NX9.0.0.

License requirements : None

NXOpen::CAM::OperationBuilder::HoleAxisTypes NXOpen::CAM::OperationBuilder::HoleAxisType ( )

Returns the Hole Axis Type
Created in NX5.0.0.

License requirements : None

NXOpen::CAM::InheritableDoubleBuilder* NXOpen::CAM::OperationBuilder::HoleDepth ( )

Returns the max depth distance builder
Created in NX5.0.0.

License requirements : None

NXOpen::CAM::OperationBuilder::HoleDepthTypes NXOpen::CAM::OperationBuilder::HoleDepthType ( )

Returns the Hole Depth Type
Created in NX5.0.0.

License requirements : None

NXOpen::CAM::LayoutCiBuilder* NXOpen::CAM::OperationBuilder::LayoutAndLayer ( )

Returns the Layer and Layout
Created in NX9.0.1.

License requirements : None

NXOpen::CAM::ArcOutputTypeCiBuilder* NXOpen::CAM::OperationBuilder::MotionOutputBuilder ( )

Returns the motion output builder
Created in NX8.0.0.

License requirements : None

NXOpen::CAM::Notes* NXOpen::CAM::OperationBuilder::Notes ( )

Returns the notes builder
Created in NX9.0.0.

License requirements : None

NXOpen::CAM::OperationBuilder::OptimizationBasedOnTypes NXOpen::CAM::OperationBuilder::OptimizationBasedOn ( )

Returns the optimization based on in operation
Created in NX5.0.0.

License requirements : None

NXOpen::CAM::OperationBuilder::OptimizationDistanceTypes NXOpen::CAM::OperationBuilder::OptimizationDistanceMethod ( )

Returns the optimization distance method in operation
Created in NX5.0.0.

License requirements : None

NXOpen::CAM::OperationBuilder::OptimizationLevelTypes NXOpen::CAM::OperationBuilder::OptimizationLevel ( )

Returns the optimization level in operation
Created in NX5.0.0.

License requirements : None

NXOpen::CAM::OperationDisplayOptionsBuilder* NXOpen::CAM::OperationBuilder::PathDisplayOptions ( )

Returns the path display options builder
Created in NX6.0.0.

License requirements : None

NXString NXOpen::CAM::OperationBuilder::PostToolPathExit ( )

Returns the environment variable that points to the post tool path generation library which has the exit
Created in NX9.0.3.

License requirements : cam_base ("CAM BASE")

NXOpen::CAM::InheritableDoubleBuilder* NXOpen::CAM::OperationBuilder::RetractDistance ( )

Returns the Retract Distance builder (inheritable double)
Created in NX5.0.0.

License requirements : None

NXOpen::CAM::InheritableDoubleBuilder* NXOpen::CAM::OperationBuilder::RetractDistanceOnToolAxisChange ( )

Returns the Retract Distance on Tool Axis Change builder (inheritable double)
Created in NX5.0.0.

License requirements : None

NXOpen::CAM::InheritableDoubleBuilder* NXOpen::CAM::OperationBuilder::SafeClearance ( )

Returns the safe clearance builder
Created in NX6.0.0.

License requirements : None

bool NXOpen::CAM::OperationBuilder::SelectToolFlag ( )

Returns the user selected tool
Created in NX5.0.0.

License requirements : None

void NXOpen::CAM::OperationBuilder::SetChannelName ( const NXString & channel )

Sets the channel's name
Created in NX7.5.0.

License requirements : cam_base ("CAM BASE")

Parameters

channel the channel's name

void NXOpen::CAM::OperationBuilder::SetChannelName ( const char * channel )

Sets the channel's name
Created in NX7.5.0.

License requirements : cam_base ("CAM BASE")

Parameters

channel the channel's name

void NXOpen::CAM::OperationBuilder::SetDescription ( const NXString & description )

Sets the description
Created in NX9.0.0.

License requirements : cam_base ("CAM BASE")

Parameters

description the description

void NXOpen::CAM::OperationBuilder::SetDescription ( const char * description )

Sets the description
Created in NX9.0.0.

License requirements : cam_base ("CAM BASE")

Parameters

description the description

void NXOpen::CAM::OperationBuilder::SetGougeChecking ( bool gougeChecking )

Sets the gouge checking flag
Created in NX9.0.0.

License requirements : cam_base ("CAM BASE")

Parameters

gougeChecking the Gouge Checking Flag

void NXOpen::CAM::OperationBuilder::SetHoleAxisType ( NXOpen::CAM::OperationBuilder::HoleAxisTypes types )

Sets the Hole Axis Type
Created in NX5.0.0.

License requirements : cam_base ("CAM BASE")

Parameters

types the Hole Axis Type

void NXOpen::CAM::OperationBuilder::SetHoleAxisValues ( const std::vector< double > & holeAxis )

Set the Hole Axis values
Created in NX5.0.0.

License requirements : cam_base ("CAM BASE")

Parameters

holeAxis the Hole Axis values

void NXOpen::CAM::OperationBuilder::SetHoleDepthType ( NXOpen::CAM::OperationBuilder::HoleDepthTypes types )

Sets the Hole Depth Type
Created in NX5.0.0.

License requirements : cam_base ("CAM BASE")

Parameters

types the Hole Depth Type

void NXOpen::CAM::OperationBuilder::SetOptimizationBasedOn ( NXOpen::CAM::OperationBuilder::OptimizationBasedOnTypes optimBasedOn )

Sets the optimization based on in operation
Created in NX5.0.0.

License requirements : cam_base ("CAM BASE")

Parameters

optimBasedOn optimbasedon

void NXOpen::CAM::OperationBuilder::SetOptimizationDistanceMethod ( NXOpen::CAM::OperationBuilder::OptimizationDistanceTypes optimDistance )

Sets the optimization distance method in operation
Created in NX5.0.0.

License requirements : cam_base ("CAM BASE")

Parameters

optimDistance optimdistance

void NXOpen::CAM::OperationBuilder::SetOptimizationLevel ( NXOpen::CAM::OperationBuilder::OptimizationLevelTypes optimType )

Sets the optimization level in operation
Created in NX5.0.0.

License requirements : cam_base ("CAM BASE")

Parameters

optimType optimtype

void NXOpen::CAM::OperationBuilder::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.

License requirements : cam_base ("CAM BASE")

Parameters

exitName the environment variable that points to the post tool path generation library

void NXOpen::CAM::OperationBuilder::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.

License requirements : cam_base ("CAM BASE")

Parameters

exitName the environment variable that points to the post tool path generation library

void NXOpen::CAM::OperationBuilder::SetSelectToolFlag ( bool selToolFlag )

Sets the user selected tool
Created in NX5.0.0.

License requirements : cam_base ("CAM BASE")

Parameters

selToolFlag the user selected tool

NXOpen::CAM::PostEventsCiBuilder* NXOpen::CAM::OperationBuilder::StartOfPath ( )

Returns the start event builder
Created in NX5.0.1.

License requirements : None

NXOpen::CAM::UdeSet* NXOpen::CAM::OperationBuilder::StartUdeSet ( )

Returns the start ude set
Created in NX7.5.0.

License requirements : None

NXOpen::CAM::ToolChangeCiBuilder* NXOpen::CAM::OperationBuilder::ToolChangeSetting ( )

Returns the tool change builder
Created in NX5.0.0.

License requirements : None

NXOpen::CAM::ToolPathEditorBuilder* NXOpen::CAM::OperationBuilder::ToolPathEditor ( )

Returns the Tool Path Editor Builder
Created in NX9.0.3.

License requirements : None

NXOpen::CAM::ToolPathSplitParametersBuilder* NXOpen::CAM::OperationBuilder::ToolPathSplitParametersBuilder ( )

Returns the tool path split Parameters
Created in NX9.0.0.

License requirements : None

The documentation for this class was generated from the following file:

CAM_OperationBuilder.hxx

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Member Function Documentation