NX Open C++ Reference Guide
Public Member Functions
NXOpen::Annotations::BaseNote Class Reference

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:
NXOpen::Annotations::NoteBase NXOpen::Annotations::IPmi NXOpen::Annotations::SimpleDraftingAid NXOpen::INXObject NXOpen::Annotations::DraftingAid NXOpen::Annotations::Annotation NXOpen::DisplayableObject NXOpen::NXObject NXOpen::IFitTo NXOpen::TaggedObject NXOpen::INXObject NXOpen::INXObject NXOpen::Annotations::GenericNote NXOpen::Annotations::Note NXOpen::Annotations::PmiNote

List of all members.

Public Member Functions

virtual
NXOpen::Annotations::AssociatedObject
GetAssociatedObject ()
 Returns the associated object.
virtual std::vector
< NXOpen::Annotations::BusinessModifier * > 
GetBusinessModifiers ()
 Returns the business modifiers.
virtual int Index ()
 Returns the index.
bool IsVertical ()
 Returns a flag indicating whether the note is vertical.
virtual void SetAssociatedObject (NXOpen::Annotations::AssociatedObject *assocObj)
 Sets the associated object
Created in NX4.0.0.
virtual void SetBusinessModifiers (const std::vector< NXOpen::Annotations::BusinessModifier * > &businessModifiers)
 Sets the business modifiers
Created in NX4.0.0.
virtual void SetIndex (int index)
 Sets the index.
void SetVertical (bool isVertical)
 Sets a flag indicating whether the note is vertical.
void UpdateFromRule ()
 Updates the specified note from the KF rule.

Detailed Description

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

Created in NX6.0.0.



Member Function Documentation

Returns the associated object.

Returns:
Associated object
Created in NX4.0.0.

License requirements : None

Implements NXOpen::Annotations::IPmi.

Returns the business modifiers.

Returns:
List of business modifiers
Created in NX4.0.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.
Created in NX4.0.0.

License requirements : None

Implements NXOpen::Annotations::IPmi.

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 .


Created in NX3.0.0.

License requirements : None

Sets the associated object
Created in NX4.0.0.



License requirements : geometric_tol ("GDT")

Parameters:
assocObjNew associated object

Implements NXOpen::Annotations::IPmi.

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

Sets the business modifiers
Created in NX4.0.0.



License requirements : geometric_tol ("GDT")

Parameters:
businessModifiersList 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.
Created in NX4.0.0.

License requirements : geometric_tol ("GDT")

Parameters:
indexNew 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 .


Created in NX3.0.0.

License requirements : drafting ("DRAFTING")

Parameters:
isVerticalis vertical

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:
Copyright 2011 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.