NX Open C++ Reference Guide
Public Types | Public Member Functions | List of all members
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::BaseAngularDimension 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

Public Types

enum  MeasurementTypes { MeasurementTypesGeneral, MeasurementTypesDirected, MeasurementTypesFeatureOfSize }
 Specifies dimension measurement types. More...
 

Public Member Functions

double ComputedSize ()
 Returns the computed size of the dimension. More...
 
virtual
NXOpen::Annotations::AppendedText
GetAppendedText ()
 Returns the appended text. More...
 
NXOpen::Annotations::DimensionPreferencesGetDimensionPreferences ()
 Returns the dimension preferences. More...
 
void GetDimensionText (std::vector< NXString > &mainTextLines, std::vector< NXString > &dualTextLines)
 Returns the dimension text - both the main text and the dual text. More...
 
NXOpen::Annotations::AssociativityGetFirstAssociativity ()
 Returns the first associativity data. More...
 
NXOpen::Annotations::Dimension::MeasurementTypes GetMeasurementType ()
 Returns dimension measurement type. More...
 
NXOpen::Annotations::NarrowDimensionData GetNarrowDimensionPreferences ()
 Returns the narrow dimension preferences for the given linear dimension. More...
 
double GetNarrowDimensionTextOffset ()
 Returns the narrow dimension text offset for the given chain dimension. More...
 
NXOpen::Annotations::AssociativityGetSecondAssociativity ()
 Returns the second associativity data. More...
 
bool InspectionDimensionFlag ()
 Returns a setting to control the inspection box displayed around the dimension value. More...
 
bool IsApproximate ()
 Returns whether or not the given dimension is approximate. More...
 
bool IsDriving ()
 Determines if a dimension is driving. More...
 
bool IsOriginCentered ()
 Returns a flag indicating whether the dimension text is centered equally between the extension lines. More...
 
NXOpen::Annotations::FitAnsiHoleType LimitFitAnsiHoleType ()
 Returns the tolerance limit fit ANSI hole type. More...
 
NXString LimitFitDeviation ()
 Returns the tolerance limit fit deviation. More...
 
NXOpen::Annotations::FitDisplayStyle LimitFitDisplayStyle ()
 Returns the tolerance limit fit display style. More...
 
NXOpen::Annotations::FitAnsiHoleType LimitFitEnhancedDisplayType ()
 Returns the enhanced limit fit display type. More...
 
int LimitFitGrade ()
 Returns the tolerance limit fit grade. More...
 
NXString LimitFitShaftDeviation ()
 Returns the deviation for limit fit representation of shaft tolerance. More...
 
int LimitFitShaftGrade ()
 Returns the grade for limit fit representation of shaft tolerance. More...
 
double LowerMetricToleranceValue ()
 Returns a setting to control the metric lower tolerance value of a dimension. More...
 
double LowerToleranceValue ()
 Returns a setting to control the lower tolerance value of a dimension. More...
 
NXOpen::DirectionMeasurementDirection ()
 Returns the measurement direction. More...
 
NXOpen::ViewMeasurementDirectionView ()
 Returns the measurement direction view. More...
 
int MetricNominalDecimalPlaces ()
 Returns a setting to control the number of decimal places for the nominal value of a metric dimension. More...
 
int MetricToleranceDecimalPlaces ()
 Returns a setting to control the number of decimal places for the metric tolerance value of a dimension. More...
 
int NominalDecimalPlaces ()
 Returns a setting to control the number of decimal places for the nominal value of a dimension. More...
 
bool ReferenceDimensionFlag ()
 Returns a setting to control the visibility of the reference parenthesis of a dimension. More...
 
virtual void SetAppendedText (NXOpen::Annotations::AppendedText *appendedText)
 Sets the appended text
Created in NX4.0.0. More...
 
void SetComputedSize (double computedSize)
 
More...
 
void SetDimensionPreferences (NXOpen::Annotations::DimensionPreferences *preferences)
 Sets the dimension preferences
Created in NX4.0.0. More...
 
void SetDimensionText (std::vector< NXString > &mainTextLines)
 Set the main dimension text. More...
 
void SetFirstAssociativity (NXOpen::Annotations::Associativity *newAssociativity)
 Sets the first associativity data. More...
 
void SetInspectionDimensionFlag (bool inspectionDimensionFlag)
 Sets a setting to control the inspection box displayed around the dimension value. More...
 
void SetLimitFitAnsiHoleType (NXOpen::Annotations::FitAnsiHoleType fitHoleType)
 Sets the tolerance limit fit ANSI hole type. More...
 
void SetLimitFitDeviation (const NXString &fitDeviation)
 Sets the tolerance limit fit deviation. More...
 
void SetLimitFitDeviation (const char *fitDeviation)
 Sets the tolerance limit fit deviation. More...
 
void SetLimitFitDisplayStyle (NXOpen::Annotations::FitDisplayStyle fitDisplayStyle)
 Sets the tolerance limit fit display style. More...
 
void SetLimitFitEnhancedDisplayType (NXOpen::Annotations::FitAnsiHoleType fitEnhancedDisplayType)
 Sets the enhanced limit fit display type. More...
 
void SetLimitFitGrade (int fitGrade)
 Sets the tolerance limit fit grade. More...
 
void SetLimitFitShaftDeviation (const NXString &fitShaftDeviation)
 Sets the deviation for limit fit representation of shaft tolerance. More...
 
void SetLimitFitShaftDeviation (const char *fitShaftDeviation)
 Sets the deviation for limit fit representation of shaft tolerance. More...
 
void SetLimitFitShaftGrade (int fitShaftGrade)
 Sets the grade for limit fit representation of shaft tolerance. More...
 
void SetLowerMetricToleranceValue (double toleranceValue)
 Sets a setting to control the metric lower tolerance value of a dimension. More...
 
void SetLowerToleranceValue (double upperToleranceValue)
 Sets a setting to control the lower tolerance value of a dimension. More...
 
void SetMeasurementDirection (NXOpen::Direction *direction)
 Sets the measurement direction. More...
 
void SetMeasurementDirectionView (NXOpen::View *view)
 Sets the measurement direction view. More...
 
void SetMetricNominalDecimalPlaces (int decimalPlaces)
 Sets a setting to control the number of decimal places for the nominal value of a metric dimension. More...
 
void SetMetricToleranceDecimalPlaces (int decimalPlaces)
 Sets a setting to control the number of decimal places for the metric tolerance value of a dimension. More...
 
