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

Represents a NXOpen::GeometricUtilities::CombOptionsBuilder. More...

Inheritance diagram for NXOpen::GeometricUtilities::CombOptionsBuilder:
NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Types

enum  AnalysisTypes { AnalysisTypesNone, AnalysisTypesCurvature, AnalysisTypesRadius }
 Represents the Analysis types. More...
 
enum  LabelTypes { LabelTypesNone, LabelTypesMinimum, LabelTypesMaximum, LabelTypesMinimumMaximum }
 Represents the Label types. More...
 

Public Member Functions

NXOpen::GeometricUtilities::CombOptionsBuilder::AnalysisTypes AnalysisType ()
 Returns the analysis type
Created in NX6.0.0. More...
 
bool AutoScale ()
 Returns the auto scale flag
Created in NX6.0.0. More...
 
int Density ()
 Returns the density
Created in NX6.0.0. More...
 
bool HasMaxNeedleLength ()
 Returns the maximum needle flag
Created in NX6.0.0. More...
 
int IntermediateDensity ()
 Returns the intermediate density
Created in NX6.0.0. More...
 
bool IsMaximumLabelEnabled ()
 Returns the value indicating if the maximum label is enabled
Created in NX7.0.0. More...
 
bool IsMinimumLabelEnabled ()
 Returns the value indicating if the minimum label is enabled
Created in NX7.0.0. More...
 
bool IsNormalToGridPlane ()
 Returns the normal to grid plane flag
Created in NX6.0.0. More...
 
double MaxNeedleLength ()
 Returns the maximum needle length
Created in NX6.0.0. More...
 
bool ReverseNeedles ()
 Returns the reverse needles flag
Created in NX6.0.0. More...
 
double SampleDistance ()
 Returns the sample distance
Created in NX11.0.0. More...
 
double ScaleFactor ()
 Returns the scale factor
Created in NX6.0.0. More...
 
void SetAnalysisType (NXOpen::GeometricUtilities::CombOptionsBuilder::AnalysisTypes analysis)
 Sets the analysis type
Created in NX6.0.0. More...
 
void SetAutoScale (bool hasAutoScale)
 Sets the auto scale flag
Created in NX6.0.0. More...
 
void SetDensity (int density)
 Sets the density
Created in NX6.0.0. More...
 
void SetHasMaxNeedleLength (bool hasMaxNeedleLength)
 Sets the maximum needle flag
Created in NX6.0.0. More...
 
void SetIntermediateDensity (int intermediateDensity)
 Sets the intermediate density
Created in NX6.0.0. More...
 
void SetMaximumLabelEnabled (bool isMaximumLabelEnabled)
 Sets the value indicating if the maximum label is enabled
Created in NX7.0.0. More...
 
void SetMaxNeedleLength (double maxNeedleLength)
 Sets the maximum needle length
Created in NX6.0.0. More...
 
void SetMinimumLabelEnabled (bool isMinimumLabelEnabled)
 Sets the value indicating if the minimum label is enabled
Created in NX7.0.0. More...
 
void SetNormalToGridPlane (bool isNormalToGridPlane)
 Sets the normal to grid plane flag
Created in NX6.0.0. More...
 
void SetReverseNeedles (bool reverseNeedles)
 Sets the reverse needles flag
Created in NX6.0.0. More...
 
void SetSampleDistance (double sampleDistance)
 Sets the sample distance
Created in NX11.0.0. More...
 
void SetScaleFactor (double scaleFactor)
 Sets the scale factor
Created in NX6.0.0. More...
 
void SetShowNeedles (bool showNeedles)
 Sets the show needles flag
Created in NX6.0.0. More...
 
bool ShowNeedles ()
 Returns the show needles flag
Created in NX6.0.0. More...
 
virtual bool Validate ()
 Validate whether the inputs to the component are sufficient for commit to be called. More...
 
- Public Member Functions inherited from NXOpen::TaggedObject
tag_t Tag () const
 Returns the tag of this object. More...
 

Detailed Description

Represents a NXOpen::GeometricUtilities::CombOptionsBuilder.


Created in NX6.0.0.

Member Enumeration Documentation

Represents the Analysis types.

Enumerator
AnalysisTypesNone 

None.

AnalysisTypesCurvature 

Curvature.

AnalysisTypesRadius 

Radius.

Represents the Label types.

Enumerator
LabelTypesNone 

None.

LabelTypesMinimum 

Minimum.

LabelTypesMaximum 

Maximum.

LabelTypesMinimumMaximum 

Minimum and Maximum.

Member Function Documentation

NXOpen::GeometricUtilities::CombOptionsBuilder::AnalysisTypes NXOpen::GeometricUtilities::CombOptionsBuilder::AnalysisType ( )

Returns the analysis type
Created in NX6.0.0.



License requirements : None

bool NXOpen::GeometricUtilities::CombOptionsBuilder::AutoScale ( )

Returns the auto scale flag
Created in NX6.0.0.



License requirements : None

int NXOpen::GeometricUtilities::CombOptionsBuilder::Density ( )

Returns the density
Created in NX6.0.0.



License requirements : None

bool NXOpen::GeometricUtilities::CombOptionsBuilder::HasMaxNeedleLength ( )

Returns the maximum needle flag
Created in NX6.0.0.



License requirements : None

int NXOpen::GeometricUtilities::CombOptionsBuilder::IntermediateDensity ( )

