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

Represents a NXOpen::CAM::NcmScBuilder. More...

Inheritance diagram for NXOpen::CAM::NcmScBuilder:
NXOpen::CAM::NcmSubopBuilder NXOpen::CAM::BaseBuilder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Types

enum  SmoothingOptions { SmoothingOptionsOn, SmoothingOptionsOff }
 Available options for smoothing behavior. More...
 
- Public Types inherited from NXOpen::CAM::NcmSubopBuilder
enum  DefaultRegionStartTypes { DefaultRegionStartTypesMidPoint, DefaultRegionStartTypesCorner }
 Available types for default region start in subop milling. More...
 

Public Member Functions

bool CollisionCheck ()
 Returns the collision check activation
Created in NX5.0.0. More...
 
NXOpen::CAM::NcmScEngRetBuilderEngageAgainstCheckBuilder ()
 Returns the against check engage settings
Created in NX5.0.0. More...
 
NXOpen::CAM::NcmScEngRetBuilderEngageInitialBuilder ()
 Returns the initial engage settings
Created in NX5.0.0. More...
 
NXOpen::CAM::NcmScEngRetBuilderEngageOpenAreaBuilder ()
 Returns the open area engage settings
Created in NX5.0.0. More...
 
double MaxToolAxisChange ()
 Returns the max tool axis change
More...
 
bool OutputContactData ()
 Returns the contact data output activation
Created in NX5.0.0. More...
 
NXOpen::CAM::InheritableToolDepBuilderPartSafeClearance ()
 Returns the part safe clearance
Created in NX9.0.0. More...
 
NXOpen::CAM::NcmScEngRetBuilderRetractAgainstCheckBuilder ()
 Returns the against check retract settings
Created in NX5.0.0. More...
 
NXOpen::CAM::NcmScEngRetBuilderRetractFinalBuilder ()
 Returns the final retract settings
Created in NX5.0.0. More...
 
NXOpen::CAM::NcmScEngRetBuilderRetractOpenAreaBuilder ()
 Returns the open area retract settings
Created in NX5.0.0. More...
 
void SetCollisionCheck (bool newValue)
 Sets the collision check activation
Created in NX5.0.0. More...
 
void SetMaxToolAxisChange (double newValue)
 Sets the max tool axis change
More...
 
void SetOutputContactData (bool newValue)
 Sets the contact data output activation
Created in NX5.0.0. More...
 
void SetSmoothingOption (NXOpen::CAM::NcmScBuilder::SmoothingOptions newValue)
 Sets the smoothing option
More...
 
NXOpen::CAM::NcmSmoothingBuilderSmoothingBuilder ()
 Returns the smoothing builder
Created in NX9.0.0. More...
 
NXOpen::CAM::NcmScBuilder::SmoothingOptions SmoothingOption ()
 Returns the smoothing option
More...
 
NXOpen::CAM::InheritableToolDepBuilderSmoothingRadiusBuilder ()
 Returns the smoothing radius settings
More...
 
NXOpen::CAM::NcmAvoidancePointBuilderTransferAvoidanceFromBuilder ()
 Returns the from point builder
Created in NX5.0.0. More...
 
NXOpen::CAM::NcmAvoidancePointBuilderTransferAvoidanceGohomeBuilder ()
 Returns the gohome point builder
Created in NX5.0.0. More...
 
NXOpen::CAM::NcmAvoidancePointBuilderTransferAvoidanceReturnBuilder ()
 Returns the return point builder
Created in NX5.0.0. More...
 
NXOpen::CAM::NcmAvoidancePointBuilderTransferAvoidanceStartBuilder ()
 Returns the start point builder
Created in NX5.0.0. More...
 
NXOpen::CAM::NcmTransferBuilderTransferBetweenRegionsBuilder ()
 Returns the transfer settings for between regions
Created in NX5.0.0. More...
 
NXOpen::CAM::NcmClearanceBuilderTransferCommonClearanceBuilder ()
 Returns the common clearance setting
Created in NX5.0.0. More...
 
NXOpen::CAM::NcmTransferBuilderTransferInitialFinalBuilder ()
 Returns the transfer settings for initial and final
Created in NX6.0.0. More...
 
NXOpen::CAM::InheritableToolDepBuilderTransferRegionDistanceBuilder ()
 Returns the region distance setting