void SetNarrowDimensionPreferences (const NXOpen::Annotations::NarrowDimensionData &narrowDimensionData)
 Sets the narrow dimension preferences to the given linear dimension. More...
 
void SetNarrowDimensionTextOffset (double narrowTextOffset)
 Sets the narrow dimension text offset for the given chain dimension. More...
 
void SetNominalDecimalPlaces (int decimalPlaces)
 Sets a setting to control the number of decimal places for the nominal value of a dimension. More...
 
void SetOriginCentered (bool isOriginCentered)
 Sets a flag indicating whether the dimension text is centered equally between the extension lines. More...
 
void SetReferenceDimensionFlag (bool referenceDimensionFlag)
 Sets a setting to control the visibility of the reference parenthesis of a dimension. More...
 
void SetSecondAssociativity (NXOpen::Annotations::Associativity *newAssociativity)
 Sets the second associativity data. More...
 
void SetToleranceDecimalPlaces (int decimalPlaces)
 Sets a setting to control the number of decimal places for the primary tolerance value of a dimension. More...
 
void SetToleranceType (NXOpen::Annotations::ToleranceType toleranceType)
 Sets a setting to control the tolerance display style. More...
 
void SetUpperMetricToleranceValue (double toleranceValue)
 Sets a setting to control the metric upper tolerance value of a dimension. More...
 
void SetUpperToleranceValue (double upperToleranceValue)
 Sets a setting to control the upper tolerance value of a dimension. More...
 
double ShaftLowerToleranceValue ()
 Returns a setting to control the shaft lower tolerance value of a dimension. More...
 
double ShaftUpperToleranceValue ()
 Returns a setting to control the shaft upper tolerance value of a dimension. More...
 
int ToleranceDecimalPlaces ()
 Returns a setting to control the number of decimal places for the primary tolerance value of a dimension. More...
 
NXOpen::Annotations::ToleranceType ToleranceType ()
 Returns a setting to control the tolerance display style. More...
 
void UnretainForInconsistentSilhouette (int index)
 Unretain the dimension if it no longer has an inconsistent silhouette as the indexed associativity
Created in NX12.0.0. More...
 
double UpperMetricToleranceValue ()
 Returns a setting to control the metric upper tolerance value of a dimension. More...
 
double UpperToleranceValue ()
 Returns a setting to control the upper tolerance value of a dimension. More...
 
- Public Member Functions inherited from NXOpen::Annotations::Annotation
NXOpen::Point3d AnnotationOrigin ()
 Returns the origin (location) of the annotation. More...
 
NXOpen::XformAnnotationPlane ()
 Returns the annotation plane. More...
 
NXOpen::Annotations::Annotation::AssociativeOriginData GetAssociativeOrigin (NXOpen::Point3d *origin)
 Gets data that specifies the origin's associativity. More...
 
NXOpen::Annotations::AssociativityGetAssociativity (int associativityIndex)
 Returns the associativity at specified index. More...
 
NXOpen::XformGetInferredAnnotationPlane (NXOpen::Annotations::PmiDefaultPlane jaDefaultPlane)
 Returns the inferred annotation plane. More...
 
NXOpen::Annotations::LetteringPreferencesGetLetteringPreferences ()
 Returns the lettering preferences for the annotation. More...
 
NXOpen::Annotations::LineAndArrowPreferencesGetLineAndArrowPreferences ()
 Returns the line and arrow preferences for the annotation. More...
 
NXOpen::Annotations::SymbolPreferencesGetSymbolPreferences ()
 Returns the symbol preferences for the annotation. More...
 
std::vector< NXOpen::View * > GetViews ()
 Returns the views that the PMI display instance object is displayed in NOTE: This method is only valid for PMI display instance objects. More...
 
bool HasAssociativeOrigin ()
 Returns a flag indicating whether the origin is associative
Created in NX3.0.0. More...
 
void InsertIntoStack (NXOpen::Annotations::Annotation *stack, NXOpen::Annotations::StackAlignmentPosition position)
 Inserts the annotation into a stack. More...
 
bool IsRetained ()
 Returns a flag indicating whether the annotation is retained
Created in NX3.0.0. More...
 
NXOpen::Annotations::LeaderOrientation LeaderOrientation ()
 Returns the leader orientation for the annotation. More...
 
int NumberOfAssociativities ()
 Returns the number of associativities for the annotation. More...
 
bool ParallelToScreen ()
 Returns the PMI parallel to screen setting
Created in NX11.0.1. More...
 
void RemoveFromStack ()
 Removes the annotation from a stack. More...
 
void SetAnnotationOrigin (const NXOpen::Point3d &origin)
 Sets the origin (location) of the annotation. More...
 
void SetAnnotationPlane (NXOpen::Xform *annotationPlane)
 Sets the annotation plane. More...
 
void SetAssociativeOrigin (const NXOpen::Annotations::Annotation::AssociativeOriginData &assocOrigin, const NXOpen::Point3d &origin)
 Associates the annotation's origin to the specified geometry. More...
 
void SetAssociativity (int associativityIndex, NXOpen::Annotations::Associativity *associativity)
 Sets the associativity at specified index.The index starts from 1, and is less than or equal to the return value from NXOpen::Annotations::Annotation::NumberOfAssociativities . More...
 
void SetLeaderOrientation (NXOpen::Annotations::LeaderOrientation leaderOrientation)
 Sets the leader orientation for the annotation. More...
 
void SetLetteringPreferences (NXOpen::Annotations::LetteringPreferences *letteringPrefs)
 Sets the lettering preferences for the annotation. More...
 
void SetLineAndArrowPreferences (NXOpen::Annotations::LineAndArrowPreferences *lineArrowPrefs)
 Sets the line and arrow preferences for the annotation. More...
 
void SetParallelToScreen (bool parallelToScreen)
 Sets the PMI parallel to screen setting
Created in NX11.0.1. More...
 
void SetSymbolPreferences (NXOpen::Annotations::SymbolPreferences *symbolPrefs)
 Sets the symbol preferences for the annotation. More...
 
void SetViews (const std::vector< NXOpen::View * > &modelViews)
 Sets the views that the PMI display instance object is displayed in. More...
 
bool Suppressed ()
 Returns the flag indicating whether the annotation is suppressed
Created in NX12.0.0. More...
 
- Public Member Functions inherited from NXOpen::DisplayableObject
void Blank ()
 Blanks the object. More...
 
