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

Represents a datum target
This is an abstract class, and cannot be created. More...

Inheritance diagram for NXOpen::Annotations::BaseDatumTarget:
NXOpen::Annotations::Gdt NXOpen::Annotations::IDatumTarget NXOpen::Annotations::SimpleDraftingAid NXOpen::Annotations::IFcf NXOpen::INXObject NXOpen::Annotations::DraftingAid NXOpen::INXObject NXOpen::Annotations::Annotation NXOpen::DisplayableObject NXOpen::NXObject NXOpen::IFitTo NXOpen::TaggedObject NXOpen::INXObject NXOpen::INXObject NXOpen::Annotations::DraftingDatumTarget 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

virtual NXString DatumLabel ()
 Returns the datum target label.
 
virtual void SetDatumLabel (const NXString &datumLabel)
 Sets the datum target label.
 
void SetDatumLabel (const char *datumLabel)
 Sets the datum target label.
 
virtual void SetTargetIndex (int index)
 Sets the datum target index.
 
virtual int TargetIndex ()
 Returns the datum target index.
 
- Public Member Functions inherited from NXOpen::Annotations::Gdt
bool CanChangeLeaderPositionParameter ()
 Returns a flag indicating whether the Annotations::Gdt::LeaderPositionParameter can be changed
Created in NX3.0.0.
 
virtual
NXOpen::Annotations::FcfFrameData
GetFcfFrameData ()
 Returns the single FCF frames data.
 
virtual std::vector
< NXOpen::Annotations::FcfFrameData * > 
GetFcfFrameDataArray ()
 Returns the multiple FCF frames data.
 
bool HasLeaderPositionParameter ()
 Returns a flag indicating whether this GDT has a leader position parameter.
 
bool HasStubbedDatumStyle ()
 Returns a flag indicating whether the leader has a stubbed datum style.
 
double LeaderPositionParameter ()
 Returns a parameter which indicates where the leader end point is located on the object that it is attached to.
 
virtual void SetFcfFrameData (NXOpen::Annotations::FcfFrameData *data)
 Sets the single FCF frames data.
 
virtual void SetFcfFrameData (const std::vector< NXOpen::Annotations::FcfFrameData * > &fcfFrameData)
 Sets the multiple FCF frames data.
 
void SetHasStubbedDatumStyle (bool stubbed)
 Sets a flag indicating whether the leader has a stubbed datum style.
 
void SetLeaderPositionParameter (double param)
 Sets a parameter which indicates where the leader end point is located on the object that it is attached to.
 
void SetSymbolCfw (const NXOpen::Annotations::LineCfw &cfw)
 Sets the symbol color, font, and width.
 
- Public Member Functions inherited from NXOpen::Annotations::SimpleDraftingAid
std::vector< NXStringGetText ()
 Returns the drafting aid's text.
 
NXOpen::Annotations::UserSymbolPreferencesGetUserSymbolPreferences ()
 Returns the user symbol preferences.
 
void GetUserSymbolSize (NXOpen::Annotations::UserSymbolPreferences::SizeType *sizeType, double *lengthOrScale, double *heightOrAspectRatio)
 Gets the user symbol size
Created in NX3.0.0.
 
void SetText (std::vector< NXString > &lines)
 Sets the drafting aid's text.
 
void SetUserSymbolPreferences (NXOpen::Annotations::UserSymbolPreferences *usymPrefs)
 Sets the user symbol preferences.
 
void SetUserSymbolSize (NXOpen::Annotations::UserSymbolPreferences::SizeType sizeType, double lengthOrScale, double heightOrAspectRatio)
 Sets the user symbol size.
 
- Public Member Functions inherited from NXOpen::Annotations::IDatumTarget
void SetDatumLabel (const char *datumLabel)
 Sets the datum target label.
 
- Public Member Functions inherited from NXOpen::INXObject
NXOpen::INXObjectFindObject (const char *journalIdentifier)
 Finds the NXObject with the given identifier as recorded in a journal.
 
void SetName (const char *name)
 Sets the custom name of the object.
 

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 datum target
This is an abstract class, and cannot be created.



Created in NX7.5.0.

Member Function Documentation

virtual NXString NXOpen::Annotations::BaseDatumTarget::DatumLabel ( )
virtual

Returns the datum target label.

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

License requirements : None

Implements NXOpen::Annotations::IDatumTarget.

virtual void NXOpen::Annotations::BaseDatumTarget::SetDatumLabel ( const NXString datumLabel)
virtual

Sets the datum target label.

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

License requirements : geometric_tol ("GDT")

Parameters
datumLabelNew datum label

Implements NXOpen::Annotations::IDatumTarget.

void NXOpen::Annotations::BaseDatumTarget::SetDatumLabel ( const char *  datumLabel)

Sets the datum target label.

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

License requirements : geometric_tol ("GDT")

Parameters
datumLabelNew datum label
virtual void NXOpen::Annotations::BaseDatumTarget::SetTargetIndex ( int  index)
virtual

Sets the datum target index.

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

License requirements : geometric_tol ("GDT")

Parameters
indexNew datum target index

Implements NXOpen::Annotations::IDatumTarget.

virtual int NXOpen::Annotations::BaseDatumTarget::TargetIndex ( )
virtual

Returns the datum target index.

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

License requirements : None

Implements NXOpen::Annotations::IDatumTarget.


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