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

Represents a CylinderMillingBuilder Builder
To create a new instance of this class, use NXOpen::CAM::OperationCollection::CreateCylinderMillingBuilder

Created in NX8.0.0. More...

Inheritance diagram for NXOpen::CAM::CylinderMillingBuilder:
NXOpen::CAM::CylindricalMillingBuilder NXOpen::CAM::HoleMachiningBuilder NXOpen::CAM::OperationBuilder NXOpen::CAM::ParamBuilder NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Types

enum  BlankDiameterTypes { BlankDiameterTypesDiameter, BlankDiameterTypesDistance }
 blank diamter options
Created in NX8.0.0. More...
 
enum  CutPatternTypes { CutPatternTypesSpiral, CutPatternTypesHelical, CutPatternTypesHelicalAndSpiral, CutPatternTypesCircular }
 cut pattern options
Created in NX8.0.0. More...
 
enum  DepthPerRevolutionTypes { DepthPerRevolutionTypesDistance, DepthPerRevolutionTypesRampAngle }
 Depth Per Revolution options
Created in NX8.0.0. More...
 
enum  DiameterForHelixTypes { DiameterForHelixTypesDiameter, DiameterForHelixTypesSpiralThickness, DiameterForHelixTypesOffsetFromStartDiameter }
 Diameter for Helix
Created in NX8.0.0. More...
 

Public Member Functions

NXOpen::CAM::InheritableToolDepBuilderAxialDistance ()
 Returns the distance builder for Depth per Revolution
Created in NX8.0.0. More...
 
NXOpen::CAM::CylinderMillingBuilder::BlankDiameterTypes BlankDiameter ()
 Returns the start location
Created in NX8.0.0. More...
 
NXOpen::CAM::InheritableToolDepBuilderBlankDistance ()
 Returns the Wall Thickness
Created in NX8.0.0. More...
 
bool CleanupPasses ()
 Returns the Cleanup Passes
Created in NX8.0.0. More...
 
NXOpen::CAM::CylinderMillingCutParametersCutParameters ()
 Returns the Cylinder Milling Cut Parameters
More...
 
NXOpen::CAM::CylinderMillingBuilder::CutPatternTypes CutPattern ()
 Returns the cut pattern
Created in NX8.0.0. More...
 
NXOpen::CAM::CylinderMillingBuilder::DepthPerRevolutionTypes DepthPerRevolution ()
 Returns the Depth per Revolution
Created in NX8.0.0. More...
 
NXOpen::CAM::CylinderMillingBuilder::DiameterForHelixTypes DiameterForHelix ()
 Returns the Diameter for Helix
Created in NX8.0.0. More...
 
NXOpen::CAM::InheritableToolDepBuilderHelixDiameter ()
 Returns the Helix Diamter
Created in NX8.0.0. More...
 
NXOpen::CAM::InheritableToolDepBuilderMinimumHelixDiameter ()
 Returns the Minimum Helix Diameter
Created in NX8.0.0. More...
 
NXOpen::CAM::InheritableToolDepBuilderOffsetFromStartDiameter ()
 Returns the Offset from Start Diameter
Created in NX9.0.0. More...
 
bool OppositeDirection ()
 Returns the opposite direction
Created in NX8.0.0. More...
 
NXOpen::CAM::OppositeDirectionOppositeDirectionBuilder ()
 Returns the opposite direction builder
More...
 
NXOpen::CAM::InheritableDoubleBuilderRampAngle ()
 Returns the Ramp Angle
Created in NX8.0.0. More...
 
void SetBlankDiameter (NXOpen::CAM::CylinderMillingBuilder::BlankDiameterTypes newValue)
 Sets the start location
Created in NX8.0.0. More...
 
void SetCleanupPasses (bool newValue)
 Sets the Cleanup Passes
Created in NX8.0.0. More...
 
void SetCutPattern (NXOpen::CAM::CylinderMillingBuilder::CutPatternTypes newValue)
 Sets the cut pattern
Created in NX8.0.0. More...
 
void SetDepthPerRevolution (NXOpen::CAM::CylinderMillingBuilder::DepthPerRevolutionTypes newValue)
 Sets the Depth per Revolution
Created in NX8.0.0. More...
 
void SetDiameterForHelix (NXOpen::CAM::CylinderMillingBuilder::DiameterForHelixTypes newValue)
 Sets the Diameter for Helix
Created in NX8.0.0. More...
 
