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

Represents a StepParams Builder
Created in NX5.0.0. More...

Inheritance diagram for NXOpen::CAM::StepParamsBuilder:
NXOpen::TaggedObject

Public Member Functions

int Add (int inputIndex, double diameter, double length, double angle, double radius)
 Create a new step params item. More...
 
void Delete (int nodeIndex)
 Delete an existing step params item
Created in NX5.0.0. More...
 
void Get (int step, double *diameter, double *length, double *angle, double *cornerRadius)
 Get the values of an existing step params item
Created in NX6.0.0. More...
 
void Modify (int nodeIndex, double diameter, double length, double angle, double radius)
 Modify an existing step params item
Created in NX5.0.0. More...
 
void MoveDown (int index)
 Move down a step params item
Created in NX6.0.0. More...
 
void MoveUp (int index)
 Move up a step params item
Created in NX6.0.0. More...
 
int NumberOfSteps ()
 Returns the number of step params
Created in NX6.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 StepParams Builder
Created in NX5.0.0.


Member Function Documentation

int NXOpen::CAM::StepParamsBuilder::Add ( int  inputIndex,
double  diameter,
double  length,
double  angle,
double  radius 
)

Create a new step params item.

Returns
the outputted new created item actual position,if error happens, output will be -1
Created in NX5.0.0.

License requirements : cam_base ("CAM BASE")
Parameters
inputIndexthe inputted new created item position
diameterthe diameter
lengththe length
anglethe angle
radiusthe radius
void NXOpen::CAM::StepParamsBuilder::Delete ( int  nodeIndex)

Delete an existing step params item
Created in NX5.0.0.



License requirements : cam_base ("CAM BASE")

Parameters
nodeIndexthe selected entry indx in list
void NXOpen::CAM::StepParamsBuilder::Get ( int  step,
double *  diameter,
double *  length,
double *  angle,
double *  cornerRadius 
)

Get the values of an existing step params item
Created in NX6.0.0.



License requirements : cam_base ("CAM BASE")

Parameters
stepthe step
diameterthe diameter
lengththe length
anglethe angle
cornerRadiusthe corner radius
void NXOpen::CAM::StepParamsBuilder::Modify ( int  nodeIndex,
double  diameter,
double  length,
double  angle,
double  radius 
)

Modify an existing step params item
Created in NX5.0.0.



License requirements : cam_base ("CAM BASE")

Parameters
nodeIndexthe index of modified step params
diameterthe diameter
lengththe length
anglethe angle
radiusthe radius
void NXOpen::CAM::StepParamsBuilder::MoveDown ( int  index)

Move down a step params item
Created in NX6.0.0.



License requirements : None

Parameters
indexthe index of item which should be moved down
void NXOpen::CAM::StepParamsBuilder::MoveUp ( int  index)

Move up a step params item
Created in NX6.0.0.



License requirements : None

Parameters
indexthe index of item which should be moved up
int NXOpen::CAM::StepParamsBuilder::NumberOfSteps ( )

Returns the number of step params
Created in NX6.0.0.



License requirements : cam_base ("CAM BASE")


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