int Color ()
 Returns the color of the object. More...
 
void Highlight ()
 Highlights the object. More...
 
bool IsBlanked ()
 Returns the blank status of this object. More...
 
int Layer ()
 Returns the layer that the object is in. More...
 
NXOpen::DisplayableObject::ObjectFont LineFont ()
 Returns the line font of the object. More...
 
NXOpen::DisplayableObject::ObjectWidth LineWidth ()
 Returns the line width of the object. More...
 
NXOpen::Point3d NameLocation ()
 Returns the location of the object's name. More...
 
void RedisplayObject ()
 Redisplays the object in all views. More...
 
void RemoveViewDependency ()
 Remove dependency on all views from an object. More...
 
void SetColor (int color)
 Sets the color of the object. More...
 
void SetLayer (int layer)
 Sets the layer that the object is in. More...
 
void SetLineFont (NXOpen::DisplayableObject::ObjectFont font)
 Sets the line font of the object. More...
 
void SetLineWidth (NXOpen::DisplayableObject::ObjectWidth width)
 Sets the line width of the object. More...
 
void SetNameLocation (const NXOpen::Point3d &location)
 Sets the location of the object's name. More...
 
void Unblank ()
 Unblanks the object. More...
 
void Unhighlight ()
 Unhighlights the object. More...
 
- Public Member Functions inherited from NXOpen::NXObject
NXOpen::AttributeIteratorCreateAttributeIterator ()
 Create an attribute iterator. More...
 
void DeleteAllAttributesByType (NXOpen::NXObject::AttributeType type)
 Deletes all attributes of a specific type. More...
 
void DeleteAllAttributesByType (NXOpen::NXObject::AttributeType type, NXOpen::Update::Option option)
 Deletes all attributes of a specific type with the option to update or not. More...
 
void DeleteAttributeByTypeAndTitle (NXOpen::NXObject::AttributeType type, const NXString &title)
 Deletes an attribute by type and title. More...
 
void DeleteAttributeByTypeAndTitle (NXOpen::NXObject::AttributeType type, const char *title)
 Deletes an attribute by type and title. More...
 
void DeleteAttributeByTypeAndTitle (NXOpen::NXObject::AttributeType type, const NXString &title, NXOpen::Update::Option option)
 Deletes an attribute by type and title with the option to update or not. More...
 
void DeleteAttributeByTypeAndTitle (NXOpen::NXObject::AttributeType type, const char *title, NXOpen::Update::Option option)
 Deletes an attribute by type and title with the option to update or not. More...
 
void DeleteUserAttribute (NXOpen::NXObject::AttributeType type, const NXString &title, bool deleteEntireArray, NXOpen::Update::Option option)
 Deletes the first attribute encountered with the given Type, Title. More...
 
void DeleteUserAttribute (NXOpen::NXObject::AttributeType type, const char *title, bool deleteEntireArray, NXOpen::Update::Option option)
 Deletes the first attribute encountered with the given Type, Title. More...
 
void DeleteUserAttributes (NXOpen::AttributeIterator *iterator, NXOpen::Update::Option option)
 Deletes the attributes on the object, if any, that satisfy the given iterator
Created in NX8.0.0. More...
 
void DeleteUserAttributes (NXOpen::NXObject::AttributeType type, NXOpen::Update::Option option)
 Deletes the attributes encountered with the given Type with option to update or not. More...
 
virtual NXOpen::INXObjectFindObject (const NXString &journalIdentifier)
 Finds the NXOpen::NXObject with the given identifier as recorded in a journal. More...
 
virtual NXOpen::INXObjectFindObject (const char *journalIdentifier)
 Finds the NXOpen::NXObject with the given identifier as recorded in a journal. More...
 
std::vector
< NXOpen::NXObject::AttributeInformation
GetAttributeTitlesByType (NXOpen::NXObject::AttributeType type)
 Gets all the attribute titles of a specific type. More...
 
bool GetBooleanUserAttribute (const NXString &title, int index)
 Gets a boolean attribute by Title and array Index. More...
 
bool GetBooleanUserAttribute (const char *title, int index)
 Gets a boolean attribute by Title and array Index. More...
 
NXOpen::NXObject::ComputationalTime GetComputationalTimeUserAttribute (const NXString &title, int index)
 Gets a time attribute by Title and array Index. More...
 
NXOpen::NXObject::ComputationalTime GetComputationalTimeUserAttribute (const char *title, int index)
 Gets a time attribute by Title and array Index. More...
 
int GetIntegerAttribute (const NXString &title)
 Gets an integer attribute by title. More...
 
int GetIntegerAttribute (const char *title)
 Gets an integer attribute by title. More...
 
int GetIntegerUserAttribute (const NXString &title, int index)
 Gets an integer attribute by Title and array Index. More...
 
int GetIntegerUserAttribute (const char *title, int index)
 Gets an integer attribute by Title and array Index. More...
 
bool GetNextUserAttribute (NXOpen::AttributeIterator *iterator, NXOpen::NXObject::AttributeInformation *info)
 Gets the next attribute encountered on the object, if any, that satisfies the given iterator. More...
 
NXString GetPdmReferenceAttributeValue (const NXString &attributeTitle)
 Gets the value of PDM Reference attribute for given object. More...
 
NXString GetPdmReferenceAttributeValue (const char *attributeTitle)
 Gets the value of PDM Reference attribute for given object. More...
 
double GetRealAttribute (const NXString &title)
 Gets a real attribute by title. More...
 
double GetRealAttribute (const char *title)
 Gets a real attribute by title. More...
 
double GetRealUserAttribute (const NXString &title, int index)
 Gets a real attribute by Title and array Index. More...
 
double GetRealUserAttribute (const char *title, int index)
 Gets a real attribute by Title and array Index. More...
 
NXString GetReferenceAttribute (const NXString &title)
 Gets the reference string (not the calculated value) of a string attribute that uses a reference string. More...
 
NXString GetReferenceAttribute (const char *title)
 Gets the reference string (not the calculated value) of a string attribute that uses a reference string. More...
 
NXString GetStringAttribute (const NXString &title)
 Gets a string attribute value by title. More...
 
NXString GetStringAttribute (const char *title)
 Gets a string attribute value by title. More...
 
NXString GetStringUserAttribute (const NXString &title, int index)
 Gets a string attribute by Title and array Index. More...
 
