NX Open C++ Reference Guide
Public Types | Public Member Functions
NXOpen::CAM::PitchSetting Class Reference

Represents a CAM::PitchSetting. More...

Inheritance diagram for NXOpen::CAM::PitchSetting:
NXOpen::TaggedObject

List of all members.

Public Types

enum  OptionTypes { OptionTypesPitch, OptionTypesLead, OptionTypesThreadsPerUnit }
 the pitch option types More...
enum  OutputUnitTypes { OutputUnitTypesSameAsInput, OutputUnitTypesPitch, OutputUnitTypesLead, OutputUnitTypesThreadsPerUnit }
 the output unit types More...
enum  VarianceTypes { VarianceTypesConstant, VarianceTypesStartAndEnd, VarianceTypesStartAndIncrement }
 the pitch variance types More...

Public Member Functions

double Distance ()
 Returns the distance
Created in NX6.0.0.
double End ()
 Returns the end
Created in NX6.0.0.
double Increment ()
 Returns the increment
Created in NX6.0.0.
NXOpen::CAM::PitchSetting::OptionTypes Option ()
 Returns the pitch option
Created in NX6.0.0.
NXOpen::CAM::PitchSetting::OutputUnitTypes OutputUnit ()
 Returns the output unit
Created in NX6.0.0.
void SetDistance (double distance)
 Sets the distance
Created in NX6.0.0.
void SetEnd (double end)
 Sets the end
Created in NX6.0.0.
void SetIncrement (double increment)
 Sets the increment
Created in NX6.0.0.
void SetOption (NXOpen::CAM::PitchSetting::OptionTypes pitchOption)
 Sets the pitch option
Created in NX6.0.0.
void SetOutputUnit (NXOpen::CAM::PitchSetting::OutputUnitTypes outputUnit)
 Sets the output unit
Created in NX6.0.0.
void SetStart (double start)
 Sets the start
Created in NX6.0.0.
void SetThreadPerUnit (double thread)
 Sets the thread per mm
Created in NX6.0.0.
void SetVariance (NXOpen::CAM::PitchSetting::VarianceTypes pitchVariance)
 Sets the pitch variance
Created in NX6.0.0.
double Start ()
 Returns the start
Created in NX6.0.0.
double ThreadPerUnit ()
 Returns the thread per mm
Created in NX6.0.0.
NXOpen::CAM::PitchSetting::VarianceTypes Variance ()
 Returns the pitch variance
Created in NX6.0.0.

Detailed Description

Represents a CAM::PitchSetting.


Member Enumeration Documentation

the pitch option types

Enumerator:
OptionTypesPitch 

Pitch.

OptionTypesLead 

Lead.

OptionTypesThreadsPerUnit 

Threads per mm or inch.

the output unit types

Enumerator:
OutputUnitTypesSameAsInput 

Same as Input.

OutputUnitTypesPitch 

Pitch.

OutputUnitTypesLead 

Lead.

OutputUnitTypesThreadsPerUnit 

Threads per mm.

the pitch variance types

Enumerator:
VarianceTypesConstant 

Constant.

VarianceTypesStartAndEnd 

Start and End.

VarianceTypesStartAndIncrement 

Start and Increment.


Member Function Documentation

Returns the distance
Created in NX6.0.0.



License requirements : None

Returns the end
Created in NX6.0.0.



License requirements : None

Returns the increment
Created in NX6.0.0.



License requirements : None

Returns the pitch option
Created in NX6.0.0.



License requirements : None

Returns the output unit
Created in NX6.0.0.



License requirements : None

void NXOpen::CAM::PitchSetting::SetDistance ( double  distance)

Sets the distance
Created in NX6.0.0.



License requirements : cam_base ("CAM BASE")

Parameters:
distancethe distance
void NXOpen::CAM::PitchSetting::SetEnd ( double  end)

Sets the end
Created in NX6.0.0.



License requirements : cam_base ("CAM BASE")

Parameters:
endthe end
void NXOpen::CAM::PitchSetting::SetIncrement ( double  increment)

Sets the increment
Created in NX6.0.0.



License requirements : cam_base ("CAM BASE")

Parameters:
incrementthe increment

Sets the pitch option
Created in NX6.0.0.



License requirements : cam_base ("CAM BASE")

Parameters:
pitchOptionthe pitch option

Sets the output unit
Created in NX6.0.0.



License requirements : cam_base ("CAM BASE")

Parameters:
outputUnitthe output unit
void NXOpen::CAM::PitchSetting::SetStart ( double  start)

Sets the start
Created in NX6.0.0.



License requirements : cam_base ("CAM BASE")

Parameters:
startthe start

Sets the thread per mm
Created in NX6.0.0.



License requirements : cam_base ("CAM BASE")

Parameters:
threadthe thread per mm or inch

Sets the pitch variance
Created in NX6.0.0.



License requirements : cam_base ("CAM BASE")

Parameters:
pitchVariancethe pitch variance

Returns the start
Created in NX6.0.0.



License requirements : None

Returns the thread per mm
Created in NX6.0.0.



License requirements : None

Returns the pitch variance
Created in NX6.0.0.



License requirements : None


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