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

Represents a GeometricUtilities::CombOptionsBuilder. More...

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

List of all members.

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.
bool AutoScale ()
 Returns the auto scale flag
Created in NX6.0.0.
int Density ()
 Returns the density
Created in NX6.0.0.
bool HasMaxNeedleLength ()
 Returns the maximum needle flag
Created in NX6.0.0.
int IntermediateDensity ()
 Returns the intermediate density
Created in NX6.0.0.
bool IsMaximumLabelEnabled ()
 Returns the value indicating if the maximum label is enabled
Created in NX7.0.0.
bool IsMinimumLabelEnabled ()
 Returns the value indicating if the minimum label is enabled
Created in NX7.0.0.
bool IsNormalToGridPlane ()
 Returns the normal to grid plane flag
Created in NX6.0.0.
NXOpen::GeometricUtilities::CombOptionsBuilder::LabelTypes LabelType ()
 Returns the label type

double MaxNeedleLength ()
 Returns the maximum needle length
Created in NX6.0.0.
bool ReverseNeedles ()
 Returns the reverse needles flag
Created in NX6.0.0.
double ScaleFactor ()
 Returns the scale factor
Created in NX6.0.0.
void SetAnalysisType (NXOpen::GeometricUtilities::CombOptionsBuilder::AnalysisTypes analysis)
 Sets the analysis type
Created in NX6.0.0.
void SetAutoScale (bool hasAutoScale)
 Sets the auto scale flag
Created in NX6.0.0.
void SetDensity (int density)
 Sets the density
Created in NX6.0.0.
void SetHasMaxNeedleLength (bool hasMaxNeedleLength)
 Sets the maximum needle flag
Created in NX6.0.0.
void SetIntermediateDensity (int intermediateDensity)
 Sets the intermediate density
Created in NX6.0.0.
void SetLabelType (NXOpen::GeometricUtilities::CombOptionsBuilder::LabelTypes label)
 Sets the label type

void SetMaximumLabelEnabled (bool isMaximumLabelEnabled)
 Sets the value indicating if the maximum label is enabled
Created in NX7.0.0.
void SetMaxNeedleLength (double maxNeedleLength)
 Sets the maximum needle length
Created in NX6.0.0.
void SetMinimumLabelEnabled (bool isMinimumLabelEnabled)
 Sets the value indicating if the minimum label is enabled
Created in NX7.0.0.
void SetNormalToGridPlane (bool isNormalToGridPlane)
 Sets the normal to grid plane flag
Created in NX6.0.0.
void SetReverseNeedles (bool reverseNeedles)
 Sets the reverse needles flag
Created in NX6.0.0.
void SetScaleFactor (double scaleFactor)
 Sets the scale factor
Created in NX6.0.0.
void SetShowNeedles (bool showNeedles)
 Sets the show needles flag
Created in NX6.0.0.
bool ShowNeedles ()
 Returns the show needles flag
Created in NX6.0.0.
virtual bool Validate ()
 Validate whether the inputs to the component are sufficient for commit to be called.

Detailed Description

Represents a 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

Deprecated:
Deprecated in NX7.0.0.


Enumerator:
LabelTypesNone 

None.

LabelTypesMinimum 

Minimum.

LabelTypesMaximum 

Maximum.

LabelTypesMinimumMaximum 

Minimum and Maximum.


Member Function Documentation

Returns the analysis type
Created in NX6.0.0.



License requirements : None

Returns the auto scale flag
Created in NX6.0.0.



License requirements : None

Returns the density
Created in NX6.0.0.



License requirements : None

Returns the maximum needle flag
Created in NX6.0.0.



License requirements : None

Returns the intermediate density
Created in NX6.0.0.



License requirements : None

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



License requirements : None

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



License requirements : None

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



License requirements : None

Returns the label type

Deprecated:
Deprecated in NX7.0.0.



Created in NX6.0.0.

License requirements : None

Returns the maximum needle length
Created in NX6.0.0.



License requirements : None

Returns the reverse needles flag
Created in NX6.0.0.



License requirements : None

Returns the scale factor
Created in NX6.0.0.



License requirements : None

Sets the analysis type
Created in NX6.0.0.



License requirements : None

Parameters:
analysisanalysis

Sets the auto scale flag
Created in NX6.0.0.



License requirements : None

Parameters:
hasAutoScalehasautoscale

Sets the density
Created in NX6.0.0.



License requirements : None

Parameters:
densitydensity

Sets the maximum needle flag
Created in NX6.0.0.



License requirements : None

Parameters:
hasMaxNeedleLengthhasmaxneedlelength

Sets the intermediate density
Created in NX6.0.0.



License requirements : None

Parameters:
intermediateDensityintermediatedensity

Sets the label type

Deprecated:
Deprecated in NX7.0.0.



Created in NX6.0.0.

License requirements : None

Parameters:
labellabel

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



License requirements : None

Parameters:
isMaximumLabelEnabledismaximumlabelenabled

Sets the maximum needle length
Created in NX6.0.0.



License requirements : None

Parameters:
maxNeedleLengthmaxneedlelength

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



License requirements : None

Parameters:
isMinimumLabelEnabledisminimumlabelenabled

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



License requirements : None

Parameters:
isNormalToGridPlaneisnormaltogridplane

Sets the reverse needles flag
Created in NX6.0.0.



License requirements : None

Parameters:
reverseNeedlesreverseneedles

Sets the scale factor
Created in NX6.0.0.



License requirements : None

Parameters:
scaleFactorscalefactor

Sets the show needles flag
Created in NX6.0.0.



License requirements : None

Parameters:
showNeedlesshowneedles

Returns the show needles flag
Created in NX6.0.0.



License requirements : None

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 2011 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.