Represents a datum target
To create or edit an instance of this class, use Annotations::PmiDatumTargetBuilder

Created in NX4.0.0. More...

Inheritance diagram for NXOpen::Annotations::DatumTarget:

Public Member Functions
virtual NXOpen::Annotations::AssociatedObject *	GetAssociatedObject ()
	Returns the associated object.

virtual std::vector < NXOpen::Annotations::BusinessModifier * >	GetBusinessModifiers ()
	Returns the business modifiers.

virtual NXOpen::Annotations::AssociatedObject *	GetSharedAssociatedObject ()
	Returns the shared associated objects.

virtual int	Index ()
	Returns the index.

virtual bool	IsMirrored ()
	Returns a flag indicating whether the annotation is mirrored Created in NX8.5.0.

virtual void	SetAssociatedObject (NXOpen::Annotations::AssociatedObject *assocObj)
	Sets the associated object.

virtual void	SetBusinessModifiers (const std::vector< NXOpen::Annotations::BusinessModifier * > &businessModifiers)
	Sets the business modifiers.

virtual void	SetIndex (int index)
	Sets the index.

Public Member Functions inherited from NXOpen::Annotations::DraftingDatumTarget
NXOpen::Annotations::ArbitraryTarget *	ConvertToAreaTarget ()
	Converts a datum target point, line, or non-rectangular area to a rectangular area.

NXOpen::Annotations::DraftingArbitraryTarget *	ConvertToDraftingAreaTarget ()
	Converts a drafting datum target point, line, or non-rectangular area to a drafting rectangular area.

NXOpen::Annotations::DraftingLineTarget *	ConvertToDraftingLineTarget ()
	Converts a drafting datum target point or area to a drafting datum target line.

NXOpen::Annotations::DraftingPointTarget *	ConvertToDraftingPointTarget ()
	Converts a drafting datum target line or area to a drafting datum target point.

NXOpen::Annotations::LineTarget *	ConvertToLineTarget ()
	Converts a datum target point or area to a datum target line.

NXOpen::Annotations::PointTarget *	ConvertToPointTarget ()
	Converts a datum target line or area to a datum target point.

Public Member Functions inherited from NXOpen::Annotations::BaseDatumTarget
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< NXString >	GetText ()
	Returns the drafting aid's text.

NXOpen::Annotations::UserSymbolPreferences *	GetUserSymbolPreferences ()
	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::INXObject *	FindObject (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
To create or edit an instance of this class, use Annotations::PmiDatumTargetBuilder

Created in NX4.0.0.

Member Function Documentation

virtual NXOpen::Annotations::AssociatedObject* NXOpen::Annotations::DatumTarget::GetAssociatedObject ( )

virtual

Returns the associated object.

Returns: Associated object
Created in NX4.0.0.

License requirements : None

Implements NXOpen::Annotations::IPmi.

virtual std::vector<NXOpen::Annotations::BusinessModifier *> NXOpen::Annotations::DatumTarget::GetBusinessModifiers ( )

virtual

Returns the business modifiers.

Returns: List of business modifiers
Created in NX4.0.0.

License requirements : None

Implements NXOpen::Annotations::IPmi.

virtual NXOpen::Annotations::AssociatedObject* NXOpen::Annotations::DatumTarget::GetSharedAssociatedObject ( )

virtual

Returns the shared associated objects.

Returns: Shared associated objects
Created in NX8.5.0.

License requirements : None

Implements NXOpen::Annotations::IPmi.

virtual int NXOpen::Annotations::DatumTarget::Index ( )

virtual

Returns the index.

It is a unique integer assigned to a PMI object.

      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::IPmi.

virtual bool NXOpen::Annotations::DatumTarget::IsMirrored ( )

virtual

Returns a flag indicating whether the annotation is mirrored
Created in NX8.5.0.

License requirements : None

Implements NXOpen::Annotations::IPmi.

virtual void NXOpen::Annotations::DatumTarget::SetAssociatedObject ( NXOpen::Annotations::AssociatedObject * assocObj )

virtual

Sets the associated object.

       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

assocObj New associated object

Implements NXOpen::Annotations::IPmi.

virtual void NXOpen::Annotations::DatumTarget::SetBusinessModifiers ( const std::vector< NXOpen::Annotations::BusinessModifier * > & businessModifiers )

virtual

Sets the business modifiers.

       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

businessModifiers List of new business modifiers

Implements NXOpen::Annotations::IPmi.

virtual void NXOpen::Annotations::DatumTarget::SetIndex ( int index )

virtual

Sets the index.

It is a unique integer assigned to a PMI object.

      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

index New integer for PMI object

Implements NXOpen::Annotations::IPmi.

The documentation for this class was generated from the following file:

Annotations_DatumTarget.hxx

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation