NX Open C++ Reference Guide
Public Member Functions
NXOpen::Annotations::Dimension Class Reference

Represents a dimension
Abstract class

Created in NX3.0.0. More...

Inheritance diagram for NXOpen::Annotations::Dimension:
NXOpen::Annotations::Annotation NXOpen::Annotations::IAppendedText NXOpen::DisplayableObject NXOpen::INXObject NXOpen::NXObject NXOpen::IFitTo NXOpen::TaggedObject NXOpen::INXObject NXOpen::INXObject NXOpen::Annotations::AngularDimension NXOpen::Annotations::BaseArcLengthDimension NXOpen::Annotations::BaseChamferDimension NXOpen::Annotations::BaseConcentricCircleDimension NXOpen::Annotations::BaseCylindricalDimension NXOpen::Annotations::BaseDiameterDimension NXOpen::Annotations::BaseFoldedRadiusDimension NXOpen::Annotations::BaseHoleDimension NXOpen::Annotations::BaseHorizontalDimension NXOpen::Annotations::BaseParallelDimension NXOpen::Annotations::BasePerpendicularDimension NXOpen::Annotations::BaseRadiusDimension NXOpen::Annotations::BaseVerticalDimension NXOpen::Annotations::OrdinateDimension NXOpen::Annotations::OrdinateOriginDimension

List of all members.

Public Member Functions

double ComputedSize ()
 Returns the computed size of the dimension.
virtual
NXOpen::Annotations::AppendedText
GetAppendedText ()
 Returns the appended text.
NXOpen::Annotations::DimensionPreferencesGetDimensionPreferences ()
 Returns the dimension preferences.
void GetDimensionText (std::vector< NXString > &mainTextLines, std::vector< NXString > &dualTextLines)
 Returns the dimension text - both the main text and the dual text.
NXOpen::Annotations::NarrowDimensionData GetNarrowDimensionPreferences ()
 Returns the narrow dimension preferences for the given linear dimension.
double GetNarrowDimensionTextOffset ()
 Returns the narrow dimension text offset for the given chain dimension.
bool InspectionDimensionFlag ()
 Returns a setting to control the inspection box displayed around the dimension value.
bool IsDriving ()
 Determines if a dimension is driving.
bool IsOriginCentered ()
 Returns a flag indicating whether the dimension text is centered equally between the extension lines.
NXOpen::Annotations::FitAnsiHoleType LimitFitAnsiHoleType ()
 Returns the tolerance limit fit ANSI hole type
Created in NX7.5.0.
NXString LimitFitDeviation ()
 Returns the tolerance limit fit deviation
Created in NX7.5.0.
NXOpen::Annotations::FitDisplayStyle LimitFitDisplayStyle ()
 Returns the tolerance limit fit display style
Created in NX7.5.0.
int LimitFitGrade ()
 Returns the tolerance limit fit grade
Created in NX7.5.0.
double LowerMetricToleranceValue ()
 Returns a setting to control the metric lower tolerance value of a dimension.
double LowerToleranceValue ()
 Returns a setting to control the lower tolerance value of a dimension.
NXOpen::DirectionMeasurementDirection ()
 Returns the measurement direction
Created in NX7.5.0.
NXOpen::ViewMeasurementDirectionView ()
 Returns the measurement direction view
Created in NX7.5.0.
int MetricNominalDecimalPlaces ()
 Returns a setting to control the number of decimal places for the nominal value of a metric dimension.
int MetricToleranceDecimalPlaces ()
 Returns a setting to control the number of decimal places for the metric tolerance value of a dimension.
int NominalDecimalPlaces ()
 Returns a setting to control the number of decimal places for the nominal value of a dimension.
bool ReferenceDimensionFlag ()
 Returns a setting to control the visibility of the reference parenthesis of a dimension.
virtual void SetAppendedText (NXOpen::Annotations::AppendedText *appendedText)
 Sets the appended text
Created in NX4.0.0.
void SetComputedSize (double computedSize)
 

void SetDimensionPreferences (NXOpen::Annotations::DimensionPreferences *preferences)
 Sets the dimension preferences
Created in NX4.0.0.
void SetDimensionText (std::vector< NXString > &mainTextLines)
 Set the main dimension text.
void SetInspectionDimensionFlag (bool inspectionDimensionFlag)
 Sets a setting to control the inspection box displayed around the dimension value.
void SetLimitFitAnsiHoleType (NXOpen::Annotations::FitAnsiHoleType fitHoleType)
 Sets the tolerance limit fit ANSI hole type
Created in NX7.5.0.
void SetLimitFitDeviation (const NXString &fitDeviation)
 Sets the tolerance limit fit deviation
Created in NX7.5.0.
void SetLimitFitDisplayStyle (NXOpen::Annotations::FitDisplayStyle fitDisplayStyle)
 Sets the tolerance limit fit display style
Created in NX7.5.0.
void SetLimitFitGrade (int fitGrade)
 Sets the tolerance limit fit grade
