NXOpen::CAM::PitchSetting Class Reference

Represents a CAM::PitchSetting. More...

Inheritance diagram for NXOpen::CAM::PitchSetting:

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.
Public Member Functions inherited from NXOpen::TaggedObject
tag_t	GetTag () const
	<b>Deprecated</b>:<br>    Use Tag instead.
tag_t	Tag () const
	Returns the tag of this object.

Detailed Description

Represents a CAM::PitchSetting.

Created in NX6.0.0.

Member Enumeration Documentation

enum NXOpen::CAM::PitchSetting::OptionTypes

the pitch option types

Enumerator:

OptionTypesPitch	Pitch.
OptionTypesLead	Lead.
OptionTypesThreadsPerUnit	Threads per mm or inch.

enum NXOpen::CAM::PitchSetting::OutputUnitTypes

the output unit types

Enumerator:

OutputUnitTypesSameAsInput	Same as Input.
OutputUnitTypesPitch	Pitch.
OutputUnitTypesLead	Lead.
OutputUnitTypesThreadsPerUnit	Threads per mm.

enum NXOpen::CAM::PitchSetting::VarianceTypes

the pitch variance types

Enumerator:

VarianceTypesConstant	Constant.
VarianceTypesStartAndEnd	Start and End.
VarianceTypesStartAndIncrement	Start and Increment.

Member Function Documentation

double NXOpen::CAM::PitchSetting::Distance

(

)

Returns the distance
Created in NX6.0.0.

License requirements : None

double NXOpen::CAM::PitchSetting::End

(

)

Returns the end
Created in NX6.0.0.

License requirements : None

double NXOpen::CAM::PitchSetting::Increment

(

)

Returns the increment
Created in NX6.0.0.

License requirements : None

NXOpen::CAM::PitchSetting::OptionTypes NXOpen::CAM::PitchSetting::Option

(

)

Returns the pitch option
Created in NX6.0.0.

License requirements : None

NXOpen::CAM::PitchSetting::OutputUnitTypes NXOpen::CAM::PitchSetting::OutputUnit

(

)

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

distance

the distance

void NXOpen::CAM::PitchSetting::SetEnd

(

double

end

)

Sets the end
Created in NX6.0.0.

License requirements : cam_base ("CAM BASE")

Parameters

end

the end

void NXOpen::CAM::PitchSetting::SetIncrement

(

double

increment

)

Sets the increment
Created in NX6.0.0.

License requirements : cam_base ("CAM BASE")

Parameters

increment

the increment

void NXOpen::CAM::PitchSetting::SetOption

(

NXOpen::CAM::PitchSetting::OptionTypes

pitchOption

)

Sets the pitch option
Created in NX6.0.0.

License requirements : cam_base ("CAM BASE")

Parameters

pitchOption

the pitch option

void NXOpen::CAM::PitchSetting::SetOutputUnit

(

NXOpen::CAM::PitchSetting::OutputUnitTypes

outputUnit

)

Sets the output unit
Created in NX6.0.0.

License requirements : cam_base ("CAM BASE")

Parameters

outputUnit

the output unit

void NXOpen::CAM::PitchSetting::SetStart

(

double

start

)

Sets the start
Created in NX6.0.0.

License requirements : cam_base ("CAM BASE")

Parameters

start

the start

void NXOpen::CAM::PitchSetting::SetThreadPerUnit

(

double

thread

)

Sets the thread per mm
Created in NX6.0.0.

License requirements : cam_base ("CAM BASE")

Parameters

thread

the thread per mm or inch

void NXOpen::CAM::PitchSetting::SetVariance

(

NXOpen::CAM::PitchSetting::VarianceTypes

pitchVariance

)

Sets the pitch variance
Created in NX6.0.0.

License requirements : cam_base ("CAM BASE")

Parameters

pitchVariance

the pitch variance

double NXOpen::CAM::PitchSetting::Start

(

)

Returns the start
Created in NX6.0.0.

License requirements : None

double NXOpen::CAM::PitchSetting::ThreadPerUnit

(

)

Returns the thread per mm
Created in NX6.0.0.

License requirements : None

NXOpen::CAM::PitchSetting::VarianceTypes NXOpen::CAM::PitchSetting::Variance

(

)

Returns the pitch variance
Created in NX6.0.0.

License requirements : None

---

The documentation for this class was generated from the following file:

• CAM_PitchSetting.hxx