Represents a Note
This is an abstract class and cannot be directly instantiated

Created in NX6.0.0. More...

Inheritance diagram for NXOpen::Annotations::BaseNote:

Public Member Functions
virtual void	AddBusinessModifiers (const std::vector< NXOpen::Annotations::BusinessModifier * > &businessModifiers)
	Adds the business modifiers. More...

virtual NXOpen::Annotations::AssociatedObject *	GetAssociatedObject ()
	Returns the associated object. More...

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

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

virtual int	Index ()
	Returns the index. More...

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

bool	IsVertical ()
	Returns a flag indicating whether the note is vertical. More...

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

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

virtual void	SetIndex (int index)
	Sets the index. More...

void	SetVertical (bool isVertical)
	Sets a flag indicating whether the note is vertical. More...

void	UpdateFromRule ()
	Updates the specified note from the KF rule. 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 Note
This is an abstract class and cannot be directly instantiated

Created in NX6.0.0.

Member Function Documentation

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

virtual

Adds the business modifiers.

Created in NX12.0.0.

License requirements : geometric_tol ("GDT")

Parameters

businessModifiers List of new business modifiers

Implements NXOpen::Annotations::IPmi.

virtual NXOpen::Annotations::AssociatedObject* NXOpen::Annotations::BaseNote::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::BaseNote::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::BaseNote::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::BaseNote::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::BaseNote::IsMirrored ( )

virtual

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

License requirements : None

Implements NXOpen::Annotations::IPmi.

bool NXOpen::Annotations::BaseNote::IsVertical ( )

Returns a flag indicating whether the note is vertical.

When editing this, the changes are not applied to the system until an update is performed. An update can be performed by calling Update::DoUpdate .

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

void NXOpen::Annotations::BaseNote::SetVertical ( bool isVertical )

Sets a flag indicating whether the note is vertical.

When editing this, the changes are not applied to the system until an update is performed. An update can be performed by calling Update::DoUpdate .

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

isVertical is vertical

void NXOpen::Annotations::BaseNote::UpdateFromRule ( )

Updates the specified note from the KF rule.

The changes are not applied till an update is performed by calling Update::DoUpdate .

Created in NX8.0.0.

License requirements : drafting ("DRAFTING")

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

Annotations_BaseNote.hxx

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation