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

Represents a Geometric Dimensioning and Tolerancing symbol
This is an abstract class, and cannot be instantiated

Created in NX3.0.0. 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::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

bool CanChangeLeaderPositionParameter ()
 Returns a flag indicating whether the NXOpen::Annotations::Gdt::LeaderPositionParameter can be changed
Created in NX3.0.0. More...
 
virtual
NXOpen::Annotations::FcfFrameData
GetFcfFrameData ()
 Returns the single FCF frames data This is only designed to work with old feature control frames without builders. More...
 
virtual std::vector
< NXOpen::Annotations::FcfFrameData * > 
GetFcfFrameDataArray ()
 Returns the multiple FCF frames data This is only designed to work with old feature control frames without builders. More...
 
bool HasLeaderPositionParameter ()
 Returns a flag indicating whether this GDT has a leader position parameter. More...
 
bool HasStubbedDatumStyle ()
 Returns a flag indicating whether the leader has a stubbed datum style. More...
 
double LeaderPositionParameter ()
 Returns a parameter which indicates where the leader end point is located on the object that it is attached to. More...
 
virtual void SetFcfFrameData (NXOpen::Annotations::FcfFrameData *data)
 Sets the single FCF frames data. More...
 
virtual void SetFcfFrameData (const std::vector< NXOpen::Annotations::FcfFrameData * > &fcfFrameData)
 Sets the multiple FCF frames data. More...
 
void SetHasStubbedDatumStyle (bool stubbed)
 Sets a flag indicating whether the leader has a stubbed datum style. More...
 
void SetLeaderPositionParameter (double param)
 Sets a parameter which indicates where the leader end point is located on the object that it is attached to. More...
 
void SetSymbolCfw (const NXOpen::Annotations::LineCfw &cfw)
 Sets the symbol color, font, and width. More...
 
- Public Member Functions inherited from NXOpen::Annotations::SimpleDraftingAid
std::vector< NXStringGetText ()
 Returns the drafting aid's text. More...
 
NXOpen::Annotations::UserSymbolPreferencesGetUserSymbolPreferences ()
 Returns the user symbol preferences. More...
 
void GetUserSymbolSize (NXOpen::Annotations::UserSymbolPreferences::SizeType *sizeType, double *lengthOrScale, double *heightOrAspectRatio)
 Gets the user symbol size
Created in NX3.0.0. More...
 
void SetText (std::vector< NXString > &lines)
 Sets the drafting aid's text. More...
 
void SetUserSymbolPreferences (NXOpen::Annotations::UserSymbolPreferences *usymPrefs)
 Sets the user symbol preferences. More...
 
void SetUserSymbolSize (NXOpen::Annotations::UserSymbolPreferences::SizeType sizeType, double lengthOrScale, double heightOrAspectRatio)
 Sets the user symbol size. More...
 

Additional Inherited Members

- Public Types inherited from NXOpen::DisplayableObject
enum  ObjectFont {
  ObjectFontSolid = 1, ObjectFontDashed, ObjectFontPhantom, ObjectFontCenterline,
  ObjectFontDotted, ObjectFontLongDashed, ObjectFontDottedDashed
}
 specifies the object font for objects such as lines
Created in NX3.0.0. More...
 
enum  ObjectWidth {
  ObjectWidthNormal, ObjectWidthThick, ObjectWidthThin, ObjectWidthOne = 5,
  ObjectWidthTwo, ObjectWidthThree, ObjectWidthFour, ObjectWidthFive,
  ObjectWidthSix, ObjectWidthSeven, ObjectWidthEight, ObjectWidthNine
}
 specifies object width for objects such as lines and text
Created in NX3.0.0. 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

bool NXOpen::Annotations::Gdt::CanChangeLeaderPositionParameter ( )

Returns a flag indicating whether the NXOpen::Annotations::Gdt::LeaderPositionParameter can be changed
Created in NX3.0.0.



License requirements : None

virtual NXOpen::Annotations::FcfFrameData* NXOpen::Annotations::Gdt::GetFcfFrameData ( )
virtual

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.

Returns
FCF frame data
Created in NX4.0.0.

License requirements : None

Implements NXOpen::Annotations::IFcf.

virtual std::vector<NXOpen::Annotations::FcfFrameData *> NXOpen::Annotations::Gdt::GetFcfFrameDataArray ( )
virtual

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.

Returns
FCF frame datas
Created in NX5.0.0.

License requirements : None

Implements NXOpen::Annotations::IFcf.

bool NXOpen::Annotations::Gdt::HasLeaderPositionParameter ( )

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::LeaderTypePlain

NXOpen::Annotations::LeaderTypeAround

NXOpen::Annotations::LeaderTypePlainAligned

NXOpen::Annotations::LeaderTypeAroundAligned


Created in NX3.0.0.

License requirements : None

bool NXOpen::Annotations::Gdt::HasStubbedDatumStyle ( )

Returns 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::LeaderTypePlain

NXOpen::Annotations::LeaderTypeAround

NXOpen::Annotations::LeaderTypePlainAligned

NXOpen::Annotations::LeaderTypeAroundAligned

NXOpen::Annotations::LeaderTypeOnAnnotation
Do not attempt to set this property for these leader types.
Created in NX3.0.0.

License requirements : None

double NXOpen::Annotations::Gdt::LeaderPositionParameter ( )

Returns 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::LeaderTypePlain

NXOpen::Annotations::LeaderTypeAround

NXOpen::Annotations::LeaderTypePlainAligned

NXOpen::Annotations::LeaderTypeAroundAligned
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::LeaderTypePlain

NXOpen::Annotations::LeaderTypeAround

NXOpen::Annotations::LeaderTypePlainAligned

NXOpen::Annotations::LeaderTypeAroundAligned

NXOpen::Annotations::LeaderTypeOnAnnotation

NXOpen::Annotations::LeaderTypeOnStub

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 : None

virtual void NXOpen::Annotations::Gdt::SetFcfFrameData ( NXOpen::Annotations::FcfFrameData data)
virtual

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.

virtual void NXOpen::Annotations::Gdt::SetFcfFrameData ( const std::vector< NXOpen::Annotations::FcfFrameData * > &  fcfFrameData)
virtual

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.

void NXOpen::Annotations::Gdt::SetHasStubbedDatumStyle ( bool  stubbed)

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::LeaderTypePlain

NXOpen::Annotations::LeaderTypeAround

NXOpen::Annotations::LeaderTypePlainAligned

NXOpen::Annotations::LeaderTypeAroundAligned

NXOpen::Annotations::LeaderTypeOnAnnotation
Do not attempt to set this property for these leader types.
Created in NX3.0.0.

License requirements : drafting ("DRAFTING")

Parameters
stubbedstubbed
void NXOpen::Annotations::Gdt::SetLeaderPositionParameter ( double  param)

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::LeaderTypePlain

NXOpen::Annotations::LeaderTypeAround

NXOpen::Annotations::LeaderTypePlainAligned

NXOpen::Annotations::LeaderTypeAroundAligned
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::LeaderTypePlain

NXOpen::Annotations::LeaderTypeAround

NXOpen::Annotations::LeaderTypePlainAligned

NXOpen::Annotations::LeaderTypeAroundAligned

NXOpen::Annotations::LeaderTypeOnAnnotation

NXOpen::Annotations::LeaderTypeOnStub

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 : drafting ("DRAFTING")

Parameters
paramparam
void NXOpen::Annotations::Gdt::SetSymbolCfw ( const NXOpen::Annotations::LineCfw cfw)

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
cfwcfw

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