NX Open C++ Reference Guide
Public Member Functions | List of all members
NXOpen::Annotations::UnitsStyleBuilder Class Reference

Represents a NXOpen::Annotations::UnitsStyleBuilder . More...

Inheritance diagram for NXOpen::Annotations::UnitsStyleBuilder:
NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Member Functions

NXOpen::Annotations::AngularSuppressZeros AngularSuppressZeros ()
 Returns the angular suppress zeros option
Created in NX6.0.0. More...
 
bool ConvertPrimaryTolerance ()
 Returns the convert primary tolerance option. More...
 
NXOpen::Annotations::DecimalPointCharacter DecimalPointCharacter ()
 Returns the decimal point character
Created in NX6.0.0. More...
 
NXOpen::Annotations::AngularDimensionFormat DimensionAngularFormat ()
 Returns the dimension angular format and precision
Created in NX6.0.0. More...
 
NXOpen::Annotations::DimensionUnit DimensionLinearUnits ()
 Returns the dimension linear units
Created in NX6.0.0. More...
 
NXOpen::Annotations::TolerancePlacement DimensionTolerancePlacement ()
 Returns the dimension tolerance placement relative to the dimension value
Created in NX6.0.0. More...
 
bool DisplayLeadingDimensionZeros ()
 Returns the display leading dimension zeros setting for linear dimensions and fractional angular dimensions
Created in NX6.0.0. More...
 
bool DisplayLeadingToleranceZeros ()
 Returns the display leading tolerance zeros setting for linear dimensions and fractional angular dimensions
Created in NX6.0.0. More...
 
bool DisplayTrailingZeros ()
 Returns the display trailing zeros setting for linear dimensions and tolerances
Created in NX6.0.0. More...
 
bool DualDimensionCenterDimensionLine ()
 Returns the center dimension line flag for dual dimension. More...
 
NXOpen::Annotations::DualDimensionPlacement DualDimensionFormat ()
 Returns the dual dimension format. More...
 
NXOpen::Annotations::DimensionUnit DualDimensionUnits ()
 Returns the dual dimension units
Created in NX6.0.0. More...
 
NXOpen::Annotations::DimensionTextFormat DualFractionType ()
 Returns the decimal and fraction format for dual nonmetric dimensions
Created in NX6.0.0. More...
 
bool FractionalDisplay ()
 Returns the fractional display for angular dimension
Created in NX8.0.0. More...
 
NXOpen::Annotations::DimensionTextFormat LinearFractionType ()
 Returns the decimal and fraction text format for nonmetric dimensions
Created in NX6.0.0. More...
 
int NumeratorDegrees ()
 Returns the numerator degrees of fractional display for angular dimension
Created in NX8.0.0. More...
 
double NumeratorFraction ()
 Returns the numerator fractional degrees of fractional display for angular dimension
Created in NX8.0.0. More...
 
int NumeratorMinutes ()
 Returns the numerator minutes of fractional display for angular dimension
Created in NX8.0.0. More...
 
int NumeratorSeconds ()
 Returns the numerator seconds of fractional display for angular dimension
Created in NX8.0.0. More...
 
void SetAngularSuppressZeros (NXOpen::Annotations::AngularSuppressZeros angularSuppressZeros)
 Sets the angular suppress zeros option
Created in NX6.0.0. More...
 
void SetConvertPrimaryTolerance (bool convertPrimaryTolerance)
 Sets the convert primary tolerance option. More...
 
void SetDecimalPointCharacter (NXOpen::Annotations::DecimalPointCharacter decimalPointCharacter)
 Sets the decimal point character
Created in NX6.0.0. More...
 
void SetDimensionAngularFormat (NXOpen::Annotations::AngularDimensionFormat dimensionAngularFormat)
 Sets the dimension angular format and precision
Created in NX6.0.0. More...
 
void SetDimensionLinearUnits (NXOpen::Annotations::DimensionUnit dimensionLinearUnits)
 Sets the dimension linear units
Created in NX6.0.0. More...
 
void SetDimensionTolerancePlacement (NXOpen::Annotations::TolerancePlacement dimensionTolerancePlacement)
 Sets the dimension tolerance placement relative to the dimension value
Created in NX6.0.0. More...
 
void SetDisplayLeadingDimensionZeros (bool displayLeadingDimensionZeros)
 Sets the display leading dimension zeros setting for linear dimensions and fractional angular dimensions
Created in NX6.0.0. More...
 
void SetDisplayLeadingToleranceZeros (bool displayLeadingToleranceZeros)
 Sets the display leading tolerance zeros setting for linear dimensions and fractional angular dimensions
Created in NX6.0.0. More...
 
void SetDisplayTrailingZeros (bool displayTrailingZeros)
 Sets the display trailing zeros setting for linear dimensions and tolerances
Created in NX6.0.0. More...
 
void SetDualDimensionCenterDimensionLine (bool centerDimensionLine)
 Sets the center dimension line flag for dual dimension. More...
 
void SetDualDimensionFormat (NXOpen::Annotations::DualDimensionPlacement dualDimensionFormat)
 Sets the dual dimension format. More...
 
void SetDualDimensionUnits (NXOpen::Annotations::DimensionUnit dualDimensionUnits)
 Sets the dual dimension units
Created in NX6.0.0. More...
 
void SetDualFractionType (NXOpen::Annotations::DimensionTextFormat dualFractionType)
 Sets the decimal and fraction format for dual nonmetric dimensions
Created in NX6.0.0. More...
 
void SetFractionalDisplay (bool fractionalDisplay)
 Sets the fractional display for angular dimension
Created in NX8.0.0. More...
 
void SetLinearFractionType (NXOpen::Annotations::DimensionTextFormat linearFractionType)
 Sets the decimal and fraction text format for nonmetric dimensions
Created in NX6.0.0. More...
 
void SetNumeratorDegrees (int numeratorDegrees)
 Sets the numerator degrees of fractional display for angular dimension
Created in NX8.0.0. More...
 
void SetNumeratorFraction (double numeratorFraction)
 Sets the numerator fractional degrees of fractional display for angular dimension
Created in NX8.0.0. More...
 
void SetNumeratorMinutes (int numeratorMinutes)
 Sets the numerator minutes of fractional display for angular dimension
Created in NX8.0.0. More...
 
void SetNumeratorSeconds (int numeratorSeconds)
 Sets the numerator seconds of fractional display for angular dimension
Created in NX8.0.0. More...
 
void SetToleranceAngularFormat (NXOpen::Annotations::AngularDimensionFormat toleranceAngularFormat)
 Sets the tolerance angular format and precision
Created in NX6.0.0. More...
 
NXOpen::Annotations::AngularDimensionFormat ToleranceAngularFormat ()
 Returns the tolerance angular format and precision
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::Annotations::UnitsStyleBuilder .

This class queries and sets units and format preferences when creating or editing a dimension.
Created in NX6.0.0.

Member Function Documentation

NXOpen::Annotations::AngularSuppressZeros NXOpen::Annotations::UnitsStyleBuilder::AngularSuppressZeros ( )

Returns the angular suppress zeros option
Created in NX6.0.0.



License requirements : None

bool NXOpen::Annotations::UnitsStyleBuilder::ConvertPrimaryTolerance ( )

Returns the convert primary tolerance option.

A value of True means that the dual dimension tolerance is automatically set by converting the primary dimension tolerance value to the dual dimension units
Created in NX6.0.0.

License requirements : None

NXOpen::Annotations::DecimalPointCharacter NXOpen::Annotations::UnitsStyleBuilder::DecimalPointCharacter ( )

Returns the decimal point character
Created in NX6.0.0.



License requirements : None

NXOpen::Annotations::AngularDimensionFormat NXOpen::Annotations::UnitsStyleBuilder::DimensionAngularFormat ( )

Returns the dimension angular format and precision
Created in NX6.0.0.



License requirements : None

NXOpen::Annotations::DimensionUnit NXOpen::Annotations::UnitsStyleBuilder::DimensionLinearUnits ( )

Returns the dimension linear units
Created in NX6.0.0.



License requirements : None

NXOpen::Annotations::TolerancePlacement NXOpen::Annotations::UnitsStyleBuilder::DimensionTolerancePlacement ( )

Returns the dimension tolerance placement relative to the dimension value
Created in NX6.0.0.



License requirements : None

bool NXOpen::Annotations::UnitsStyleBuilder::DisplayLeadingDimensionZeros ( )

Returns the display leading dimension zeros setting for linear dimensions and fractional angular dimensions
Created in NX6.0.0.



License requirements : None

bool NXOpen::Annotations::UnitsStyleBuilder::DisplayLeadingToleranceZeros ( )

Returns the display leading tolerance zeros setting for linear dimensions and fractional angular dimensions
Created in NX6.0.0.



License requirements : None

bool NXOpen::Annotations::UnitsStyleBuilder::DisplayTrailingZeros ( )

Returns the display trailing zeros setting for linear dimensions and tolerances
Created in NX6.0.0.



License requirements : None

bool NXOpen::Annotations::UnitsStyleBuilder::DualDimensionCenterDimensionLine ( )

Returns the center dimension line flag for dual dimension.

If this flag is true, the alignment of the dimension line will be centered between the main and dual text, regardless of appended text above or below and the Vertical Alignment of the leader line.
Created in NX12.0.0.

License requirements : None

NXOpen::Annotations::DualDimensionPlacement NXOpen::Annotations::UnitsStyleBuilder::DualDimensionFormat ( )

Returns the dual dimension format.

This specifies both the creation and position of the dual dimension
Created in NX6.0.0.

License requirements : None

NXOpen::Annotations::DimensionUnit NXOpen::Annotations::UnitsStyleBuilder::DualDimensionUnits ( )

Returns the dual dimension units
Created in NX6.0.0.



License requirements : None

NXOpen::Annotations::DimensionTextFormat NXOpen::Annotations::UnitsStyleBuilder::DualFractionType ( )

Returns the decimal and fraction format for dual nonmetric dimensions
Created in NX6.0.0.



License requirements : None

bool NXOpen::Annotations::UnitsStyleBuilder::FractionalDisplay ( )

Returns the fractional display for angular dimension
Created in NX8.0.0.



License requirements : None

NXOpen::Annotations::DimensionTextFormat NXOpen::Annotations::UnitsStyleBuilder::LinearFractionType ( )

Returns the decimal and fraction text format for nonmetric dimensions
Created in NX6.0.0.



License requirements : None

int NXOpen::Annotations::UnitsStyleBuilder::NumeratorDegrees ( )

Returns the numerator degrees of fractional display for angular dimension
Created in NX8.0.0.



License requirements : None

double NXOpen::Annotations::UnitsStyleBuilder::NumeratorFraction ( )

Returns the numerator fractional degrees of fractional display for angular dimension
Created in NX8.0.0.



License requirements : None

int NXOpen::Annotations::UnitsStyleBuilder::NumeratorMinutes ( )

Returns the numerator minutes of fractional display for angular dimension
Created in NX8.0.0.



License requirements : None

int NXOpen::Annotations::UnitsStyleBuilder::NumeratorSeconds ( )

Returns the numerator seconds of fractional display for angular dimension
Created in NX8.0.0.



License requirements : None

void NXOpen::Annotations::UnitsStyleBuilder::SetAngularSuppressZeros ( NXOpen::Annotations::AngularSuppressZeros  angularSuppressZeros)

Sets the angular suppress zeros option
Created in NX6.0.0.



License requirements : geometric_tol ("GDT") OR drafting ("DRAFTING")

Parameters
angularSuppressZerosangularsuppresszeros
void NXOpen::Annotations::UnitsStyleBuilder::SetConvertPrimaryTolerance ( bool  convertPrimaryTolerance)

Sets the convert primary tolerance option.

A value of True means that the dual dimension tolerance is automatically set by converting the primary dimension tolerance value to the dual dimension units
Created in NX6.0.0.

License requirements : geometric_tol ("GDT") OR drafting ("DRAFTING")

Parameters
convertPrimaryToleranceconvertprimarytolerance
void NXOpen::Annotations::UnitsStyleBuilder::SetDecimalPointCharacter ( NXOpen::Annotations::DecimalPointCharacter  decimalPointCharacter)

Sets the decimal point character
Created in NX6.0.0.



License requirements : geometric_tol ("GDT") OR drafting ("DRAFTING")

Parameters
decimalPointCharacterdecimalpointcharacter
void NXOpen::Annotations::UnitsStyleBuilder::SetDimensionAngularFormat ( NXOpen::Annotations::AngularDimensionFormat  dimensionAngularFormat)

Sets the dimension angular format and precision
Created in NX6.0.0.



License requirements : geometric_tol ("GDT") OR drafting ("DRAFTING")

Parameters
dimensionAngularFormatdimensionangularformat
void NXOpen::Annotations::UnitsStyleBuilder::SetDimensionLinearUnits ( NXOpen::Annotations::DimensionUnit  dimensionLinearUnits)

Sets the dimension linear units
Created in NX6.0.0.



License requirements : geometric_tol ("GDT") OR drafting ("DRAFTING")

Parameters
dimensionLinearUnitsdimensionlinearunits
void NXOpen::Annotations::UnitsStyleBuilder::SetDimensionTolerancePlacement ( NXOpen::Annotations::TolerancePlacement  dimensionTolerancePlacement)

Sets the dimension tolerance placement relative to the dimension value
Created in NX6.0.0.



License requirements : geometric_tol ("GDT") OR drafting ("DRAFTING")

Parameters
dimensionTolerancePlacementdimensiontoleranceplacement
void NXOpen::Annotations::UnitsStyleBuilder::SetDisplayLeadingDimensionZeros ( bool  displayLeadingDimensionZeros)

Sets the display leading dimension zeros setting for linear dimensions and fractional angular dimensions
Created in NX6.0.0.



License requirements : geometric_tol ("GDT") OR drafting ("DRAFTING")

Parameters
displayLeadingDimensionZerosdisplayleadingdimensionzeros
void NXOpen::Annotations::UnitsStyleBuilder::SetDisplayLeadingToleranceZeros ( bool  displayLeadingToleranceZeros)

Sets the display leading tolerance zeros setting for linear dimensions and fractional angular dimensions
Created in NX6.0.0.



License requirements : geometric_tol ("GDT") OR drafting ("DRAFTING")

Parameters
displayLeadingToleranceZerosdisplayleadingtolerancezeros
void NXOpen::Annotations::UnitsStyleBuilder::SetDisplayTrailingZeros ( bool  displayTrailingZeros)

Sets the display trailing zeros setting for linear dimensions and tolerances
Created in NX6.0.0.



License requirements : geometric_tol ("GDT") OR drafting ("DRAFTING")

Parameters
displayTrailingZerosdisplaytrailingzeros
void NXOpen::Annotations::UnitsStyleBuilder::SetDualDimensionCenterDimensionLine ( bool  centerDimensionLine)

Sets the center dimension line flag for dual dimension.

If this flag is true, the alignment of the dimension line will be centered between the main and dual text, regardless of appended text above or below and the Vertical Alignment of the leader line.
Created in NX12.0.0.

License requirements : geometric_tol ("GDT") OR drafting ("DRAFTING")