void SetOppositeDirection (bool newValue)
 Sets the opposite direction
Created in NX8.0.0. More...
 
NXOpen::CAM::InheritableToolDepBuilderSpiralThickness ()
 Returns the Spiral Thickness
Created in NX8.0.0. More...
 
NXOpen::CAM::InheritableToolDepBuilderStartDiameter ()
 Returns the Start Diameter
Created in NX8.0.0. More...
 
- Public Member Functions inherited from NXOpen::CAM::CylindricalMillingBuilder
NXOpen::CAM::StepoverBuilderAxialStepover ()
 Returns the Axial Stepover builder
Created in NX9.0.2. More...
 
NXOpen::CAM::StepoverBuilderRadialStepover ()
 Returns the Radial Stepover builder
Created in NX9.0.2. More...
 
- Public Member Functions inherited from NXOpen::CAM::HoleMachiningBuilder
bool CollisionCheck ()
 Returns the collision check for cutting
Created in NX9.0.0. More...
 
NXOpen::CAM::HoleMachiningCutParametersCuttingParameters ()
 Returns the Cut Parameters
Created in NX9.0.3. More...
 
NXOpen::CAM::FeedsBuilderFeedsBuilder ()
 Returns the feeds and speeds builder
Created in NX9.0.2. More...
 
NXOpen::CAM::FBM::FeatureGeometryGetFeatureGeometry ()
 Returns the feature geometry. More...
 
NXOpen::CAM::NcmHoleMachiningNonCuttingBuilder ()
 Returns the non-cutting moves builder
Created in NX9.0.2. More...
 
NXOpen::CAM::DimensionRulePredefinedDepth ()
 Returns the predefined depth
Created in NX11.0.2. More...
 
void RemoveOverrides ()
 Removes overridden attributes of features in the feature geometry
Created in NX11.0.2. More...
 
void SetCollisionCheck (bool newValue)
 Sets the collision check for cutting
Created in NX9.0.0. More...
 
void UnlockFeatures ()
 Unlocks locked features in the feature geometry
Created in NX11.0.2. 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 a CylinderMillingBuilder Builder
To create a new instance of this class, use NXOpen::CAM::OperationCollection::CreateCylinderMillingBuilder

Created in NX8.0.0.


Member Enumeration Documentation

blank diamter options
Created in NX8.0.0.


Enumerator
BlankDiameterTypesDiameter 

Diameter.

BlankDiameterTypesDistance 

distance

cut pattern options
Created in NX8.0.0.


Enumerator
CutPatternTypesSpiral 

Spiral.

CutPatternTypesHelical 

Helical.

CutPatternTypesHelicalAndSpiral 

Helical/Spiral.

CutPatternTypesCircular 

Circular.

Depth Per Revolution options
Created in NX8.0.0.


Enumerator
DepthPerRevolutionTypesDistance 

Distance.

DepthPerRevolutionTypesRampAngle 

Ramp Angle.

Diameter for Helix
Created in NX8.0.0.


Enumerator
DiameterForHelixTypesDiameter 

Helix Diameter.

DiameterForHelixTypesSpiralThickness 

Spiral Thickness.

DiameterForHelixTypesOffsetFromStartDiameter 

Offset from Start Diameter.

Member Function Documentation

NXOpen::CAM::InheritableToolDepBuilder* NXOpen::CAM::CylinderMillingBuilder::AxialDistance ( )

Returns the distance builder for Depth per Revolution
Created in NX8.0.0.



License requirements : None

NXOpen::CAM::CylinderMillingBuilder::BlankDiameterTypes NXOpen::CAM::CylinderMillingBuilder::BlankDiameter ( )

Returns the start location
Created in NX8.0.0.



License requirements : None

NXOpen::CAM::InheritableToolDepBuilder* NXOpen::CAM::CylinderMillingBuilder::BlankDistance ( )

Returns the Wall Thickness
Created in NX8.0.0.



License requirements : None

bool NXOpen::CAM::CylinderMillingBuilder::CleanupPasses ( )

Returns the Cleanup Passes
Created in NX8.0.0.



License requirements : None

NXOpen::CAM::CylinderMillingCutParameters* NXOpen::CAM::CylinderMillingBuilder::CutParameters ( )

Returns the Cylinder Milling Cut Parameters

Deprecated:
Deprecated in NX9.0.3.

Use CAM::HoleMachiningBuilder::CuttingParameters instead.


Created in NX8.0.0.

