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

Inheritance diagram for NXOpen::CAM::PlanarOperationBuilder:

Public Types
enum	AutomaticPartBoundaryMethodTypes { AutomaticPartBoundaryMethodTypesFollowWallBottom, AutomaticPartBoundaryMethodTypesFollowWallTop }
	Available types for automatic part boundary method in planar mill operation. More...

Public Types inherited from NXOpen::CAM::MillOperationBuilder
enum	WallCleanupTypes { WallCleanupTypesNone, WallCleanupTypesAtStart, WallCleanupTypesAtEnd, WallCleanupTypesAutomatic }
	the wall cleanup modes Created in NX12.0.0. 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
int	AdditionalPasses ()
	Returns the Boundary Additional Passes Created in NX5.0.0. More...

NXOpen::CAM::PlanarOperationBuilder::AutomaticPartBoundaryMethodTypes	AutomaticPartBoundaryMethod ()
	Returns the Automatic Part Boundary Method Created in NX6.0.0. More...

NXOpen::CAM::StepoverBuilder *	BndStepover ()
	Returns the boundary stepover builder Created in NX5.0.0. More...

NXOpen::CAM::Geometry *	CheckGeometry ()
	Returns the check geometry builder Created in NX8.0.0. More...

bool	CornerLoops ()
	Returns the corner loops value Created in NX5.0.0. More...

NXOpen::CAM::Geometry *	CutAreaGeometry ()
	Returns the cut area geometry builder Created in NX8.0.0. More...

NXOpen::CAM::CutPatternBuilder *	CutPattern ()
	Returns the cut pattern builder Created in NX6.0.0. More...

bool	DeferCuttingStatus ()
	Returns the defer cutting status value Created in NX5.0.0. More...

NXOpen::CAM::InheritableDoubleBuilder *	DepthPerCut ()
	Returns the depth per cut builder (inheritable double) Created in NX5.0.0. More...

bool	IslandCleanup ()
	Returns the island cleanup status Created in NX12.0.0. More...

NXOpen::CAM::NcmPlanarBuilder *	NonCuttingBuilder ()
	Returns the non-cutting moves builder Created in NX5.0.0. More...

NXOpen::CAM::Geometry *	PartGeometry ()
	Returns the part geometry builder Created in NX8.0.0. More...

void	SetAdditionalPasses (int numPasses)
	Sets the Boundary Additional Passes Created in NX5.0.0. More...

void	SetAutomaticPartBoundaryMethod (NXOpen::CAM::PlanarOperationBuilder::AutomaticPartBoundaryMethodTypes automaticPartBoundary)
	Sets the Automatic Part Boundary Method Created in NX6.0.0. More...

void	SetCornerLoops (bool cornerLoops)
	Sets the corner loops value Created in NX5.0.0. More...

void	SetDeferCuttingStatus (bool deferCuttingStatus)
	Sets the defer cutting status value Created in NX5.0.0. More...

void	SetIslandCleanup (bool status)
	Sets the island cleanup status Created in NX12.0.0. More...

void	SetToolMinimumLengthUsage (bool toolMinUsage)
	Sets the tool minimum length usage Created in NX5.0.0. More...

NXOpen::CAM::ToolAxisFixed *	ToolAxisFix ()
	Returns the pmop tool axis ci builder Created in NX7.5.0. More...

bool	ToolMinimumLengthUsage ()
	Returns the tool minimum length usage Created in NX5.0.0. More...

Public Member Functions inherited from NXOpen::CAM::MillOperationBuilder
NXOpen::CAM::MillCutParameters *	CutParameters ()
	Returns the cut parameter object Created in NX6.0.0. More...

NXOpen::CAM::FeedsBuilder *	FeedsBuilder ()
	Returns the feeds and speeds builder Created in NX5.0.0. More...

NXOpen::CAM::InheritableToolDepBuilder *	MinCutLength ()
	Returns the min cut length builder (tool dependent double) Created in NX6.0.0. More...

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

NXOpen::CAM::Tool *	ReferenceTool ()
	Returns the reference tool object Created in NX7.5.0. More...

void	SetReferenceTool (NXOpen::CAM::Tool *refTool)
	Sets the reference tool object Created in NX7.5.0. More...

void	SetWallCleanupType (NXOpen::CAM::MillOperationBuilder::WallCleanupTypes mode)
	Sets the wall cleanup mode Created in NX12.0.0. More...

NXOpen::CAM::MillOperationBuilder::WallCleanupTypes	WallCleanupType ()
	Returns the wall cleanup mode Created in NX12.0.0. 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::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 PlanarOperation Builder
This is an abstract class and cannot be instantiated.

Created in NX5.0.0.

Member Enumeration Documentation

enum NXOpen::CAM::PlanarOperationBuilder::AutomaticPartBoundaryMethodTypes

Available types for automatic part boundary method in planar mill operation.