NXString GetStringUserAttribute (const char *title, int index)
 Gets a string attribute by Title and array Index. More...
 
NXString GetTimeAttribute (NXOpen::NXObject::DateAndTimeFormat format, const NXString &title)
 Gets a time attribute by title. More...
 
NXString GetTimeAttribute (NXOpen::NXObject::DateAndTimeFormat format, const char *title)
 Gets a time attribute by title. More...
 
NXString GetTimeUserAttribute (const NXString &title, int index)
 Gets a time attribute by Title and array Index. More...
 
NXString GetTimeUserAttribute (const char *title, int index)
 Gets a time attribute by Title and array Index. More...
 
NXOpen::NXObject::AttributeInformation GetUserAttribute (const NXString &title, NXOpen::NXObject::AttributeType type, int index)
 Gets the first attribute encountered on the object, if any, with a given Title, Type and array Index. More...
 
NXOpen::NXObject::AttributeInformation GetUserAttribute (const char *title, NXOpen::NXObject::AttributeType type, int index)
 Gets the first attribute encountered on the object, if any, with a given Title, Type and array Index. More...
 
std::vector
< NXOpen::NXObject::AttributeInformation
GetUserAttribute (const NXString &title, bool includeUnset, bool addStringValues, NXOpen::NXObject::AttributeType type)
 Gets the first attribute (or attribute array) encountered on the object, if any, with a given Title and Type. More...
 
std::vector
< NXOpen::NXObject::AttributeInformation
GetUserAttribute (const char *title, bool includeUnset, bool addStringValues, NXOpen::NXObject::AttributeType type)
 Gets the first attribute (or attribute array) encountered on the object, if any, with a given Title and Type. More...
 
NXString GetUserAttributeAsString (const NXString &title, NXOpen::NXObject::AttributeType type, int index)
 Gets the first attribute encountered on the object, if any, with a given title, type and array index. More...
 
NXString GetUserAttributeAsString (const char *title, NXOpen::NXObject::AttributeType type, int index)
 Gets the first attribute encountered on the object, if any, with a given title, type and array index. More...
 
int GetUserAttributeCount (NXOpen::AttributeIterator *iterator)
 Gets the count of set attributes on the object, if any, that satisfy the given iterator. More...
 
int GetUserAttributeCount (NXOpen::AttributeIterator *iterator, bool countArrayAsOneAttribute)
 Gets the count of set attributes on the object, if any, that satisfy the given iterator. More...
 
int GetUserAttributeCount (NXOpen::NXObject::AttributeType type)
 Gets the count of set attributes on the object, if any, of the given type. More...
 
int GetUserAttributeCount (NXOpen::NXObject::AttributeType type, bool includeUnset, bool countArrayAsOneAttribute)
 Gets the count of attributes on the object, if any, of the given type. More...
 
bool GetUserAttributeLock (const NXString &title, NXOpen::NXObject::AttributeType type)
 Determine the lock of the given attribute. More...
 
bool GetUserAttributeLock (const char *title, NXOpen::NXObject::AttributeType type)
 Determine the lock of the given attribute. More...
 
std::vector
< NXOpen::NXObject::AttributeInformation
GetUserAttributes (NXOpen::AttributeIterator *iterator)
 Gets all the attributes that have been set on the given object, if any, that satisfy the given iterator. More...
 
std::vector
< NXOpen::NXObject::AttributeInformation
GetUserAttributes ()
 Gets all the attributes that have been set on the given object. More...
 
std::vector
< NXOpen::NXObject::AttributeInformation
GetUserAttributes (bool includeUnset)
 Gets all the attributes of the given object. More...
 
std::vector
< NXOpen::NXObject::AttributeInformation
GetUserAttributes (bool includeUnset, bool addStringValues)
 Gets all the attributes of the given object. More...
 
std::vector< NXStringGetUserAttributesAsStrings ()
 Gets all the attributes that have been set on the given object. More...
 
int GetUserAttributeSize (const NXString &title, NXOpen::NXObject::AttributeType type)
 Gets the size of the first attribute encountered on the object, if any, with a given Title and Type. More...
 
int GetUserAttributeSize (const char *title, NXOpen::NXObject::AttributeType type)
 Gets the size of the first attribute encountered on the object, if any, with a given Title and Type. More...
 
std::vector< NXOpen::NXObject * > GetUserAttributeSourceObjects ()
 Returns an array of objects from which this object presents attributes. More...
 
bool HasUserAttribute (NXOpen::AttributeIterator *iterator)
 Determines if an attribute exists on the object, that satisfies the given iterator. More...
 
bool HasUserAttribute (const NXString &title, NXOpen::NXObject::AttributeType type, int index)
 Determines if an attribute with the given Title, Type and array Index is present on the object Unset attributes will not be detected by this function, as its purpose is to test for the actual presence of the attribute on the object. More...
 
bool HasUserAttribute (const char *title, NXOpen::NXObject::AttributeType type, int index)
 Determines if an attribute with the given Title, Type and array Index is present on the object Unset attributes will not be detected by this function, as its purpose is to test for the actual presence of the attribute on the object. More...
 
virtual bool IsOccurrence ()
 Returns whether this object is an occurrence or not. More...
 
virtual NXString JournalIdentifier ()
 Returns the identifier that would be recorded in a journal for this object. More...
 
virtual NXString Name ()
 Returns the custom name of the object. More...
 
virtual
NXOpen::Assemblies::Component
OwningComponent ()
 Returns the owning component, if this object is an occurrence. More...
 
virtual NXOpen::BasePartOwningPart ()
 Returns the owning part of this object
Created in NX3.0.0. More...
 
virtual void Print ()
 Prints a representation of this object to the system log file. More...
 
virtual NXOpen::INXObjectPrototype ()
 Returns the prototype of this object if it is an occurrence. More...
 
void SetAttribute (const NXString &title, int value)
 Creates or modifies an integer attribute. More...
 
void SetAttribute (const char *title, int value)
 Creates or modifies an integer attribute. More...
 
void SetAttribute (const NXString &title, int value, NXOpen::Update::Option option)
 Creates or modifies an integer attribute with the option to update or not. More...
 
void SetAttribute (const char *title, int value, NXOpen::Update::Option option)
 Creates or modifies an integer attribute with the option to update or not. More...
 
void SetAttribute (const NXString &title, double value)
 Creates or modifies a real attribute. More...
 
void SetAttribute (const char *title, double value)
 Creates or modifies a real attribute. More...
 