Created in NX7.5.0.
void SetLowerMetricToleranceValue (double toleranceValue)
 Sets a setting to control the metric lower tolerance value of a dimension.
void SetLowerToleranceValue (double upperToleranceValue)
 Sets a setting to control the lower tolerance value of a dimension.
void SetMeasurementDirection (NXOpen::Direction *direction)
 Sets the measurement direction
Created in NX7.5.0.
void SetMeasurementDirectionView (NXOpen::View *view)
 Sets the measurement direction view
Created in NX7.5.0.
void SetMetricNominalDecimalPlaces (int decimalPlaces)
 Sets a setting to control the number of decimal places for the nominal value of a metric dimension.
void SetMetricToleranceDecimalPlaces (int decimalPlaces)
 Sets a setting to control the number of decimal places for the metric tolerance value of a dimension.
void SetNarrowDimensionPreferences (const NXOpen::Annotations::NarrowDimensionData &narrowDimensionData)
 Sets the narrow dimension preferences to the given linear dimension.
void SetNarrowDimensionTextOffset (double narrowTextOffset)
 Sets the narrow dimension text offset for the given chain dimension.
void SetNominalDecimalPlaces (int decimalPlaces)
 Sets a setting to control the number of decimal places for the nominal value of a dimension.
void SetOriginCentered (bool isOriginCentered)
 Sets a flag indicating whether the dimension text is centered equally between the extension lines.
void SetReferenceDimensionFlag (bool referenceDimensionFlag)
 Sets a setting to control the visibility of the reference parenthesis of a dimension.
void SetToleranceDecimalPlaces (int decimalPlaces)
 Sets a setting to control the number of decimal places for the primary tolerance value of a dimension.
void SetToleranceType (NXOpen::Annotations::ToleranceType toleranceType)
 Sets a setting to control the tolerance display style.
void SetUpperMetricToleranceValue (double toleranceValue)
 Sets a setting to control the metric upper tolerance value of a dimension.
void SetUpperToleranceValue (double upperToleranceValue)
 Sets a setting to control the upper tolerance value of a dimension.
int ToleranceDecimalPlaces ()
 Returns a setting to control the number of decimal places for the primary tolerance value of a dimension.
NXOpen::Annotations::ToleranceType ToleranceType ()
 Returns a setting to control the tolerance display style.
double UpperMetricToleranceValue ()
 Returns a setting to control the metric upper tolerance value of a dimension.
double UpperToleranceValue ()
 Returns a setting to control the upper tolerance value of a dimension.

Detailed Description

Represents a dimension
Abstract class

Created in NX3.0.0.



Member Function Documentation

Returns the computed size of the dimension.


Created in NX5.0.0.

License requirements : None

Returns the appended text.

Returns:
Appended text
Created in NX4.0.0.

License requirements : None

Implements NXOpen::Annotations::IAppendedText.

Returns the dimension preferences.

Returns:
Dimenension preferences
Created in NX4.0.0.

License requirements : None
void NXOpen::Annotations::Dimension::GetDimensionText ( std::vector< NXString > &  mainTextLines,
std::vector< NXString > &  dualTextLines 
)

Returns the dimension text - both the main text and the dual text.

The returned text may contain just the computed dimension value or manual text including the control characters.
Note that the text doesn't contain the tolerance text, appended text or text for flags like inspection/reference.


Created in NX6.0.0.

License requirements : None

Parameters:
mainTextLinesList of main text lines
dualTextLinesList of dual text lines

Returns the narrow dimension preferences for the given linear dimension.

Returns:
Narrow dimension preferences
Created in NX5.0.0.

License requirements : None

Returns the narrow dimension text offset for the given chain dimension.

Returns:

Created in NX5.0.0.

License requirements : None

Returns a setting to control the inspection box displayed around the dimension value.


Created in NX5.0.0.

License requirements : None

Determines if a dimension is driving.

A driving dimension is a dimension that is used to constrain geometry created by the sketcher on a drawing. A driving dimension is also referred to as a sketch dimension.

Returns:

Created in NX6.0.0.

License requirements : None

Returns a flag indicating whether the dimension text is centered equally between the extension lines.


Created in NX5.0.0.

License requirements : None

Returns the tolerance limit fit ANSI hole type
Created in NX7.5.0.



License requirements : None

Returns the tolerance limit fit deviation
Created in NX7.5.0.



License requirements : None

Returns the tolerance limit fit display style
Created in NX7.5.0.



License requirements : None

Returns the tolerance limit fit grade
Created in NX7.5.0.



License requirements : None

Returns a setting to control the metric lower tolerance value of a dimension.


Created in NX5.0.0.

License requirements : None

Returns a setting to control the lower tolerance value of a dimension.


Created in NX5.0.0.

License requirements : None

Returns the measurement direction
Created in NX7.5.0.



License requirements : None

Returns the measurement direction view
Created in NX7.5.0.



License requirements : None

Returns a setting to control the number of decimal places for the nominal value of a metric dimension.


Created in NX5.0.0.

License requirements : None

