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

Represents a boundary set for the planar mill/surface contour operation
To create a new instance of this class, use NXOpen::CAM::Boundary::CreateBoundarySetPlanarMill

Created in NX11.0.1. More...

Inheritance diagram for NXOpen::CAM::BoundarySetPlanarMill:
NXOpen::CAM::BoundarySet NXOpen::TaggedObject

Public Types

enum  FeedUnitTypes { FeedUnitTypesNone, FeedUnitTypesPerMinute, FeedUnitTypesPerRevolution }
 the types available for the feed rate unit More...
 
enum  TrimExtendPosition { TrimExtendPositionAtStart, TrimExtendPositionAtEnd, TrimExtendPositionAtStartAndEnd, TrimExtendPositionUnknown }
 the boundary position where to trim or to extend More...
 
- Public Types inherited from NXOpen::CAM::BoundarySet
enum  BoundaryTypes { BoundaryTypesClosed, BoundaryTypesOpen }
 the boundary types
Created in NX9.0.0. More...
 
enum  PlaneTypes { PlaneTypesAutomatic, PlaneTypesUserDefined }
 the boundary plane types
Created in NX9.0.0. More...
 
enum  ToolPositionTypes { ToolPositionTypesOn, ToolPositionTypesContact }
 the tool position
Created in NX9.0.1. More...
 
enum  ToolSideTypes { ToolSideTypesInsideOrLeft, ToolSideTypesOutsideOrRight }
 the tool side types
Created in NX9.0.0. More...
 

Public Member Functions

double BlankDistance ()
 Returns the blank_distance
Created in NX11.0.1. More...
 
NXOpen::CAM::BoundaryMemberSetPlanarMillCreateBoundaryMemberSetPlanarMill ()
 Create an empty custom member data set for a planar mill/surface contour boundary. More...
 
void CreateCurveBoundaryFromPermanent ()
 Create curve boundary from permanent one
Created in NX11.0.1. More...
 
bool CustomBlankDistance ()
 Returns the blank distance
Created in NX11.0.1. More...
 
bool CustomFeed ()
 Returns the feed rate toggle
Created in NX11.0.1. More...
 
bool CustomStock ()
 Returns the flag whether this boundary has custom stock activated
Created in NX11.0.1. More...
 
bool CustomTolerance ()
 Returns the tolerance toggle
Created in NX11.0.1. More...
 
void ExtendOrTrimEndPoint (double distance)
 Trim or extend the end point of a closed boundary
Created in NX11.0.1. More...
 
void ExtendOrTrimStartPoint (double distance)
 Trim or extend the start point of an open boundary
Created in NX11.0.1. More...
 
NXOpen::CAM::BoundarySetPlanarMill::FeedUnitTypes FeedUnit ()
 Returns the feed rate unit
Created in NX11.0.1. More...
 
double FeedValue ()
 Returns the feed rate value
Created in NX11.0.1. More...
 
double InTolerance ()
 Returns the in tolerance
Created in NX11.0.1. More...
 
void MoveStartPoint (NXOpen::CAM::BoundaryMemberSetPlanarMill *bndSet, double distance)
 Move the start point of a closed boundary
Created in NX11.0.1. More...
 
double OutTolerance ()
 Returns the out tolerance
Created in NX11.0.1. More...
 
void SetBlankDistance (double newValue)
 Sets the blank_distance
Created in NX11.0.1. More...
 
void SetCustomBlankDistance (bool newValue)
 Sets the blank distance
Created in NX11.0.1. More...
 
void SetCustomFeed (bool newValue)
 Sets the feed rate toggle
Created in NX11.0.1. More...
 
void SetCustomStock (bool newValue)
 Sets the flag whether this boundary has custom stock activated
Created in NX11.0.1. More...
 
void SetCustomTolerance (bool newValue)
 Sets the tolerance toggle
Created in NX11.0.1. More...
 
void SetFeedUnit (NXOpen::CAM::BoundarySetPlanarMill::FeedUnitTypes newUnit)
 Sets the feed rate unit
Created in NX11.0.1. More...
 
void SetFeedValue (double newValue)
 Sets the feed rate value
Created in NX11.0.1. More...
 
void SetInTolerance (double newValue)
 Sets the in tolerance
Created in NX11.0.1. More...
 
void SetOutTolerance (double newValue)
 Sets the out tolerance
Created in NX11.0.1. More...
 
void SetStock (double newValue)
 Sets the stock value
Created in NX11.0.1. More...
 
double Stock ()
 Returns the stock value
Created in NX11.0.1. More...
 
- Public Member Functions inherited from NXOpen::CAM::BoundarySet
void AppendCurves (const std::vector< NXOpen::NXObject * > &curves, const NXOpen::Point3d &pickPoint, const NXOpen::Matrix3x3 &matrix)
 Add curves to the boundary