void SetAttribute (const NXString &title, double value, NXOpen::Update::Option option)
 Creates or modifies a real attribute with the option to update or not. More...
 
void SetAttribute (const char *title, double value, NXOpen::Update::Option option)
 Creates or modifies a real attribute with the option to update or not. More...
 
void SetAttribute (const NXString &title, const NXString &value)
 Creates or modifies a string attribute. More...
 
void SetAttribute (const char *title, const char *value)
 Creates or modifies a string attribute. More...
 
void SetAttribute (const NXString &title, const NXString &value, NXOpen::Update::Option option)
 Creates or modifies a string attribute with the option to update or not. More...
 
void SetAttribute (const char *title, const char *value, NXOpen::Update::Option option)
 Creates or modifies a string attribute with the option to update or not. More...
 
void SetAttribute (const NXString &title)
 Creates or modifies a null attribute which is an attribute with a title and no value. More...
 
void SetAttribute (const char *title)
 Creates or modifies a null attribute which is an attribute with a title and no value. More...
 
void SetAttribute (const NXString &title, NXOpen::Update::Option option)
 Creates or modifies a null attribute with the option to update or not. More...
 
void SetAttribute (const char *title, NXOpen::Update::Option option)
 Creates or modifies a null attribute with the option to update or not. More...
 
void SetBooleanUserAttribute (const NXString &title, int index, bool value, NXOpen::Update::Option option)
 Creates or modifies a boolean attribute with the option to update or not. More...
 
void SetBooleanUserAttribute (const char *title, int index, bool value, NXOpen::Update::Option option)
 Creates or modifies a boolean attribute with the option to update or not. More...
 
virtual void SetName (const NXString &name)
 Sets the custom name of the object. More...
 
virtual void SetName (const char *name)
 Sets the custom name of the object. More...
 
void SetPdmReferenceAttribute (const NXString &attributeTitle, const NXString &attributeValue)
 Sets the value of PDM Reference attribute on the object. More...
 
void SetPdmReferenceAttribute (const char *attributeTitle, const char *attributeValue)
 Sets the value of PDM Reference attribute on the object. More...
 
void SetReferenceAttribute (const NXString &title, const NXString &value)
 Creates or modifies a string attribute which uses a reference string. More...
 
void SetReferenceAttribute (const char *title, const char *value)
 Creates or modifies a string attribute which uses a reference string. More...
 
void SetReferenceAttribute (const NXString &title, const NXString &value, NXOpen::Update::Option option)
 Creates or modifies a string attribute which uses a reference string, with the option to update or not. More...
 
void SetReferenceAttribute (const char *title, const char *value, NXOpen::Update::Option option)
 Creates or modifies a string attribute which uses a reference string, with the option to update or not. More...
 
void SetTimeAttribute (const NXString &title, const NXString &value)
 Creates or modifies a time attribute. More...
 
void SetTimeAttribute (const char *title, const char *value)
 Creates or modifies a time attribute. More...
 
void SetTimeAttribute (const NXString &title, const NXString &value, NXOpen::Update::Option option)
 Creates or modifies a time attribute with the option to update or not. More...
 
void SetTimeAttribute (const char *title, const char *value, NXOpen::Update::Option option)
 Creates or modifies a time attribute with the option to update or not. More...
 
void SetTimeUserAttribute (const NXString &title, int index, const NXString &value, NXOpen::Update::Option option)
 Creates or modifies a time attribute with the option to update or not. More...
 
void SetTimeUserAttribute (const char *title, int index, const char *value, NXOpen::Update::Option option)
 Creates or modifies a time attribute with the option to update or not. More...
 
void SetTimeUserAttribute (const NXString &title, int index, const NXOpen::NXObject::ComputationalTime &value, NXOpen::Update::Option option)
 Creates or modifies a time attribute with the option to update or not. More...
 
void SetTimeUserAttribute (const char *title, int index, const NXOpen::NXObject::ComputationalTime &value, NXOpen::Update::Option option)
 Creates or modifies a time attribute with the option to update or not. More...
 
void SetUserAttribute (const NXOpen::NXObject::AttributeInformation &info, NXOpen::Update::Option option)
 Creates or modifies an attribute with the option to update or not. More...
 
void SetUserAttribute (const NXString &title, int index, int value, NXOpen::Update::Option option)
 Creates or modifies an integer attribute with the option to update or not. More...
 
void SetUserAttribute (const char *title, int index, int value, NXOpen::Update::Option option)
 Creates or modifies an integer attribute with the option to update or not. More...
 
void SetUserAttribute (const NXString &title, int index, double value, NXOpen::Update::Option option)
 Creates or modifies a real attribute with the option to update or not. More...
 
void SetUserAttribute (const char *title, int index, double value, NXOpen::Update::Option option)
 Creates or modifies a real attribute with the option to update or not. More...
 
void SetUserAttribute (const NXString &title, int index, const NXString &value, NXOpen::Update::Option option)
 Creates or modifies a string attribute with the option to update or not. More...
 
void SetUserAttribute (const char *title, int index, const char *value, NXOpen::Update::Option option)
 Creates or modifies a string attribute with the option to update or not. More...
 
void SetUserAttribute (const NXString &title, int index, NXOpen::Update::Option option)
 Creates or modifies a null attribute with the option to update or not. More...
 
void SetUserAttribute (const char *title, int index, NXOpen::Update::Option option)
 Creates or modifies a null attribute with the option to update or not. More...
 
void SetUserAttributeLock (const NXString &title, NXOpen::NXObject::AttributeType type, bool lock)
 Lock or unlock the given attribute. More...
 
void SetUserAttributeLock (const char *title, NXOpen::NXObject::AttributeType type, bool lock)
 Lock or unlock the given attribute. More...
 
- Public Member Functions inherited from NXOpen::TaggedObject
tag_t Tag () const
 Returns the tag of this object. More...
 

Detailed Description

Represents a dimension
Abstract class

Created in NX3.0.0.


Member Enumeration Documentation

Specifies dimension measurement types.

Enumerator
MeasurementTypesGeneral 

General.

MeasurementTypesDirected 

Directed.

MeasurementTypesFeatureOfSize 

FeatureOfSize.

Member Function Documentation

double NXOpen::Annotations::Dimension::ComputedSize ( )

Returns the computed size of the dimension.


Created in NX5.0.0.

License requirements : None

virtual NXOpen::Annotations::AppendedText* NXOpen::Annotations::Dimension::GetAppendedText ( )
virtual

