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

Represents an FCF
To create or edit an instance of this class, use NXOpen::Annotations::PmiFeatureControlFrameBuilder

Created in NX4.0.0. More...

Inheritance diagram for NXOpen::Annotations::Fcf:
NXOpen::Annotations::BaseFcf NXOpen::Annotations::IPmi NXOpen::Annotations::IAppendedText NXOpen::Annotations::Gdt NXOpen::INXObject NXOpen::INXObject 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

Public Member Functions

virtual void AddBusinessModifiers (const std::vector< NXOpen::Annotations::BusinessModifier * > &businessModifiers)
 Adds the business modifiers. More...
 
virtual
NXOpen::Annotations::AppendedText
GetAppendedText ()
 Returns the appended text. 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...
 
virtual void SetAppendedText (NXOpen::Annotations::AppendedText *appendedText)
 Sets the appended text
Created in NX4.0.0. 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...
 

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 an FCF
To create or edit an instance of this class, use NXOpen::Annotations::PmiFeatureControlFrameBuilder

Created in NX4.0.0.


Member Function Documentation

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

Adds the business modifiers.


Created in NX12.0.0.

License requirements : geometric_tol ("GDT")

Parameters
businessModifiersList of new business modifiers

Implements NXOpen::Annotations::IPmi.

virtual NXOpen::Annotations::AppendedText* NXOpen::Annotations::Fcf::GetAppendedText ( )
virtual

Returns the appended text.

Returns
Appended text
Created in NX4.0.0.

License requirements : None

Implements NXOpen::Annotations::IAppendedText.

virtual NXOpen::Annotations::AssociatedObject* NXOpen::Annotations::Fcf::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::Fcf::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::Fcf::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::Fcf::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::Fcf::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::Fcf::SetAppendedText ( NXOpen::Annotations::AppendedText appendedText)
virtual

Sets the appended text
Created in NX4.0.0.



License requirements : geometric_tol ("GDT") OR drafting ("DRAFTING")

Parameters
appendedTextAppended text

Implements NXOpen::Annotations::IAppendedText.

virtual void NXOpen::Annotations::Fcf::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
assocObjNew associated object

Implements NXOpen::Annotations::IPmi.

virtual void NXOpen::Annotations::Fcf::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
businessModifiersList of new business modifiers

Implements NXOpen::Annotations::IPmi.

virtual void NXOpen::Annotations::Fcf::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
indexNew integer for PMI object

Implements NXOpen::Annotations::IPmi.


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