Returns the intermediate density
Created in NX6.0.0.



License requirements : None

bool NXOpen::GeometricUtilities::CombOptionsBuilder::IsMaximumLabelEnabled ( )

Returns the value indicating if the maximum label is enabled
Created in NX7.0.0.



License requirements : None

bool NXOpen::GeometricUtilities::CombOptionsBuilder::IsMinimumLabelEnabled ( )

Returns the value indicating if the minimum label is enabled
Created in NX7.0.0.



License requirements : None

bool NXOpen::GeometricUtilities::CombOptionsBuilder::IsNormalToGridPlane ( )

Returns the normal to grid plane flag
Created in NX6.0.0.



License requirements : None

double NXOpen::GeometricUtilities::CombOptionsBuilder::MaxNeedleLength ( )

Returns the maximum needle length
Created in NX6.0.0.



License requirements : None

bool NXOpen::GeometricUtilities::CombOptionsBuilder::ReverseNeedles ( )

Returns the reverse needles flag
Created in NX6.0.0.



License requirements : None

double NXOpen::GeometricUtilities::CombOptionsBuilder::SampleDistance ( )

Returns the sample distance
Created in NX11.0.0.



License requirements : None

double NXOpen::GeometricUtilities::CombOptionsBuilder::ScaleFactor ( )

Returns the scale factor
Created in NX6.0.0.



License requirements : None

void NXOpen::GeometricUtilities::CombOptionsBuilder::SetAnalysisType ( NXOpen::GeometricUtilities::CombOptionsBuilder::AnalysisTypes  analysis)

Sets the analysis type
Created in NX6.0.0.



License requirements : None

Parameters
analysisanalysis
void NXOpen::GeometricUtilities::CombOptionsBuilder::SetAutoScale ( bool  hasAutoScale)

Sets the auto scale flag
Created in NX6.0.0.



License requirements : None

Parameters
hasAutoScalehasautoscale
void NXOpen::GeometricUtilities::CombOptionsBuilder::SetDensity ( int  density)

Sets the density
Created in NX6.0.0.



License requirements : None

Parameters
densitydensity
void NXOpen::GeometricUtilities::CombOptionsBuilder::SetHasMaxNeedleLength ( bool  hasMaxNeedleLength)

Sets the maximum needle flag
Created in NX6.0.0.



License requirements : None

Parameters
hasMaxNeedleLengthhasmaxneedlelength
void NXOpen::GeometricUtilities::CombOptionsBuilder::SetIntermediateDensity ( int  intermediateDensity)

Sets the intermediate density
Created in NX6.0.0.



License requirements : None

Parameters
intermediateDensityintermediatedensity
void NXOpen::GeometricUtilities::CombOptionsBuilder::SetMaximumLabelEnabled ( bool  isMaximumLabelEnabled)

Sets the value indicating if the maximum label is enabled
Created in NX7.0.0.



License requirements : None

Parameters
isMaximumLabelEnabledismaximumlabelenabled
void NXOpen::GeometricUtilities::CombOptionsBuilder::SetMaxNeedleLength ( double  maxNeedleLength)

Sets the maximum needle length
Created in NX6.0.0.



License requirements : None

Parameters
maxNeedleLengthmaxneedlelength
void NXOpen::GeometricUtilities::CombOptionsBuilder::SetMinimumLabelEnabled ( bool  isMinimumLabelEnabled)

Sets the value indicating if the minimum label is enabled
Created in NX7.0.0.



License requirements : None

Parameters
isMinimumLabelEnabledisminimumlabelenabled
void NXOpen::GeometricUtilities::CombOptionsBuilder::SetNormalToGridPlane ( bool  isNormalToGridPlane)

Sets the normal to grid plane flag
Created in NX6.0.0.



License requirements : None

Parameters
isNormalToGridPlaneisnormaltogridplane
void NXOpen::GeometricUtilities::CombOptionsBuilder::SetReverseNeedles ( bool  reverseNeedles)

Sets the reverse needles flag
Created in NX6.0.0.



License requirements : None

Parameters
reverseNeedlesreverseneedles
void NXOpen::GeometricUtilities::CombOptionsBuilder::SetSampleDistance ( double  sampleDistance)

Sets the sample distance
Created in NX11.0.0.



License requirements : None

Parameters
sampleDistancesampledistance
void NXOpen::GeometricUtilities::CombOptionsBuilder::SetScaleFactor ( double  scaleFactor)

Sets the scale factor
Created in NX6.0.0.



License requirements : None

Parameters
scaleFactorscalefactor
void NXOpen::GeometricUtilities::CombOptionsBuilder::SetShowNeedles ( bool  showNeedles)

Sets the show needles flag
Created in NX6.0.0.



License requirements : None

Parameters
showNeedlesshowneedles
bool NXOpen::GeometricUtilities::CombOptionsBuilder::ShowNeedles ( )

Returns the show needles flag
Created in NX6.0.0.



License requirements : None

virtual bool NXOpen::GeometricUtilities::CombOptionsBuilder::Validate ( )
virtual

Validate whether the inputs to the component are sufficient for commit to be called.

If the component is not in a state to commit then an exception is thrown. For example, if the component requires you to set some property, this method will throw an exception if you haven't set it. This method throws a not-yet-implemented NXException for some components.

Returns
Was self validation successful
Created in NX3.0.1.

License requirements : None

Implements NXOpen::GeometricUtilities::IComponentBuilder.


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