Returns the appended text.

Returns
Appended text
Created in NX4.0.0.

License requirements : None

Implements NXOpen::Annotations::IAppendedText.

NXOpen::Annotations::DimensionPreferences* NXOpen::Annotations::Dimension::GetDimensionPreferences ( )

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
NXOpen::Annotations::Associativity* NXOpen::Annotations::Dimension::GetFirstAssociativity ( )

Returns the first associativity data.

Returns

Created in NX5.0.0.

License requirements : None
NXOpen::Annotations::Dimension::MeasurementTypes NXOpen::Annotations::Dimension::GetMeasurementType ( )

Returns dimension measurement type.

Returns
Dimension Measurement Type.
Created in NX10.0.0.

License requirements : None
NXOpen::Annotations::NarrowDimensionData NXOpen::Annotations::Dimension::GetNarrowDimensionPreferences ( )

Returns the narrow dimension preferences for the given linear dimension.

Returns
Narrow dimension preferences
Created in NX5.0.0.

License requirements : None
double NXOpen::Annotations::Dimension::GetNarrowDimensionTextOffset ( )

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

Returns

Created in NX5.0.0.

License requirements : None
NXOpen::Annotations::Associativity* NXOpen::Annotations::Dimension::GetSecondAssociativity ( )

Returns the second associativity data.

Returns

Created in NX5.0.0.

License requirements : None
bool NXOpen::Annotations::Dimension::InspectionDimensionFlag ( )

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

NOTE: The set method should not be used to edit a read-only object such as a Mirrored PMI object. If it is, the changes will be overridden when the part is updated.
Created in NX5.0.0.

License requirements : None

bool NXOpen::Annotations::Dimension::IsApproximate ( )

Returns whether or not the given dimension is approximate.

A dimension is approximate if it is attached to lightweight view geometry that doesn't have exact data.

Returns
TRUE, if dimension is approximate. FALSE, if dimension is not approximate.
Created in NX9.0.0.

License requirements : None
bool NXOpen::Annotations::Dimension::IsDriving ( )

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
bool NXOpen::Annotations::Dimension::IsOriginCentered ( )

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

NOTE: The set method should not be used to edit a read-only object such as a Mirrored PMI object. If it is, the changes will be overridden when the part is updated.


Created in NX5.0.0.

License requirements : None

NXOpen::Annotations::FitAnsiHoleType NXOpen::Annotations::Dimension::LimitFitAnsiHoleType ( )

Returns the tolerance limit fit ANSI hole type.

NOTE: The set method should not be used to edit a read-only object such as a Mirrored PMI object. If it is, the changes will be overridden when the part is updated.
Created in NX7.5.0.

License requirements : None

NXString NXOpen::Annotations::Dimension::LimitFitDeviation ( )

Returns the tolerance limit fit deviation.

NOTE: The set method should not be used to edit a read-only object such as a Mirrored PMI object. If it is, the changes will be overridden when the part is updated.
Created in NX7.5.0.

License requirements : None

NXOpen::Annotations::FitDisplayStyle NXOpen::Annotations::Dimension::LimitFitDisplayStyle ( )

Returns the tolerance limit fit display style.

NOTE: The set method should not be used to edit a read-only object such as a Mirrored PMI object. If it is, the changes will be overridden when the part is updated.
Created in NX7.5.0.

License requirements : None

NXOpen::Annotations::FitAnsiHoleType NXOpen::Annotations::Dimension::LimitFitEnhancedDisplayType ( )

Returns the enhanced limit fit display type.

Used to determine if the tolerance representation is for hole, shaft, or fit tolerance (fit meaning both hole and shaft tolerances are displayed).

NOTE: The set method should not be used to edit a read-only object such as a Mirrored PMI object. If it is, the changes will be overridden when the part is updated.
Created in NX9.0.0.

License requirements : None

int NXOpen::Annotations::Dimension::LimitFitGrade ( )

Returns the tolerance limit fit grade.

NOTE: The set method should not be used to edit a read-only object such as a Mirrored PMI object. If it is, the changes will be overridden when the part is updated.
Created in NX7.5.0.

License requirements : None

NXString NXOpen::Annotations::Dimension::LimitFitShaftDeviation ( )

Returns the deviation for limit fit representation of shaft tolerance.

NOTE: The set method should not be used to edit a read-only object such as a Mirrored PMI object. If it is, the changes will be overridden when the part is updated.
Created in NX9.0.0.

License requirements : None

int NXOpen::Annotations::Dimension::LimitFitShaftGrade ( )

Returns the grade for limit fit representation of shaft tolerance.

NOTE: The set method should not be used to edit a read-only object such as a Mirrored PMI object. If it is, the changes will be overridden when the part is updated.
Created in NX9.0.0.

License requirements : None

double NXOpen::Annotations::Dimension::LowerMetricToleranceValue ( )

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

If the dimension is displayed with equal bilateral tolerance type, the lower tolerance value is ignored and this method will return the default tolerance value.

If the dimension is displayed with unilateral plus tolerance type, the lower tolerance value is ignored and this method will return the default tolerance value.

NOTE: The set method should not be used to edit a read-only object such as a Mirrored PMI object. If it is, the changes will be overridden when the part is updated.
Created in NX5.0.0.

License requirements : None

double NXOpen::Annotations::Dimension::LowerToleranceValue ( )

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

If the dimension is displayed with equal bilateral tolerance type, the lower tolerance value is ignored and this method will return the default tolerance value.

If the dimension is displayed with unilateral plus tolerance type, the lower tolerance value is ignored and this method will return the default tolerance value.

NOTE: The set method should not be used to edit a read-only object such as a Mirrored PMI object. If it is, the changes will be overridden when the part is updated.
Created in NX5.0.0.

License requirements : None

NXOpen::Direction* NXOpen::Annotations::Dimension::MeasurementDirection ( )

Returns the measurement direction.

NOTE: The set method should not be used to edit a read-only object such as a Mirrored PMI object. If it is, the changes will be overridden when the part is updated.
Created in NX7.5.0.

License requirements : None

NXOpen::View* NXOpen::Annotations::Dimension::MeasurementDirectionView ( )

Returns the measurement direction view.

NOTE: This method should not be used to edit a read-only object such as a Mirrored PMI object. If it is, the changes will be overridden when the part is updated.
Created in NX7.5.0.

License requirements : None

