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

Represents the information regarding how to display a curve's poles, knots, combs, peaks and inflections
More...

Inheritance diagram for NXOpen::GeometricAnalysis::CurveAnalysisRecord:
NXOpen::TransientObject

Public Types

enum  DirectionOptionType { DirectionOptionTypeNone, DirectionOptionTypePlaneOfCurve, DirectionOptionTypeSpecifyVector, DirectionOptionTypeWorkView }
 Direction option types. More...
 

Public Member Functions

int CombDensity ()
 Returns the comb density

 
int CombInterneedleDensity ()
 Returns the comb interneedle density

 
double CombMaxLength ()
 Returns the comb maximum length

 
double CombScaleFactor ()
 Returns the comb scale factor

 
NXOpen::Vector3d Direction ()
 Returns the diection

 
NXOpen::GeometricAnalysis::CurveAnalysisRecord::DirectionOptionType DirectionOption ()
 Returns the direction option

 
double End ()
 Returns the end parameter

 
void SetCombDensity (int density)
 Sets the comb density

 
void SetCombInterneedleDensity (int interneedleDensity)
 Sets the comb interneedle density

 
void SetCombMaxLength (double maxLength)
 Sets the comb maximum length

 
void SetCombScaleFactor (double factor)
 Sets the comb scale factor

 
void SetDirection (const NXOpen::Vector3d &direction)
 Sets the diection

 
void SetDirectionOption (NXOpen::GeometricAnalysis::CurveAnalysisRecord::DirectionOptionType directionOption)
 Sets the direction option

 
void SetEnd (double end)
 Sets the end parameter

 
void SetShowComb (bool on)
 Sets the flag to show comb

 
void SetShowInflection (bool on)
 Sets the flag to show inflection

 
void SetShowKnot (bool on)
 Sets the flag to show knot

 
void SetShowPeak (bool on)
 Sets the flag to show peak

 
void SetShowPole (bool on)
 Sets the flag to show pole

 
void SetStart (double start)
 Sets the start parameter, range from 0 to 100

 
void SetUseMaxLength (bool on)
 Sets the flag to limit the maximum length of the comb

 
bool ShowComb ()
 Returns the flag to show comb

 
bool ShowInflection ()
 Returns the flag to show inflection

 
bool ShowKnot ()
 Returns the flag to show knot

 
bool ShowPeak ()
 Returns the flag to show peak

 
bool ShowPole ()
 Returns the flag to show pole

 
double Start ()
 Returns the start parameter, range from 0 to 100

 
bool UseMaxLength ()
 Returns the flag to limit the maximum length of the comb

 
virtual ~CurveAnalysisRecord ()
 Free resources associated with the instance.
 
- Public Member Functions inherited from NXOpen::TransientObject
void * GetHandle ()
 Handle of the internal object represented by this object.
 

Detailed Description

Represents the information regarding how to display a curve's poles, knots, combs, peaks and inflections

Deprecated:
Deprecated in NX8.5.0.

Use GeometricAnalysis::CurveAnalysisDisplay .


Created in NX6.0.0.

Member Enumeration Documentation

Direction option types.

Enumerator:
DirectionOptionTypeNone 

no direction

DirectionOptionTypePlaneOfCurve 

best fit plane

DirectionOptionTypeSpecifyVector 

specify vector

DirectionOptionTypeWorkView 

work view

Constructor & Destructor Documentation

virtual NXOpen::GeometricAnalysis::CurveAnalysisRecord::~CurveAnalysisRecord ( )
virtual

Free resources associated with the instance.


Deprecated:
Deprecated in NX8.5.0. Use GeometricAnalysis::CurveAnalysisDisplay .


Created in NX6.0.0.

License requirements : None

Member Function Documentation

int NXOpen::GeometricAnalysis::CurveAnalysisRecord::CombDensity ( )

Returns the comb density

Deprecated:
Deprecated in NX8.5.0.

Use GeometricAnalysis::CurveAnalysisDisplay .


Created in NX6.0.0.

License requirements : None

int NXOpen::GeometricAnalysis::CurveAnalysisRecord::CombInterneedleDensity ( )

Returns the comb interneedle density

Deprecated:
Deprecated in NX8.5.0.

Use GeometricAnalysis::CurveAnalysisDisplay .


Created in NX6.0.0.

License requirements : None