Created in NX5.0.0. More...
 
NXOpen::CAM::NcmTransferBuilderTransferWithinRegionsBuilder ()
 Returns the transfer settings for within regions
Created in NX5.0.0. More...
 
- Public Member Functions inherited from NXOpen::CAM::NcmSubopBuilder
NXOpen::CAM::NcmSubopBuilder::DefaultRegionStartTypes DefaultRegionStartType ()
 Returns the region start type
Created in NX8.5.0. More...
 
void GetRegionStartPoints (std::vector< NXOpen::Point * > &regionStartPoints)
 Returns region start points
Created in NX8.5.0. More...
 
void SetDefaultRegionStartType (NXOpen::CAM::NcmSubopBuilder::DefaultRegionStartTypes defaultRegionStartType)
 Sets the region start type
Created in NX8.5.0. More...
 
void SetRegionStartPoints (const std::vector< NXOpen::Point * > &regionStartPoints)
 Sets region start points
Created in NX8.5.0. More...
 
void SetStartPointsUseEffectDist (bool newValue)
 Sets the start points use effective distance
Created in NX8.5.0. More...
 
NXOpen::CAM::InheritableToolDepBuilderStartPointsEffectDistBuilder ()
 Returns the region start points effective distance builder (inheritable tool dep)
Created in NX8.5.0. More...
 
bool StartPointsUseEffectDist ()
 Returns the start points use effective distance
Created in NX8.5.0. More...
 
- Public Member Functions inherited from NXOpen::CAM::BaseBuilder
NXOpen::TaggedObjectGetCustomizableItemBuilder (const NXString &name)
 Returns the customizable item builder for given customizable item name. More...
 
NXOpen::TaggedObjectGetCustomizableItemBuilder (const char *name)
 Returns the customizable item builder for given customizable item name. More...
 
std::vector< NXStringGetCustomizableItemNames ()
 Returns the names for all customizable item ids. 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 NXOpen::CAM::NcmScBuilder.


Created in NX5.0.0.

Member Enumeration Documentation

Available options for smoothing behavior.

Enumerator
SmoothingOptionsOn 

transfer smoothing activated

SmoothingOptionsOff 

transfer smoothing deactivated

Member Function Documentation

bool NXOpen::CAM::NcmScBuilder::CollisionCheck ( )

Returns the collision check activation
Created in NX5.0.0.



License requirements : None

NXOpen::CAM::NcmScEngRetBuilder* NXOpen::CAM::NcmScBuilder::EngageAgainstCheckBuilder ( )

Returns the against check engage settings
Created in NX5.0.0.



License requirements : None

NXOpen::CAM::NcmScEngRetBuilder* NXOpen::CAM::NcmScBuilder::EngageInitialBuilder ( )

Returns the initial engage settings
Created in NX5.0.0.



License requirements : None

NXOpen::CAM::NcmScEngRetBuilder* NXOpen::CAM::NcmScBuilder::EngageOpenAreaBuilder ( )

Returns the open area engage settings
Created in NX5.0.0.



License requirements : None

double NXOpen::CAM::NcmScBuilder::MaxToolAxisChange ( )

Returns the max tool axis change

Deprecated:
Deprecated in NX9.0.0.

Use NXOpen::CAM::NcmScBuilder::SmoothingBuilder instead.


Created in NX5.0.0.

License requirements : None

bool NXOpen::CAM::NcmScBuilder::OutputContactData ( )

Returns the contact data output activation
Created in NX5.0.0.



License requirements : None

NXOpen::CAM::InheritableToolDepBuilder* NXOpen::CAM::NcmScBuilder::PartSafeClearance ( )

Returns the part safe clearance
Created in NX9.0.0.



License requirements : None

NXOpen::CAM::NcmScEngRetBuilder* NXOpen::CAM::NcmScBuilder::RetractAgainstCheckBuilder ( )

Returns the against check retract settings
Created in NX5.0.0.



License requirements : None

NXOpen::CAM::NcmScEngRetBuilder* NXOpen::CAM::NcmScBuilder::RetractFinalBuilder ( )

Returns the final retract settings
Created in NX5.0.0.



License requirements : None

NXOpen::CAM::NcmScEngRetBuilder* NXOpen::CAM::NcmScBuilder::RetractOpenAreaBuilder ( )

Returns the open area retract settings
Created in NX5.0.0.