Enumerator
AutomaticPartBoundaryMethodTypesFollowWallBottom	Follow Bottom.
AutomaticPartBoundaryMethodTypesFollowWallTop	Follow Top.

Member Function Documentation

int NXOpen::CAM::PlanarOperationBuilder::AdditionalPasses ( )

Returns the Boundary Additional Passes
Created in NX5.0.0.

License requirements : None

NXOpen::CAM::PlanarOperationBuilder::AutomaticPartBoundaryMethodTypes NXOpen::CAM::PlanarOperationBuilder::AutomaticPartBoundaryMethod ( )

Returns the Automatic Part Boundary Method
Created in NX6.0.0.

License requirements : None

NXOpen::CAM::StepoverBuilder* NXOpen::CAM::PlanarOperationBuilder::BndStepover ( )

Returns the boundary stepover builder
Created in NX5.0.0.

License requirements : None

NXOpen::CAM::Geometry* NXOpen::CAM::PlanarOperationBuilder::CheckGeometry ( )

Returns the check geometry builder
Created in NX8.0.0.

License requirements : None

bool NXOpen::CAM::PlanarOperationBuilder::CornerLoops ( )

Returns the corner loops value
Created in NX5.0.0.

License requirements : None

NXOpen::CAM::Geometry* NXOpen::CAM::PlanarOperationBuilder::CutAreaGeometry ( )

Returns the cut area geometry builder
Created in NX8.0.0.

License requirements : None

NXOpen::CAM::CutPatternBuilder* NXOpen::CAM::PlanarOperationBuilder::CutPattern ( )

Returns the cut pattern builder
Created in NX6.0.0.

License requirements : None

bool NXOpen::CAM::PlanarOperationBuilder::DeferCuttingStatus ( )

Returns the defer cutting status value
Created in NX5.0.0.

License requirements : None

NXOpen::CAM::InheritableDoubleBuilder* NXOpen::CAM::PlanarOperationBuilder::DepthPerCut ( )

Returns the depth per cut builder (inheritable double)
Created in NX5.0.0.

License requirements : None

bool NXOpen::CAM::PlanarOperationBuilder::IslandCleanup ( )

Returns the island cleanup status
Created in NX12.0.0.

License requirements : None

NXOpen::CAM::NcmPlanarBuilder* NXOpen::CAM::PlanarOperationBuilder::NonCuttingBuilder ( )

Returns the non-cutting moves builder
Created in NX5.0.0.

License requirements : None

NXOpen::CAM::Geometry* NXOpen::CAM::PlanarOperationBuilder::PartGeometry ( )

Returns the part geometry builder
Created in NX8.0.0.

License requirements : None

void NXOpen::CAM::PlanarOperationBuilder::SetAdditionalPasses ( int numPasses )

Sets the Boundary Additional Passes
Created in NX5.0.0.

License requirements : cam_base ("CAM BASE")

Parameters

numPasses the Boundary Additional Passes

void NXOpen::CAM::PlanarOperationBuilder::SetAutomaticPartBoundaryMethod ( NXOpen::CAM::PlanarOperationBuilder::AutomaticPartBoundaryMethodTypes automaticPartBoundary )

Sets the Automatic Part Boundary Method
Created in NX6.0.0.

License requirements : cam_base ("CAM BASE")

Parameters

automaticPartBoundary automaticpartboundary

void NXOpen::CAM::PlanarOperationBuilder::SetCornerLoops ( bool cornerLoops )

Sets the corner loops value
Created in NX5.0.0.

License requirements : cam_base ("CAM BASE")

Parameters

cornerLoops the corner loops value

void NXOpen::CAM::PlanarOperationBuilder::SetDeferCuttingStatus ( bool deferCuttingStatus )

Sets the defer cutting status value
Created in NX5.0.0.

License requirements : cam_base ("CAM BASE")

Parameters

deferCuttingStatus the defer cutting status value

void NXOpen::CAM::PlanarOperationBuilder::SetIslandCleanup ( bool status )

Sets the island cleanup status
Created in NX12.0.0.

License requirements : None

Parameters

status status

void NXOpen::CAM::PlanarOperationBuilder::SetToolMinimumLengthUsage ( bool toolMinUsage )

Sets the tool minimum length usage
Created in NX5.0.0.

License requirements : cam_base ("CAM BASE")

Parameters

toolMinUsage the tool minimum length usage

NXOpen::CAM::ToolAxisFixed* NXOpen::CAM::PlanarOperationBuilder::ToolAxisFix ( )

Returns the pmop tool axis ci builder
Created in NX7.5.0.

License requirements : None

bool NXOpen::CAM::PlanarOperationBuilder::ToolMinimumLengthUsage ( )

Returns the tool minimum length usage
Created in NX5.0.0.

License requirements : None

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

CAM_PlanarOperationBuilder.hxx

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Member Function Documentation