int NXOpen::Annotations::Dimension::MetricNominalDecimalPlaces ( )

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

NOTE: The set method should not be used to edit a read-only object such as a Mirrored PMI object. If it is, the changes will be overridden when the part is updated.
Created in NX5.0.0.

License requirements : None

int NXOpen::Annotations::Dimension::MetricToleranceDecimalPlaces ( )

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

NOTE: The set method should not be used to edit a read-only object such as a Mirrored PMI object. If it is, the changes will be overridden when the part is updated.
Created in NX5.0.0.

License requirements : None

int NXOpen::Annotations::Dimension::NominalDecimalPlaces ( )

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

NOTE: The set method should not be used to edit a read-only object such as a Mirrored PMI object. If it is, the changes will be overridden when the part is updated.
Created in NX5.0.0.

License requirements : None

bool NXOpen::Annotations::Dimension::ReferenceDimensionFlag ( )

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

NOTE: The set method should not be used to edit a read-only object such as a Mirrored PMI object. If it is, the changes will be overridden when the part is updated.
Created in NX5.0.0.

License requirements : None

virtual void NXOpen::Annotations::Dimension::SetAppendedText ( NXOpen::Annotations::AppendedText appendedText)
virtual

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.

Use NXOpen::Annotations::Dimension::SetDimensionText instead.


Created in NX5.0.0.

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

Parameters
computedSizecomputed size
void NXOpen::Annotations::Dimension::SetDimensionPreferences ( NXOpen::Annotations::DimensionPreferences preferences)

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.

If the dimension is manual non-numerical text dimension and it has dual dimension, the dual dimension text will also be set with the same text as the main text.


Created in NX7.5.0.

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

Parameters
mainTextLinesList of main text lines
void NXOpen::Annotations::Dimension::SetFirstAssociativity ( NXOpen::Annotations::Associativity newAssociativity)

Sets the first associativity data.


Created in NX5.0.0.

License requirements : None

Parameters
newAssociativitynew associativity
void NXOpen::Annotations::Dimension::SetInspectionDimensionFlag ( bool  inspectionDimensionFlag)

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

NOTE: The set method should not be used to edit a read-only object such as a Mirrored PMI object. If it is, the changes will be overridden when the part is updated.
Created in NX5.0.0.

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

Parameters
inspectionDimensionFlaginspection dimension flag
void NXOpen::Annotations::Dimension::SetLimitFitAnsiHoleType ( NXOpen::Annotations::FitAnsiHoleType  fitHoleType)

Sets the tolerance limit fit ANSI hole type.

NOTE: The set method should not be used to edit a read-only object such as a Mirrored PMI object. If it is, the changes will be overridden when the part is updated.
Created in NX7.5.0.

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

Parameters
fitHoleTypeNew limit fit ANSI hole type
void NXOpen::Annotations::Dimension::SetLimitFitDeviation ( const NXString fitDeviation)

Sets the tolerance limit fit deviation.

NOTE: The set method should not be used to edit a read-only object such as a Mirrored PMI object. If it is, the changes will be overridden when the part is updated.
Created in NX7.5.0.

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

Parameters
fitDeviationNew limit fit deviation
void NXOpen::Annotations::Dimension::SetLimitFitDeviation ( const char *  fitDeviation)

Sets the tolerance limit fit deviation.

NOTE: The set method should not be used to edit a read-only object such as a Mirrored PMI object. If it is, the changes will be overridden when the part is updated.
Created in NX7.5.0.

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

Parameters
fitDeviationNew limit fit deviation
void NXOpen::Annotations::Dimension::SetLimitFitDisplayStyle ( NXOpen::Annotations::FitDisplayStyle  fitDisplayStyle)

Sets the tolerance limit fit display style.

NOTE: The set method should not be used to edit a read-only object such as a Mirrored PMI object. If it is, the changes will be overridden when the part is updated.
Created in NX7.5.0.

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

Parameters
fitDisplayStyleNew limit fit tolerance display style
void NXOpen::Annotations::Dimension::SetLimitFitEnhancedDisplayType ( NXOpen::Annotations::FitAnsiHoleType  fitEnhancedDisplayType)

Sets the enhanced limit fit display type.

Used to determine if the tolerance representation is for hole, shaft, or fit tolerance (fit meaning both hole and shaft tolerances are displayed).

NOTE: The set method should not be used to edit a read-only object such as a Mirrored PMI object. If it is, the changes will be overridden when the part is updated.
Created in NX9.0.0.

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

Parameters
fitEnhancedDisplayTypeNew limit fit enhanced tolerance display style
void NXOpen::Annotations::Dimension::SetLimitFitGrade ( int  fitGrade)

Sets the tolerance limit fit grade.

NOTE: The set method should not be used to edit a read-only object such as a Mirrored PMI object. If it is, the changes will be overridden when the part is updated.
Created in NX7.5.0.

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

Parameters
fitGradeNew limit fit grade
void NXOpen::Annotations::Dimension::SetLimitFitShaftDeviation ( const NXString fitShaftDeviation)

Sets the deviation for limit fit representation of shaft tolerance.

NOTE: The set method should not be used to edit a read-only object such as a Mirrored PMI object. If it is, the changes will be overridden when the part is updated.
Created in NX9.0.0.

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

Parameters
fitShaftDeviationNew limit fit shaft deviation
void NXOpen::Annotations::Dimension::SetLimitFitShaftDeviation ( const char *  fitShaftDeviation)

Sets the deviation for limit fit representation of shaft tolerance.

NOTE: The set method should not be used to edit a read-only object such as a Mirrored PMI object. If it is, the changes will be overridden when the part is updated.
Created in NX9.0.0.

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

Parameters
fitShaftDeviationNew limit fit shaft deviation
void NXOpen::Annotations::Dimension::SetLimitFitShaftGrade ( int  fitShaftGrade)

Sets the grade for limit fit representation of shaft tolerance.

NOTE: The set method should not be used to edit a read-only object such as a Mirrored PMI object. If it is, the changes will be overridden when the part is updated.
Created in NX9.0.0.

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

Parameters
fitShaftGradeNew limit fit shaft grade
void NXOpen::Annotations::Dimension::SetLowerMetricToleranceValue ( double  toleranceValue)

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

If the dimension is displayed with equal bilateral tolerance type, the lower tolerance value is ignored and this method will return the default tolerance value.

If the dimension is displayed with unilateral plus tolerance type, the lower tolerance value is ignored and this method will return the default tolerance value.