Parameters
centerDimensionLinecenterdimensionline
void NXOpen::Annotations::UnitsStyleBuilder::SetDualDimensionFormat ( NXOpen::Annotations::DualDimensionPlacement  dualDimensionFormat)

Sets the dual dimension format.

This specifies both the creation and position of the dual dimension
Created in NX6.0.0.

License requirements : geometric_tol ("GDT") OR drafting ("DRAFTING")

Parameters
dualDimensionFormatdualdimensionformat
void NXOpen::Annotations::UnitsStyleBuilder::SetDualDimensionUnits ( NXOpen::Annotations::DimensionUnit  dualDimensionUnits)

Sets the dual dimension units
Created in NX6.0.0.



License requirements : geometric_tol ("GDT") OR drafting ("DRAFTING")

Parameters
dualDimensionUnitsdualdimensionunits
void NXOpen::Annotations::UnitsStyleBuilder::SetDualFractionType ( NXOpen::Annotations::DimensionTextFormat  dualFractionType)

Sets the decimal and fraction format for dual nonmetric dimensions
Created in NX6.0.0.



License requirements : geometric_tol ("GDT") OR drafting ("DRAFTING")

Parameters
dualFractionTypedualfractiontype
void NXOpen::Annotations::UnitsStyleBuilder::SetFractionalDisplay ( bool  fractionalDisplay)

Sets the fractional display for angular dimension
Created in NX8.0.0.



License requirements : geometric_tol ("GDT") OR drafting ("DRAFTING")

Parameters
fractionalDisplayfractionaldisplay
void NXOpen::Annotations::UnitsStyleBuilder::SetLinearFractionType ( NXOpen::Annotations::DimensionTextFormat  linearFractionType)

Sets the decimal and fraction text format for nonmetric dimensions
Created in NX6.0.0.



License requirements : geometric_tol ("GDT") OR drafting ("DRAFTING")

Parameters
linearFractionTypelinearfractiontype
void NXOpen::Annotations::UnitsStyleBuilder::SetNumeratorDegrees ( int  numeratorDegrees)

Sets the numerator degrees of fractional display for angular dimension
Created in NX8.0.0.



License requirements : geometric_tol ("GDT") OR drafting ("DRAFTING")

Parameters
numeratorDegreesnumeratordegrees
void NXOpen::Annotations::UnitsStyleBuilder::SetNumeratorFraction ( double  numeratorFraction)

Sets the numerator fractional degrees of fractional display for angular dimension
Created in NX8.0.0.



License requirements : geometric_tol ("GDT") OR drafting ("DRAFTING")

Parameters
numeratorFractionnumeratorfraction
void NXOpen::Annotations::UnitsStyleBuilder::SetNumeratorMinutes ( int  numeratorMinutes)

Sets the numerator minutes of fractional display for angular dimension
Created in NX8.0.0.



License requirements : geometric_tol ("GDT") OR drafting ("DRAFTING")

Parameters
numeratorMinutesnumeratorminutes
void NXOpen::Annotations::UnitsStyleBuilder::SetNumeratorSeconds ( int  numeratorSeconds)

Sets the numerator seconds of fractional display for angular dimension
Created in NX8.0.0.



License requirements : geometric_tol ("GDT") OR drafting ("DRAFTING")

Parameters
numeratorSecondsnumeratorseconds
void NXOpen::Annotations::UnitsStyleBuilder::SetToleranceAngularFormat ( NXOpen::Annotations::AngularDimensionFormat  toleranceAngularFormat)

Sets the tolerance angular format and precision
Created in NX6.0.0.



License requirements : geometric_tol ("GDT") OR drafting ("DRAFTING")

Parameters
toleranceAngularFormattoleranceangularformat
NXOpen::Annotations::AngularDimensionFormat NXOpen::Annotations::UnitsStyleBuilder::ToleranceAngularFormat ( )

Returns the tolerance angular format and precision
Created in NX6.0.0.



License requirements : None

virtual bool NXOpen::Annotations::UnitsStyleBuilder::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.