double NXOpen::GeometricAnalysis::CurveAnalysisRecord::CombMaxLength ( )

Returns the comb maximum length

Deprecated:
Deprecated in NX8.5.0.

Use GeometricAnalysis::CurveAnalysisDisplay .


Created in NX6.0.0.

License requirements : None

double NXOpen::GeometricAnalysis::CurveAnalysisRecord::CombScaleFactor ( )

Returns the comb scale factor

Deprecated:
Deprecated in NX8.5.0.

Use GeometricAnalysis::CurveAnalysisDisplay .


Created in NX6.0.0.

License requirements : None

NXOpen::Vector3d NXOpen::GeometricAnalysis::CurveAnalysisRecord::Direction ( )

Returns the diection

Deprecated:
Deprecated in NX8.5.0.

Use GeometricAnalysis::CurveAnalysisDisplay .


Created in NX6.0.0.

License requirements : None

NXOpen::GeometricAnalysis::CurveAnalysisRecord::DirectionOptionType NXOpen::GeometricAnalysis::CurveAnalysisRecord::DirectionOption ( )

Returns the direction option

Deprecated:
Deprecated in NX8.5.0.

Use GeometricAnalysis::CurveAnalysisDisplay .


Created in NX6.0.0.

License requirements : None

double NXOpen::GeometricAnalysis::CurveAnalysisRecord::End ( )

Returns the end parameter

Deprecated:
Deprecated in NX8.5.0.

Use GeometricAnalysis::CurveAnalysisDisplay .


Created in NX6.0.0.

License requirements : None

void NXOpen::GeometricAnalysis::CurveAnalysisRecord::SetCombDensity ( int  density)

Sets the comb density

Deprecated:
Deprecated in NX8.5.0.

Use GeometricAnalysis::CurveAnalysisDisplay .


Created in NX6.0.0.

License requirements : None

Parameters
densitycomb density
void NXOpen::GeometricAnalysis::CurveAnalysisRecord::SetCombInterneedleDensity ( int  interneedleDensity)

Sets the comb interneedle density

Deprecated:
Deprecated in NX8.5.0.

Use GeometricAnalysis::CurveAnalysisDisplay .


Created in NX6.0.0.

License requirements : None

Parameters
interneedleDensitycomb interneedle density
void NXOpen::GeometricAnalysis::CurveAnalysisRecord::SetCombMaxLength ( double  maxLength)

Sets the comb maximum length

Deprecated:
Deprecated in NX8.5.0.

Use GeometricAnalysis::CurveAnalysisDisplay .


Created in NX6.0.0.

License requirements : None

Parameters
maxLengthmax length
void NXOpen::GeometricAnalysis::CurveAnalysisRecord::SetCombScaleFactor ( double  factor)

Sets the comb scale factor

Deprecated:
Deprecated in NX8.5.0.

Use GeometricAnalysis::CurveAnalysisDisplay .


Created in NX6.0.0.

License requirements : None

Parameters
factorcomb scale factor
void NXOpen::GeometricAnalysis::CurveAnalysisRecord::SetDirection ( const NXOpen::Vector3d direction)

Sets the diection

Deprecated:
Deprecated in NX8.5.0.

Use GeometricAnalysis::CurveAnalysisDisplay .


Created in NX6.0.0.

License requirements : None

Parameters
directiondirection
void NXOpen::GeometricAnalysis::CurveAnalysisRecord::SetDirectionOption ( NXOpen::GeometricAnalysis::CurveAnalysisRecord::DirectionOptionType  directionOption)

Sets the direction option

Deprecated:
Deprecated in NX8.5.0.

Use GeometricAnalysis::CurveAnalysisDisplay .


Created in NX6.0.0.

License requirements : None

Parameters
directionOptiondirection option
void NXOpen::GeometricAnalysis::CurveAnalysisRecord::SetEnd ( double  end)

Sets the end parameter

Deprecated:
Deprecated in NX8.5.0.

Use GeometricAnalysis::CurveAnalysisDisplay .


Created in NX6.0.0.

License requirements : None

Parameters
endend parameter
void NXOpen::GeometricAnalysis::CurveAnalysisRecord::SetShowComb ( bool  on)

Sets the flag to show comb

Deprecated:
Deprecated in NX8.5.0.

Use GeometricAnalysis::CurveAnalysisDisplay .