Created in NX9.0.0. More...
 
NXOpen::CAM::BoundaryMemberSetListBoundaryMemberList ()
 Returns the boundary member list
Created in NX9.0.0. More...
 
NXOpen::CAM::BoundarySet::BoundaryTypes BoundaryType ()
 Returns the boundary type
Created in NX9.0.0. More...
 
NXOpen::CAM::BoundaryMemberSetCreateBoundaryMemberSet ()
 Create an empty boundary member set. More...
 
bool CustomOffset ()
 Returns the flag whether this boundary has custom offset activated
Created in NX9.0.0. More...
 
double Offset ()
 Returns the offset value
Created in NX9.0.0. More...
 
NXOpen::CAM::ParamValueIntent OffsetIntent ()
 Returns the offset intent
Created in NX9.0.0. More...
 
NXOpen::PlanePlane ()
 Returns the boundary plane
Created in NX9.0.0. More...
 
NXOpen::CAM::BoundarySet::PlaneTypes PlaneType ()
 Returns the boundary plane type
Created in NX9.0.0. More...
 
NXOpen::SelectTaggedObjectListPointList ()
 Returns the points list
Created in NX9.0.0. More...
 
void RemoveCurves (const std::vector< NXOpen::NXObject * > &curves)
 Remove curves from the boundary
Created in NX9.0.0. More...
 
NXOpen::SelectTaggedObjectSelectObject ()
 Returns the select object
Created in NX11.0.1. More...
 
void SetBoundaryType (NXOpen::CAM::BoundarySet::BoundaryTypes newValue)
 Sets the boundary type
Created in NX9.0.0. More...
 
void SetCustomOffset (bool newValue)
 Sets the flag whether this boundary has custom offset activated
Created in NX9.0.0. More...
 
void SetOffset (double newValue)
 Sets the offset value
Created in NX9.0.0. More...
 
void SetOffsetIntent (NXOpen::CAM::ParamValueIntent newValue)
 Sets the offset intent
Created in NX9.0.0. More...
 
void SetPlane (NXOpen::Plane *newValue)
 Sets the boundary plane
Created in NX9.0.0. More...
 
void SetPlaneType (NXOpen::CAM::BoundarySet::PlaneTypes newValue)
 Sets the boundary plane type
Created in NX9.0.0. More...
 
void SetToolPosition (NXOpen::CAM::BoundarySet::ToolPositionTypes newValue)
 Sets the tool position
Created in NX9.0.1. More...
 
void SetToolSide (NXOpen::CAM::BoundarySet::ToolSideTypes newValue)
 Sets the tool side
Created in NX9.0.0. More...
 
NXOpen::CAM::BoundarySet::ToolPositionTypes ToolPosition ()
 Returns the tool position
Created in NX9.0.1. More...
 
NXOpen::CAM::BoundarySet::ToolSideTypes ToolSide ()
 Returns the tool side
Created in NX9.0.0. More...
 
- Public Member Functions inherited from NXOpen::TaggedObject
tag_t Tag () const
 Returns the tag of this object. More...
 

Detailed Description

Represents a boundary set for the planar mill/surface contour operation
To create a new instance of this class, use NXOpen::CAM::Boundary::CreateBoundarySetPlanarMill

Created in NX11.0.1.


Member Enumeration Documentation

the types available for the feed rate unit

Enumerator
FeedUnitTypesNone 

no feed rate unit

FeedUnitTypesPerMinute 

use per minute as the feed rate unit

FeedUnitTypesPerRevolution 

use per revolution as the feed rate unit

the boundary position where to trim or to extend

Enumerator
TrimExtendPositionAtStart 

trim or extend at start

TrimExtendPositionAtEnd 

trim or extend at end

TrimExtendPositionAtStartAndEnd 

trim or extend at start and at end

TrimExtendPositionUnknown 

unknown

Member Function Documentation

double NXOpen::CAM::BoundarySetPlanarMill::BlankDistance ( )

Returns the blank_distance
Created in NX11.0.1.



License requirements : None

NXOpen::CAM::BoundaryMemberSetPlanarMill* NXOpen::CAM::BoundarySetPlanarMill::CreateBoundaryMemberSetPlanarMill ( )

Create an empty custom member data set for a planar mill/surface contour boundary.

Returns

Created in NX11.0.1.

License requirements : cam_base ("CAM BASE")
void NXOpen::CAM::BoundarySetPlanarMill::CreateCurveBoundaryFromPermanent ( )

Create curve boundary from permanent one
Created in NX11.0.1.



License requirements : cam_base ("CAM BASE")

bool NXOpen::CAM::BoundarySetPlanarMill::CustomBlankDistance ( )

Returns the blank distance
Created in NX11.0.1.