License requirements : None

void NXOpen::CAM::NcmScBuilder::SetCollisionCheck ( bool  newValue)

Sets the collision check activation
Created in NX5.0.0.



License requirements : cam_base ("CAM BASE")

Parameters
newValuenewvalue
void NXOpen::CAM::NcmScBuilder::SetMaxToolAxisChange ( double  newValue)

Sets the max tool axis change

Deprecated:
Deprecated in NX9.0.0.

Use NXOpen::CAM::NcmScBuilder::SmoothingBuilder instead.


Created in NX5.0.0.

License requirements : cam_base ("CAM BASE")

Parameters
newValuethe max tool axis change
void NXOpen::CAM::NcmScBuilder::SetOutputContactData ( bool  newValue)

Sets the contact data output activation
Created in NX5.0.0.



License requirements : cam_base ("CAM BASE")

Parameters
newValuenewvalue
void NXOpen::CAM::NcmScBuilder::SetSmoothingOption ( NXOpen::CAM::NcmScBuilder::SmoothingOptions  newValue)

Sets the smoothing option

Deprecated:
Deprecated in NX9.0.0.

Use NXOpen::CAM::NcmScBuilder::SmoothingBuilder instead.


Created in NX5.0.0.

License requirements : cam_base ("CAM BASE")

Parameters
newValuenewvalue
NXOpen::CAM::NcmSmoothingBuilder* NXOpen::CAM::NcmScBuilder::SmoothingBuilder ( )

Returns the smoothing builder
Created in NX9.0.0.



License requirements : None

NXOpen::CAM::NcmScBuilder::SmoothingOptions NXOpen::CAM::NcmScBuilder::SmoothingOption ( )

Returns the smoothing option

Deprecated:
Deprecated in NX9.0.0.

Use NXOpen::CAM::NcmScBuilder::SmoothingBuilder instead.


Created in NX5.0.0.

License requirements : None

NXOpen::CAM::InheritableToolDepBuilder* NXOpen::CAM::NcmScBuilder::SmoothingRadiusBuilder ( )

Returns the smoothing radius settings

Deprecated:
Deprecated in NX9.0.0.

Use NXOpen::CAM::NcmScBuilder::SmoothingBuilder instead.


Created in NX5.0.0.

License requirements : None

NXOpen::CAM::NcmAvoidancePointBuilder* NXOpen::CAM::NcmScBuilder::TransferAvoidanceFromBuilder ( )

Returns the from point builder
Created in NX5.0.0.



License requirements : None

NXOpen::CAM::NcmAvoidancePointBuilder* NXOpen::CAM::NcmScBuilder::TransferAvoidanceGohomeBuilder ( )

Returns the gohome point builder
Created in NX5.0.0.



License requirements : None

NXOpen::CAM::NcmAvoidancePointBuilder* NXOpen::CAM::NcmScBuilder::TransferAvoidanceReturnBuilder ( )

Returns the return point builder
Created in NX5.0.0.



License requirements : None

NXOpen::CAM::NcmAvoidancePointBuilder* NXOpen::CAM::NcmScBuilder::TransferAvoidanceStartBuilder ( )

Returns the start point builder
Created in NX5.0.0.



License requirements : None

NXOpen::CAM::NcmTransferBuilder* NXOpen::CAM::NcmScBuilder::TransferBetweenRegionsBuilder ( )

Returns the transfer settings for between regions
Created in NX5.0.0.



License requirements : None

NXOpen::CAM::NcmClearanceBuilder* NXOpen::CAM::NcmScBuilder::TransferCommonClearanceBuilder ( )

Returns the common clearance setting
Created in NX5.0.0.



License requirements : None

NXOpen::CAM::NcmTransferBuilder* NXOpen::CAM::NcmScBuilder::TransferInitialFinalBuilder ( )

Returns the transfer settings for initial and final
Created in NX6.0.0.



License requirements : None

NXOpen::CAM::InheritableToolDepBuilder* NXOpen::CAM::NcmScBuilder::TransferRegionDistanceBuilder ( )

Returns the region distance setting
Created in NX5.0.0.



License requirements : None

NXOpen::CAM::NcmTransferBuilder* NXOpen::CAM::NcmScBuilder::TransferWithinRegionsBuilder ( )

Returns the transfer settings for within regions
Created in NX5.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.