NOTE: The set method should not be used to edit a read-only object such as a Mirrored PMI object. If it is, the changes will be overridden when the part is updated.
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.

If the dimension is displayed with equal bilateral tolerance type, the lower tolerance value is ignored and this method will return the default tolerance value.

If the dimension is displayed with unilateral plus tolerance type, the lower tolerance value is ignored and this method will return the default tolerance value.

NOTE: The set method should not be used to edit a read-only object such as a Mirrored PMI object. If it is, the changes will be overridden when the part is updated.
Created in NX5.0.0.

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

Parameters
upperToleranceValueupper tolerance value
void NXOpen::Annotations::Dimension::SetMeasurementDirection ( NXOpen::Direction direction)

Sets the measurement direction.

NOTE: The set method should not be used to edit a read-only object such as a Mirrored PMI object. If it is, the changes will be overridden when the part is updated.
Created in NX7.5.0.

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

Parameters
directionDirection Object
void NXOpen::Annotations::Dimension::SetMeasurementDirectionView ( NXOpen::View view)

Sets the measurement direction view.

NOTE: This method should not be used to edit a read-only object such as a Mirrored PMI object. If it is, the changes will be overridden when the part is updated.
Created in NX7.5.0.

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

Parameters
viewView Object
void NXOpen::Annotations::Dimension::SetMetricNominalDecimalPlaces ( int  decimalPlaces)

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

NOTE: The set method should not be used to edit a read-only object such as a Mirrored PMI object. If it is, the changes will be overridden when the part is updated.
Created in NX5.0.0.

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

Parameters
decimalPlacesdecimal places
void NXOpen::Annotations::Dimension::SetMetricToleranceDecimalPlaces ( int  decimalPlaces)

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

NOTE: The set method should not be used to edit a read-only object such as a Mirrored PMI object. If it is, the changes will be overridden when the part is updated.
Created in NX5.0.0.

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

Parameters
decimalPlacesdecimal places
void NXOpen::Annotations::Dimension::SetNarrowDimensionPreferences ( const NXOpen::Annotations::NarrowDimensionData narrowDimensionData)

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
void NXOpen::Annotations::Dimension::SetNarrowDimensionTextOffset ( double  narrowTextOffset)

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
void NXOpen::Annotations::Dimension::SetNominalDecimalPlaces ( int  decimalPlaces)

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

NOTE: The set method should not be used to edit a read-only object such as a Mirrored PMI object. If it is, the changes will be overridden when the part is updated.
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.

NOTE: The set method should not be used to edit a read-only object such as a Mirrored PMI object. If it is, the changes will be overridden when the part is updated.


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.

NOTE: The set method should not be used to edit a read-only object such as a Mirrored PMI object. If it is, the changes will be overridden when the part is updated.
Created in NX5.0.0.

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

Parameters
referenceDimensionFlagreference dimension flag
void NXOpen::Annotations::Dimension::SetSecondAssociativity ( NXOpen::Annotations::Associativity newAssociativity)

Sets the second associativity data.


Created in NX5.0.0.

License requirements : None

Parameters
newAssociativitynew associativity
void NXOpen::Annotations::Dimension::SetToleranceDecimalPlaces ( int  decimalPlaces)

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

NOTE: The set method should not be used to edit a read-only object such as a Mirrored PMI object. If it is, the changes will be overridden when the part is updated.
Created in NX5.0.0.

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

Parameters
decimalPlacesdecimal places
void NXOpen::Annotations::Dimension::SetToleranceType ( NXOpen::Annotations::ToleranceType  toleranceType)

Sets a setting to control the tolerance display style.

NOTE: The set method should not be used to edit a read-only object such as a Mirrored PMI object. If it is, the changes will be overridden when the part is updated.
Created in NX5.0.0.

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

Parameters
toleranceTypetolerance type
void NXOpen::Annotations::Dimension::SetUpperMetricToleranceValue ( double  toleranceValue)

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

If the dimension is displayed with unilateral minus tolerance type, the upper tolerance value is ignored and this method will return the default tolerance value.

NOTE: The set method should not be used to edit a read-only object such as a Mirrored PMI object. If it is, the changes will be overridden when the part is updated.
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.

If the dimension is displayed with unilateral minus tolerance type, the upper tolerance value is ignored and this method will return the default tolerance value.

NOTE: The set method should not be used to edit a read-only object such as a Mirrored PMI object. If it is, the changes will be overridden when the part is updated.
Created in NX5.0.0.

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

Parameters
upperToleranceValueupper tolerance value
double NXOpen::Annotations::Dimension::ShaftLowerToleranceValue ( )

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


Created in NX10.0.1.

License requirements : None

double NXOpen::Annotations::Dimension::ShaftUpperToleranceValue ( )

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


Created in NX10.0.1.

License requirements : None

int NXOpen::Annotations::Dimension::ToleranceDecimalPlaces ( )

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

NOTE: The set method should not be used to edit a read-only object such as a Mirrored PMI object. If it is, the changes will be overridden when the part is updated.
Created in NX5.0.0.

License requirements : None

NXOpen::Annotations::ToleranceType NXOpen::Annotations::Dimension::ToleranceType ( )

Returns a setting to control the tolerance display style.

NOTE: The set method should not be used to edit a read-only object such as a Mirrored PMI object. If it is, the changes will be overridden when the part is updated.
Created in NX5.0.0.

License requirements : None

void NXOpen::Annotations::Dimension::UnretainForInconsistentSilhouette ( int  index)

Unretain the dimension if it no longer has an inconsistent silhouette as the indexed associativity
Created in NX12.0.0.



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

Parameters
indexindex
double NXOpen::Annotations::Dimension::UpperMetricToleranceValue ( )

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

If the dimension is displayed with unilateral minus tolerance type, the upper tolerance value is ignored and this method will return the default tolerance value.

NOTE: The set method should not be used to edit a read-only object such as a Mirrored PMI object. If it is, the changes will be overridden when the part is updated.
Created in NX5.0.0.

License requirements : None

double NXOpen::Annotations::Dimension::UpperToleranceValue ( )

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

If the dimension is displayed with unilateral minus tolerance type, the upper tolerance value is ignored and this method will return the default tolerance value.

NOTE: The set method should not be used to edit a read-only object such as a Mirrored PMI object. If it is, the changes will be overridden when the part is updated.
Created in NX5.0.0.

License requirements : None


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