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

Represents a GrooveMillingBuilder
To create a new instance of this class, use NXOpen::CAM::OperationCollection::CreateGrooveMillingBuilder

Created in NX9.0.0. More...

Inheritance diagram for NXOpen::CAM::GrooveMillingBuilder:
NXOpen::CAM::VolumeBased25DMillingOperationBuilder NXOpen::CAM::FaceMillingBuilder NXOpen::CAM::PlanarOperationBuilder NXOpen::CAM::MillOperationBuilder NXOpen::CAM::OperationBuilder NXOpen::CAM::ParamBuilder NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Types

enum  LevelSequencingType {
  LevelSequencingTypeCeilingToFloor, LevelSequencingTypeFloorToCeiling, LevelSequencingTypeCenterCeilingFloor, LevelSequencingTypeCenterFloorCeiling,
  LevelSequencingTypeCenterAlternateCeilingFirst, LevelSequencingTypeCenterAlternateFloorFirst
}
 Available types for level sequencing. More...
 
- Public Types inherited from NXOpen::CAM::VolumeBased25DMillingOperationBuilder
enum  CutDepthsType { CutDepthsTypeLevels, CutDepthsTypeRampByDepth, CutDepthsTypeRampByAngle }
 Available types for cut depths for cut method profile. More...
 

Public Member Functions

NXOpen::CAM::StepoverBuilderAxialStepover ()
 Returns the Axial Stepover
Created in NX9.0.0. More...
 
NXOpen::CAM::FBM::MachiningFeatureGeometryGrooveGeometry ()
 Returns the groove geometry
Created in NX9.0.0. More...
 
NXOpen::CAM::GrooveMillingBuilder::LevelSequencingType LevelSequencing ()
 Returns the level sequencing
Created in NX9.0.0. More...
 
void SetLevelSequencing (NXOpen::CAM::GrooveMillingBuilder::LevelSequencingType currentValue)
 Sets the level sequencing
Created in NX9.0.0. More...
 
- Public Member Functions inherited from NXOpen::CAM::VolumeBased25DMillingOperationBuilder
NXOpen::CAM::GeometryBlankGeometry ()
 Returns the blank geometry builder
Created in NX8.5.0. More...
 
NXOpen::CAM::VolumeBased25DMillingOperationBuilder::CutDepthsType CutDepths ()
 Returns the cut depths type
Created in NX11.0.0. More...
 
bool ExtendWalls ()
 Returns the extend walls flag
Created in NX8.5.0. More...
 
bool FollowNonVerticalWalls ()
 Returns the follow non-vertical walls flag
Created in NX8.5.0. More...
 
void SetCutDepths (NXOpen::CAM::VolumeBased25DMillingOperationBuilder::CutDepthsType cutDepths)
 Sets the cut depths type
Created in NX11.0.0. More...
 
void SetExtendWalls (bool flag)
 Sets the extend walls flag
Created in NX8.5.0. More...
 
void SetFollowNonVerticalWalls (bool flag)
 Sets the follow non-vertical walls flag
Created in NX8.5.0. More...
 
void SetUseCleanupPass (bool flag)
 Sets the cleanup pass flag
Created in NX11.0.0. More...
 
void SetUseExactPositioning (bool flag)
 Sets the exact positioning flag
Created in NX8.5.0. More...
 
NXOpen::CAM::InheritableToolDepBuilderTopOffset ()
 Returns the top offset
Created in NX11.0.0. More...
 
bool UseCleanupPass ()
 Returns the cleanup pass flag
Created in NX11.0.0. More...
 
bool UseExactPositioning ()
 Returns the exact positioning flag
Created in NX8.5.0. More...
 
NXOpen::CAM::InheritableDoubleBuilderWallBlankThickness ()
 Returns the wall blank thickness
Created in NX8.5.0. More...
 
NXOpen::CAM::InheritableDoubleBuilderZDepthOffset ()
 Returns the z-depth offset
Created in NX8.5.0. More...
 