License requirements : None

bool NXOpen::CAM::BoundarySetPlanarMill::CustomFeed ( )

Returns the feed rate toggle
Created in NX11.0.1.



License requirements : None

bool NXOpen::CAM::BoundarySetPlanarMill::CustomStock ( )

Returns the flag whether this boundary has custom stock activated
Created in NX11.0.1.



License requirements : None

bool NXOpen::CAM::BoundarySetPlanarMill::CustomTolerance ( )

Returns the tolerance toggle
Created in NX11.0.1.



License requirements : None

void NXOpen::CAM::BoundarySetPlanarMill::ExtendOrTrimEndPoint ( double  distance)

Trim or extend the end point of a closed boundary
Created in NX11.0.1.



License requirements : cam_base ("CAM BASE")

Parameters
distancedistance
void NXOpen::CAM::BoundarySetPlanarMill::ExtendOrTrimStartPoint ( double  distance)

Trim or extend the start point of an open boundary
Created in NX11.0.1.



License requirements : cam_base ("CAM BASE")

Parameters
distancedistance
NXOpen::CAM::BoundarySetPlanarMill::FeedUnitTypes NXOpen::CAM::BoundarySetPlanarMill::FeedUnit ( )

Returns the feed rate unit
Created in NX11.0.1.



License requirements : None

double NXOpen::CAM::BoundarySetPlanarMill::FeedValue ( )

Returns the feed rate value
Created in NX11.0.1.



License requirements : None

double NXOpen::CAM::BoundarySetPlanarMill::InTolerance ( )

Returns the in tolerance
Created in NX11.0.1.



License requirements : None

void NXOpen::CAM::BoundarySetPlanarMill::MoveStartPoint ( NXOpen::CAM::BoundaryMemberSetPlanarMill bndSet,
double  distance 
)

Move the start point of a closed boundary
Created in NX11.0.1.



License requirements : cam_base ("CAM BASE")

Parameters
bndSetbndset
distancedistance
double NXOpen::CAM::BoundarySetPlanarMill::OutTolerance ( )

Returns the out tolerance
Created in NX11.0.1.



License requirements : None

void NXOpen::CAM::BoundarySetPlanarMill::SetBlankDistance ( double  newValue)

Sets the blank_distance
Created in NX11.0.1.



License requirements : cam_base ("CAM BASE")

Parameters
newValuenewvalue
void NXOpen::CAM::BoundarySetPlanarMill::SetCustomBlankDistance ( bool  newValue)

Sets the blank distance
Created in NX11.0.1.



License requirements : cam_base ("CAM BASE")

Parameters
newValuenewvalue
void NXOpen::CAM::BoundarySetPlanarMill::SetCustomFeed ( bool  newValue)

Sets the feed rate toggle
Created in NX11.0.1.



License requirements : cam_base ("CAM BASE")

Parameters
newValuenewvalue
void NXOpen::CAM::BoundarySetPlanarMill::SetCustomStock ( bool  newValue)

Sets the flag whether this boundary has custom stock activated
Created in NX11.0.1.



License requirements : cam_base ("CAM BASE")

Parameters
newValuenewvalue
void NXOpen::CAM::BoundarySetPlanarMill::SetCustomTolerance ( bool  newValue)

Sets the tolerance toggle
Created in NX11.0.1.



License requirements : cam_base ("CAM BASE")

Parameters
newValuenewvalue
void NXOpen::CAM::BoundarySetPlanarMill::SetFeedUnit ( NXOpen::CAM::BoundarySetPlanarMill::FeedUnitTypes  newUnit)

Sets the feed rate unit
Created in NX11.0.1.



License requirements : cam_base ("CAM BASE")

Parameters
newUnitnewunit
void NXOpen::CAM::BoundarySetPlanarMill::SetFeedValue ( double  newValue)

Sets the feed rate value
Created in NX11.0.1.



License requirements : cam_base ("CAM BASE")

Parameters
newValuenewvalue
void NXOpen::CAM::BoundarySetPlanarMill::SetInTolerance ( double  newValue)

Sets the in tolerance
Created in NX11.0.1.



License requirements : cam_base ("CAM BASE")

Parameters
newValuenewvalue
void NXOpen::CAM::BoundarySetPlanarMill::SetOutTolerance ( double  newValue)

Sets the out tolerance
Created in NX11.0.1.



License requirements : cam_base ("CAM BASE")

Parameters
newValuenewvalue
void NXOpen::CAM::BoundarySetPlanarMill::SetStock ( double  newValue)

Sets the stock value
Created in NX11.0.1.



License requirements : cam_base ("CAM BASE")

Parameters
newValuenewvalue
double NXOpen::CAM::BoundarySetPlanarMill::Stock ( )

Returns the stock value
Created in NX11.0.1.



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.