Returns a setting to control the number of decimal places for the metric tolerance value of a dimension.


Created in NX5.0.0.

License requirements : None

Returns a setting to control the number of decimal places for the nominal value of a dimension.


Created in NX5.0.0.

License requirements : None

Returns a setting to control the visibility of the reference parenthesis of a dimension.


Created in NX5.0.0.

License requirements : None

Sets the appended text
Created in NX4.0.0.



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

Parameters:
appendedTextAppended text

Implements NXOpen::Annotations::IAppendedText.

void NXOpen::Annotations::Dimension::SetComputedSize ( double  computedSize)


Deprecated:
Deprecated in NX8.0.0.



Created in NX5.0.0.

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

Parameters:
computedSizecomputed size

Sets the dimension preferences
Created in NX4.0.0.



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

Parameters:
preferencesNew dimension preferences
void NXOpen::Annotations::Dimension::SetDimensionText ( std::vector< NXString > &  mainTextLines)

Set the main dimension text.

For a dual dimension, the dual dimension text is determined from the main dimension text
Created in NX7.5.0.

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

Parameters:
mainTextLinesList of main text lines
void NXOpen::Annotations::Dimension::SetInspectionDimensionFlag ( bool  inspectionDimensionFlag)

Sets a setting to control the inspection box displayed around the dimension value.


Created in NX5.0.0.

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

Parameters:
inspectionDimensionFlaginspection dimension flag

Sets the tolerance limit fit ANSI hole type
Created in NX7.5.0.



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

Parameters:
fitHoleTypeNew limit fit ansi hole type

Sets the tolerance limit fit deviation
Created in NX7.5.0.



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

Parameters:
fitDeviationNew limit fit deviation

Sets the tolerance limit fit display style
Created in NX7.5.0.



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

Parameters:
fitDisplayStyleNew limit fit tolerance display style

Sets the tolerance limit fit grade
Created in NX7.5.0.



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

Parameters:
fitGradeNew limit fit grade

Sets a setting to control the metric lower tolerance value of a dimension.


Created in NX5.0.0.

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

Parameters:
toleranceValuetolerance value
void NXOpen::Annotations::Dimension::SetLowerToleranceValue ( double  upperToleranceValue)

Sets a setting to control the lower tolerance value of a dimension.


Created in NX5.0.0.

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

Parameters:
upperToleranceValueupper tolerance value

Sets the measurement direction
Created in NX7.5.0.



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

Parameters:
directionDirection Object

Sets the measurement direction view
Created in NX7.5.0.



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

Parameters:
viewView Object

Sets a setting to control the number of decimal places for the nominal value of a metric dimension.


Created in NX5.0.0.

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

Parameters:
decimalPlacesdecimal places

Sets a setting to control the number of decimal places for the metric tolerance value of a dimension.


Created in NX5.0.0.

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

Parameters:
decimalPlacesdecimal places

Sets the narrow dimension preferences to the given linear dimension.


Created in NX5.0.0.

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

Parameters:
narrowDimensionDataNew narrow dimension preferences

Sets the narrow dimension text offset for the given chain dimension.


Created in NX5.0.0.

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

Parameters:
narrowTextOffsetnarrow text offset

Sets a setting to control the number of decimal places for the nominal value of a dimension.


Created in NX5.0.0.

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

Parameters:
decimalPlacesdecimal places
void NXOpen::Annotations::Dimension::SetOriginCentered ( bool  isOriginCentered)

Sets a flag indicating whether the dimension text is centered equally between the extension lines.


Created in NX5.0.0.

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

Parameters:
isOriginCenteredis origin centered
void NXOpen::Annotations::Dimension::SetReferenceDimensionFlag ( bool  referenceDimensionFlag)

Sets a setting to control the visibility of the reference parenthesis of a dimension.


Created in NX5.0.0.

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

Parameters:
referenceDimensionFlagreference dimension flag

Sets a setting to control the number of decimal places for the primary tolerance value of a dimension.


Created in NX5.0.0.

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

Parameters:
decimalPlacesdecimal places

Sets a setting to control the tolerance display style.


Created in NX5.0.0.

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

Parameters:
toleranceTypetolerance type

Sets a setting to control the metric upper tolerance value of a dimension.


Created in NX5.0.0.

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

Parameters:
toleranceValuetolerance value
void NXOpen::Annotations::Dimension::SetUpperToleranceValue ( double  upperToleranceValue)

Sets a setting to control the upper tolerance value of a dimension.


Created in NX5.0.0.

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

Parameters:
upperToleranceValueupper tolerance value

Returns a setting to control the number of decimal places for the primary tolerance value of a dimension.


Created in NX5.0.0.

License requirements : None

Returns a setting to control the tolerance display style.


Created in NX5.0.0.

License requirements : None

Returns a setting to control the metric upper tolerance value of a dimension.


Created in NX5.0.0.

License requirements : None

Returns a setting to control the upper tolerance value of a dimension.


Created in NX5.0.0.

License requirements : None


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