- Public Member Functions inherited from NXOpen::CAM::FaceMillingBuilder
NXOpen::CAM::BoundaryBlankBoundary ()
 Returns the blank boundary
Created in NX9.0.0. More...
 
NXOpen::CAM::BoundaryCheckBoundary ()
 Returns the check boundary
Created in NX9.0.0. More...
 
NXOpen::CAM::RoundPointBuilderRoundPoint ()
 Returns the Round Point Output builder
Created in NX6.0.0. More...
 
NXOpen::CAM::BoundaryTrimBoundary ()
 Returns the trim boundary
Created in NX9.0.0. More...
 
NXOpen::CAM::GeometryWallGeometry ()
 Returns the wall geometry builder
Created in NX8.0.0. More...
 
- Public Member Functions inherited from NXOpen::CAM::PlanarOperationBuilder
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::StepoverBuilderBndStepover ()
 Returns the boundary stepover builder
Created in NX5.0.0. More...
 
NXOpen::CAM::GeometryCheckGeometry ()
 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::GeometryCutAreaGeometry ()
 Returns the cut area geometry builder
Created in NX8.0.0. More...
 
NXOpen::CAM::CutPatternBuilderCutPattern ()
 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::InheritableDoubleBuilderDepthPerCut ()
 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::NcmPlanarBuilderNonCuttingBuilder ()
 Returns the non-cutting moves builder
Created in NX5.0.0. More...
 
NXOpen::CAM::GeometryPartGeometry ()
 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::ToolAxisFixedToolAxisFix ()
 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::MillCutParametersCutParameters ()
 Returns the cut parameter object
Created in NX6.0.0. More...
 
NXOpen::CAM::FeedsBuilderFeedsBuilder ()
 Returns the feeds and speeds builder
Created in NX5.0.0. More...
 
NXOpen::CAM::InheritableToolDepBuilderMinCutLength ()
 Returns the min cut length builder (tool dependent double)
Created in NX6.0.0. More...
 
NXOpen::CAM::ArcOutputTypeCiBuilderMotionOutput ()
 Returns the motion output builder
Created in NX6.0.0. More...
 
NXOpen::CAM::ToolReferenceTool ()
 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::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 GrooveMillingBuilder
To create a new instance of this class, use NXOpen::CAM::OperationCollection::CreateGrooveMillingBuilder

Created in NX9.0.0.


Member Enumeration Documentation

Available types for level sequencing.

Enumerator
LevelSequencingTypeCeilingToFloor 

Ceiling to Floor.

LevelSequencingTypeFloorToCeiling 

Floor to Ceiling.

LevelSequencingTypeCenterCeilingFloor 

Start in Center then Ceiling then Floor.

LevelSequencingTypeCenterFloorCeiling 

Start in Center then Floor then Ceiling.

LevelSequencingTypeCenterAlternateCeilingFirst 

Center Alternate, Ceiling First.

LevelSequencingTypeCenterAlternateFloorFirst 

Center Alternate, Floor First.

Member Function Documentation

NXOpen::CAM::StepoverBuilder* NXOpen::CAM::GrooveMillingBuilder::AxialStepover ( )

Returns the Axial Stepover
Created in NX9.0.0.



License requirements : None

NXOpen::CAM::FBM::MachiningFeatureGeometry* NXOpen::CAM::GrooveMillingBuilder::GrooveGeometry ( )

Returns the groove geometry
Created in NX9.0.0.



License requirements : cam_base ("CAM BASE")

NXOpen::CAM::GrooveMillingBuilder::LevelSequencingType NXOpen::CAM::GrooveMillingBuilder::LevelSequencing ( )

Returns the level sequencing
Created in NX9.0.0.



License requirements : None

void NXOpen::CAM::GrooveMillingBuilder::SetLevelSequencing ( NXOpen::CAM::GrooveMillingBuilder::LevelSequencingType  currentValue)

Sets the level sequencing
Created in NX9.0.0.



License requirements : cam_base ("CAM BASE")

Parameters
currentValuecurrentvalue

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