Created in NX6.0.0.

License requirements : None

Parameters
ontrue to show comb
void NXOpen::GeometricAnalysis::CurveAnalysisRecord::SetShowInflection ( bool  on)

Sets the flag to show inflection

Deprecated:
Deprecated in NX8.5.0.

Use GeometricAnalysis::CurveAnalysisDisplay .


Created in NX6.0.0.

License requirements : None

Parameters
ontrue to show inflection
void NXOpen::GeometricAnalysis::CurveAnalysisRecord::SetShowKnot ( bool  on)

Sets the flag to show knot

Deprecated:
Deprecated in NX8.5.0.

Use GeometricAnalysis::CurveAnalysisDisplay .


Created in NX6.0.0.

License requirements : None

Parameters
ontrue to show knot
void NXOpen::GeometricAnalysis::CurveAnalysisRecord::SetShowPeak ( bool  on)

Sets the flag to show peak

Deprecated:
Deprecated in NX8.5.0.

Use GeometricAnalysis::CurveAnalysisDisplay .


Created in NX6.0.0.

License requirements : None

Parameters
ontrue to show peak
void NXOpen::GeometricAnalysis::CurveAnalysisRecord::SetShowPole ( bool  on)

Sets the flag to show pole

Deprecated:
Deprecated in NX8.5.0.

Use GeometricAnalysis::CurveAnalysisDisplay .


Created in NX6.0.0.

License requirements : None

Parameters
ontrue to show pole
void NXOpen::GeometricAnalysis::CurveAnalysisRecord::SetStart ( double  start)

Sets the start parameter, range from 0 to 100

Deprecated:
Deprecated in NX8.5.0.

Use GeometricAnalysis::CurveAnalysisDisplay .


Created in NX6.0.0.

License requirements : None

Parameters
startstart parameter
void NXOpen::GeometricAnalysis::CurveAnalysisRecord::SetUseMaxLength ( bool  on)

Sets the flag to limit the maximum length of the comb

Deprecated:
Deprecated in NX8.5.0.

Use GeometricAnalysis::CurveAnalysisDisplay .


Created in NX6.0.0.

License requirements : None

Parameters
ontrue to use the max length to limit comb
bool NXOpen::GeometricAnalysis::CurveAnalysisRecord::ShowComb ( )

Returns the flag to show comb

Deprecated:
Deprecated in NX8.5.0.

Use GeometricAnalysis::CurveAnalysisDisplay .


Created in NX6.0.0.

License requirements : None

bool NXOpen::GeometricAnalysis::CurveAnalysisRecord::ShowInflection ( )

Returns the flag to show inflection

Deprecated:
Deprecated in NX8.5.0.

Use GeometricAnalysis::CurveAnalysisDisplay .


Created in NX6.0.0.

License requirements : None

bool NXOpen::GeometricAnalysis::CurveAnalysisRecord::ShowKnot ( )

Returns the flag to show knot

Deprecated:
Deprecated in NX8.5.0.

Use GeometricAnalysis::CurveAnalysisDisplay .


Created in NX6.0.0.

License requirements : None

bool NXOpen::GeometricAnalysis::CurveAnalysisRecord::ShowPeak ( )

Returns the flag to show peak

Deprecated:
Deprecated in NX8.5.0.

Use GeometricAnalysis::CurveAnalysisDisplay .


Created in NX6.0.0.

License requirements : None

bool NXOpen::GeometricAnalysis::CurveAnalysisRecord::ShowPole ( )

Returns the flag to show pole

Deprecated:
Deprecated in NX8.5.0.

Use GeometricAnalysis::CurveAnalysisDisplay .


Created in NX6.0.0.

License requirements : None

double NXOpen::GeometricAnalysis::CurveAnalysisRecord::Start ( )

Returns the start parameter, range from 0 to 100

Deprecated:
Deprecated in NX8.5.0.

Use GeometricAnalysis::CurveAnalysisDisplay .


Created in NX6.0.0.

License requirements : None

bool NXOpen::GeometricAnalysis::CurveAnalysisRecord::UseMaxLength ( )

Returns the flag to limit the maximum length of the comb

Deprecated:
Deprecated in NX8.5.0.

Use GeometricAnalysis::CurveAnalysisDisplay .


Created in NX6.0.0.

License requirements : None


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