License requirements : None

NXOpen::CAM::CylinderMillingBuilder::CutPatternTypes NXOpen::CAM::CylinderMillingBuilder::CutPattern ( )

Returns the cut pattern
Created in NX8.0.0.



License requirements : None

NXOpen::CAM::CylinderMillingBuilder::DepthPerRevolutionTypes NXOpen::CAM::CylinderMillingBuilder::DepthPerRevolution ( )

Returns the Depth per Revolution
Created in NX8.0.0.



License requirements : None

NXOpen::CAM::CylinderMillingBuilder::DiameterForHelixTypes NXOpen::CAM::CylinderMillingBuilder::DiameterForHelix ( )

Returns the Diameter for Helix
Created in NX8.0.0.



License requirements : None

NXOpen::CAM::InheritableToolDepBuilder* NXOpen::CAM::CylinderMillingBuilder::HelixDiameter ( )

Returns the Helix Diamter
Created in NX8.0.0.



License requirements : None

NXOpen::CAM::InheritableToolDepBuilder* NXOpen::CAM::CylinderMillingBuilder::MinimumHelixDiameter ( )

Returns the Minimum Helix Diameter
Created in NX8.0.0.



License requirements : None

NXOpen::CAM::InheritableToolDepBuilder* NXOpen::CAM::CylinderMillingBuilder::OffsetFromStartDiameter ( )

Returns the Offset from Start Diameter
Created in NX9.0.0.



License requirements : None

bool NXOpen::CAM::CylinderMillingBuilder::OppositeDirection ( )

Returns the opposite direction
Created in NX8.0.0.



License requirements : None

NXOpen::CAM::OppositeDirection* NXOpen::CAM::CylinderMillingBuilder::OppositeDirectionBuilder ( )

Returns the opposite direction builder

Deprecated:
Deprecated in NX9.0.0.

Change the Z-axis of the in-process feature instead.


Created in NX8.5.0.

License requirements : None

NXOpen::CAM::InheritableDoubleBuilder* NXOpen::CAM::CylinderMillingBuilder::RampAngle ( )

Returns the Ramp Angle
Created in NX8.0.0.



License requirements : None

void NXOpen::CAM::CylinderMillingBuilder::SetBlankDiameter ( NXOpen::CAM::CylinderMillingBuilder::BlankDiameterTypes  newValue)

Sets the start location
Created in NX8.0.0.



License requirements : cam_base ("CAM BASE")

Parameters
newValuethe start location type
void NXOpen::CAM::CylinderMillingBuilder::SetCleanupPasses ( bool  newValue)

Sets the Cleanup Passes
Created in NX8.0.0.



License requirements : cam_base ("CAM BASE")

Parameters
newValuethe Cleanup Passes
void NXOpen::CAM::CylinderMillingBuilder::SetCutPattern ( NXOpen::CAM::CylinderMillingBuilder::CutPatternTypes  newValue)

Sets the cut pattern
Created in NX8.0.0.



License requirements : cam_base ("CAM BASE")

Parameters
newValuethe cut pattern type
void NXOpen::CAM::CylinderMillingBuilder::SetDepthPerRevolution ( NXOpen::CAM::CylinderMillingBuilder::DepthPerRevolutionTypes  newValue)

Sets the Depth per Revolution
Created in NX8.0.0.



License requirements : cam_base ("CAM BASE")

Parameters
newValuethe Depth per Revolution type
void NXOpen::CAM::CylinderMillingBuilder::SetDiameterForHelix ( NXOpen::CAM::CylinderMillingBuilder::DiameterForHelixTypes  newValue)

Sets the Diameter for Helix
Created in NX8.0.0.



License requirements : cam_base ("CAM BASE")

Parameters
newValuethe Diameter for Helix type
void NXOpen::CAM::CylinderMillingBuilder::SetOppositeDirection ( bool  newValue)

Sets the opposite direction
Created in NX8.0.0.



License requirements : cam_base ("CAM BASE")

Parameters
newValuethe opposite direction
NXOpen::CAM::InheritableToolDepBuilder* NXOpen::CAM::CylinderMillingBuilder::SpiralThickness ( )

Returns the Spiral Thickness
Created in NX8.0.0.



License requirements : None

NXOpen::CAM::InheritableToolDepBuilder* NXOpen::CAM::CylinderMillingBuilder::StartDiameter ( )

Returns the Start Diameter
Created in NX8.0.0.



License requirements : None


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