NXOpen .NET Reference Guide  1899
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties
Public Member Functions | Properties | List of all members
NXOpen.Annotations.Gdt Class Reference

Represents a Geometric Dimensioning and Tolerancing symbol More...

Inheritance diagram for NXOpen.Annotations.Gdt:
NXOpen.Annotations.SimpleDraftingAid NXOpen.Annotations.IFcf NXOpen.Annotations.DraftingAid NXOpen.INXObject NXOpen.Annotations.Annotation NXOpen.DisplayableObject NXOpen.NXObject NXOpen.IFitTo NXOpen.TaggedObject NXOpen.INXObject NXOpen.INXObject NXOpen.Utilities.NXRemotableObject IMessageSink NXOpen.Annotations.BaseDatum NXOpen.Annotations.BaseDatumTarget NXOpen.Annotations.BaseFcf NXOpen.Annotations.DraftingDatum NXOpen.Annotations.DraftingDatumTarget NXOpen.Annotations.DraftingFcf NXOpen.Annotations.Fcf NXOpen.Annotations.Datum NXOpen.Annotations.DatumTarget NXOpen.Annotations.DraftingArbitraryTarget NXOpen.Annotations.DraftingLineTarget NXOpen.Annotations.DraftingPointTarget NXOpen.Annotations.ArbitraryTarget NXOpen.Annotations.AreaTarget NXOpen.Annotations.LineTarget NXOpen.Annotations.PointTarget NXOpen.Annotations.CircularTarget NXOpen.Annotations.RectangularTarget

Public Member Functions

unsafe
NXOpen.Annotations.FcfFrameData 
GetFcfFrameData ()
 Returns the single FCF frames data This is only designed to work with old feature control frames without builders. More...
 
unsafe
NXOpen.Annotations.FcfFrameData[] 
GetFcfFrameDataArray ()
 Returns the multiple FCF frames data This is only designed to work with old feature control frames without builders. More...
 
unsafe void SetFcfFrameData (NXOpen.Annotations.FcfFrameData data)
 Sets the single FCF frames data. More...
 
unsafe void SetFcfFrameData (NXOpen.Annotations.FcfFrameData[] fcfFrameData)
 Sets the multiple FCF frames data. More...
 
unsafe void SetSymbolCfw (NXOpen.Annotations.LineCfw cfw)
 Sets the symbol color, font, and width. More...
 
- Public Member Functions inherited from NXOpen.Annotations.SimpleDraftingAid
unsafe string[] GetText ()
 Returns the drafting aid's text More...
 
unsafe
NXOpen.Annotations.UserSymbolPreferences 
GetUserSymbolPreferences ()
 Returns the user symbol preferences More...
 
unsafe void GetUserSymbolSize (out NXOpen.Annotations.UserSymbolPreferences.SizeType sizeType, out double lengthOrScale, out double heightOrAspectRatio)
 Gets the user symbol size More...
 
unsafe void SetText (string[] lines)
 Sets the drafting aid's text. More...
 
unsafe void SetUserSymbolPreferences (NXOpen.Annotations.UserSymbolPreferences usymPrefs)
 Sets the user symbol preferences. More...
 
unsafe void SetUserSymbolSize (NXOpen.Annotations.UserSymbolPreferences.SizeType sizeType, double lengthOrScale, double heightOrAspectRatio)
 Sets the user symbol size. More...
 

Properties

unsafe bool CanChangeLeaderPositionParameter [get]
 Returns a flag indicating whether the NXOpen.Annotations.Gdt.LeaderPositionParameter can be changed More...
 
unsafe bool HasLeaderPositionParameter [get]
 Returns a flag indicating whether this GDT has a leader position parameter. More...
 
unsafe bool HasStubbedDatumStyle [get, set]
 Returns or sets a flag indicating whether the leader has a stubbed datum style. More...
 
unsafe double LeaderPositionParameter [get, set]
 Returns or sets a parameter which indicates where the leader end point is located on the object that it is attached to. More...
 

Additional Inherited Members

- Public Types inherited from NXOpen.DisplayableObject
enum  ObjectFont {
  Solid = 1, Dashed, Phantom, Centerline,
  Dotted, LongDashed, DottedDashed, Eight = 11,
  Nine, Ten, Eleven
}
 specifies the object font for objects such as lines More...
 
enum  ObjectWidth {
  Normal, Thick, Thin, One = 5,
  Two, Three, Four, Five,
  Six, Seven, Eight, Nine
}
 specifies object width for objects such as lines and text More...
 
- Protected Member Functions inherited from NXOpen.TaggedObject
new void initialize ()
 <exclude> More...
 

Detailed Description

Represents a Geometric Dimensioning and Tolerancing symbol

This is an abstract class, and cannot be instantiated

Created in NX3.0.0

Member Function Documentation

unsafe NXOpen.Annotations.FcfFrameData NXOpen.Annotations.Gdt.GetFcfFrameData ( )
inline

Returns the single FCF frames data This is only designed to work with old feature control frames without builders.

For newer feature control frames, the builder should be used to access this data. This method will return an error.

Created in NX4.0.0

License requirements: None.

Returns
FCF frame data

Implements NXOpen.Annotations.IFcf.

unsafe NXOpen.Annotations.FcfFrameData [] NXOpen.Annotations.Gdt.GetFcfFrameDataArray ( )
inline

Returns the multiple FCF frames data This is only designed to work with old feature control frames without builders.

For newer feature control frames, the builder should be used to access this data. This method will return an error.

Created in NX5.0.0

License requirements: None.

Returns
FCF frame datas

Implements NXOpen.Annotations.IFcf.

unsafe void NXOpen.Annotations.Gdt.SetFcfFrameData ( NXOpen.Annotations.FcfFrameData  data)
inline

Sets the single FCF frames data.

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 NX4.0.0

License requirements: geometric_tol ("GDT")

Parameters
dataFCF frame data

Implements NXOpen.Annotations.IFcf.

unsafe void NXOpen.Annotations.Gdt.SetFcfFrameData ( NXOpen.Annotations.FcfFrameData[]  fcfFrameData)
inline

Sets the multiple FCF frames data.

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 NX5.0.0

License requirements: geometric_tol ("GDT")

Parameters
fcfFrameDataFCF frame datas

Implements NXOpen.Annotations.IFcf.

unsafe void NXOpen.Annotations.Gdt.SetSymbolCfw ( NXOpen.Annotations.LineCfw  cfw)
inline

Sets the symbol color, font, and width.

The changes are not applied to the system until an update is performed. An update can be performed by calling Update.DoUpdate . 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 NX3.0.0

License requirements: drafting ("DRAFTING")

Parameters
cfw

Property Documentation

unsafe bool NXOpen.Annotations.Gdt.CanChangeLeaderPositionParameter
get

Returns a flag indicating whether the NXOpen.Annotations.Gdt.LeaderPositionParameter can be changed

Created in NX3.0.0

License requirements: None.

unsafe bool NXOpen.Annotations.Gdt.HasLeaderPositionParameter
get

Returns a flag indicating whether this GDT has a leader position parameter.

GDTs with the following leader types do not have a leader position parameter:

NXOpen.Annotations.LeaderType.Plain

NXOpen.Annotations.LeaderType.Around

NXOpen.Annotations.LeaderType.PlainAligned

NXOpen.Annotations.LeaderType.AroundAligned

Created in NX3.0.0

License requirements: None.

unsafe bool NXOpen.Annotations.Gdt.HasStubbedDatumStyle
getset

Returns or sets a flag indicating whether the leader has a stubbed datum style.

This property is not applicable to GDTs with the following leader types:

NXOpen.Annotations.LeaderType.Plain

NXOpen.Annotations.LeaderType.Around

NXOpen.Annotations.LeaderType.PlainAligned

NXOpen.Annotations.LeaderType.AroundAligned

NXOpen.Annotations.LeaderType.OnAnnotation

Do not attempt to set this property for these leader types.

Created in NX3.0.0

License requirements to get this property: None.

License requirements to set this property: drafting ("DRAFTING")

unsafe double NXOpen.Annotations.Gdt.LeaderPositionParameter
getset

Returns or sets a parameter which indicates where the leader end point is located on the object that it is attached to.

0.0 indicates the start of the object that it is attached to and 1.0 indicates the end of the object. This property is not applicable to GDTs with the following leader types:

NXOpen.Annotations.LeaderType.Plain

NXOpen.Annotations.LeaderType.Around

NXOpen.Annotations.LeaderType.PlainAligned

NXOpen.Annotations.LeaderType.AroundAligned

You should not attempt to read this parameter unless NXOpen.Annotations.Gdt.HasLeaderPositionParameter is true. You should not attempt to change this parameter unless NXOpen.Annotations.Gdt.CanChangeLeaderPositionParameter returns true. This parameter cannot not set for GDTs with the following leader types:

NXOpen.Annotations.LeaderType.Plain

NXOpen.Annotations.LeaderType.Around

NXOpen.Annotations.LeaderType.PlainAligned

NXOpen.Annotations.LeaderType.AroundAligned

NXOpen.Annotations.LeaderType.OnAnnotation

NXOpen.Annotations.LeaderType.OnStub

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 NX3.0.0

License requirements to get this property: None.

License requirements to set this property: drafting ("DRAFTING")


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