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

Represents a NXOpen::Annotations::FeatureControlFrameBuilder
This is an abstract class, and cannot be instantiated. More...

Inheritance diagram for NXOpen::Annotations::FeatureControlFrameBuilder:
NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder NXOpen::Annotations::DraftingFeatureControlFrameBuilder NXOpen::Annotations::PmiFeatureControlFrameBuilder

Public Types

enum  FcfCharacteristic {
  FcfCharacteristicStraightness, FcfCharacteristicFlatness, FcfCharacteristicCircularity, FcfCharacteristicCylindricity,
  FcfCharacteristicProfileOfALine, FcfCharacteristicProfileOfASurface, FcfCharacteristicAngularity, FcfCharacteristicPerpendicularity,
  FcfCharacteristicParallelism, FcfCharacteristicPosition, FcfCharacteristicConcentricity, FcfCharacteristicSymmetry,
  FcfCharacteristicCircularRunout, FcfCharacteristicTotalRunout, FcfCharacteristicAxisIntersection
}
 Specifies the characteristitic of the feature control frame. More...
 
enum  FcfFrameStyle { FcfFrameStyleSingleFrame, FcfFrameStyleCompositeFrame }
 Specifies whether the feature control frame is a single frame or composite. More...
 

Public Member Functions

NXOpen::Annotations::FeatureControlFrameBuilder::FcfCharacteristic Characteristic ()
 Returns the characteristic
Created in NX6.0.0. More...
 
void FeatureControlFrameData (std::vector< NXOpen::Annotations::FeatureControlFrameDataBuilder * > &featureControlFrameDataBuilders)
 The feature control frame data list. More...
 
NXOpen::Annotations::FeatureControlFrameDataBuilderListFeatureControlFrameDataList ()
 Returns the feature control frame data list. More...
 
NXOpen::Annotations::FeatureControlFrameBuilder::FcfFrameStyle FrameStyle ()
 Returns the frame style
Created in NX6.0.0. More...
 
void InheritFrom (NXOpen::Annotations::BaseFcf *inheritTag)
 The feature control frame is inherited form existing feature control frame. More...
 
NXOpen::Annotations::LeaderBuilderLeader ()
 Returns the NXOpen::Annotations::LeaderBuilder for the annotation
Created in NX6.0.0. More...
 
NXOpen::Annotations::OriginBuilderOrigin ()
 Returns the NXOpen::Annotations::OriginBuilder for the annotation
Created in NX6.0.0. More...
 
void SetCharacteristic (NXOpen::Annotations::FeatureControlFrameBuilder::FcfCharacteristic characteristic)
 Sets the characteristic
Created in NX6.0.0. More...
 
void SetFrameStyle (NXOpen::Annotations::FeatureControlFrameBuilder::FcfFrameStyle frameStyle)
 Sets the frame style
Created in NX6.0.0. More...
 
NXOpen::Annotations::StyleBuilderStyle ()
 Returns the style
Created in NX6.0.0. More...
 
NXOpen::Annotations::TextWithSymbolsBuilderText ()
 Returns the text
Created in NX6.0.0. More...
 
- Public Member Functions inherited from NXOpen::Builder
NXOpen::NXObjectCommit ()
 Commits any edits that have been applied to the builder. More...
 
void Destroy ()
 Deletes the builder, and cleans up any objects created by the builder. More...
 
std::vector< NXOpen::NXObject * > GetCommittedObjects ()
 For builders that create more than one object, this method returns the objects that are created by commit. More...
 
NXOpen::NXObjectGetObject ()
 Returns the object currently being edited by this builder. More...
 
void ShowResults ()
 Updates the model to reflect the result of an edit to the model for all builders that support showing results. More...
 
virtual bool Validate ()
 Validate whether the inputs to the component are sufficient for commit to be called. More...
 
- Public Member Functions inherited from NXOpen::TaggedObject
tag_t Tag () const
 Returns the tag of this object. More...
 

Detailed Description

Represents a NXOpen::Annotations::FeatureControlFrameBuilder
This is an abstract class, and cannot be instantiated.


Default values.

Property Value

Text.CustomSymbolScale

1.0

Text.SymbolAspectRatio

1.0

Text.SymbolHeight

25.4 (millimeters part), 1.0 (inches part)

Text.SymbolLength

25.4 (millimeters part), 1.0 (inches part)

Text.SymbolPreferences

UseCurrent

Text.SymbolScale

1.0

Text.SymbolSizeMethod

ScaleAndAspectRatio


Created in NX6.0.0.

Member Enumeration Documentation

Specifies the characteristitic of the feature control frame.

Enumerator
FcfCharacteristicStraightness 

straightness

FcfCharacteristicFlatness 

flatness

FcfCharacteristicCircularity 

circularity

FcfCharacteristicCylindricity 

cylindricity

FcfCharacteristicProfileOfALine 

profile of a line

FcfCharacteristicProfileOfASurface 

profile of a sufrace

FcfCharacteristicAngularity 

angularity

FcfCharacteristicPerpendicularity 

perpendicularity

FcfCharacteristicParallelism 

parallelism

FcfCharacteristicPosition 

position

FcfCharacteristicConcentricity 

concentricity

FcfCharacteristicSymmetry 

symmetry

FcfCharacteristicCircularRunout 

circular runout

FcfCharacteristicTotalRunout 

total runout

FcfCharacteristicAxisIntersection 

axis intersection

Specifies whether the feature control frame is a single frame or composite.

Enumerator
FcfFrameStyleSingleFrame 

single frame

FcfFrameStyleCompositeFrame 

composite frame

Member Function Documentation

NXOpen::Annotations::FeatureControlFrameBuilder::FcfCharacteristic NXOpen::Annotations::FeatureControlFrameBuilder::Characteristic ( )

Returns the characteristic
Created in NX6.0.0.



License requirements : None

void NXOpen::Annotations::FeatureControlFrameBuilder::FeatureControlFrameData ( std::vector< NXOpen::Annotations::FeatureControlFrameDataBuilder * > &  featureControlFrameDataBuilders)

The feature control frame data list.

this method will always return at least two frames. for single feature control frames (frame type is single frame type) only the first frame is used.
Created in NX6.0.0.

License requirements : None

Parameters
featureControlFrameDataBuildersfeature control frame data builders
NXOpen::Annotations::FeatureControlFrameDataBuilderList* NXOpen::Annotations::FeatureControlFrameBuilder::FeatureControlFrameDataList ( )

Returns the feature control frame data list.

this method will always return at least two frames. for single feature control frames (frame type is single frame type) only the first frame is used.
Created in NX6.0.0.

License requirements : None

NXOpen::Annotations::FeatureControlFrameBuilder::FcfFrameStyle NXOpen::Annotations::FeatureControlFrameBuilder::FrameStyle ( )

Returns the frame style
Created in NX6.0.0.



License requirements : None

void NXOpen::Annotations::FeatureControlFrameBuilder::InheritFrom ( NXOpen::Annotations::BaseFcf inheritTag)

The feature control frame is inherited form existing feature control frame.


Created in NX8.5.0.

License requirements : None

Parameters
inheritTaginherittag
NXOpen::Annotations::LeaderBuilder* NXOpen::Annotations::FeatureControlFrameBuilder::Leader ( )

Returns the NXOpen::Annotations::LeaderBuilder for the annotation
Created in NX6.0.0.



License requirements : None

NXOpen::Annotations::OriginBuilder* NXOpen::Annotations::FeatureControlFrameBuilder::Origin ( )

Returns the NXOpen::Annotations::OriginBuilder for the annotation
Created in NX6.0.0.



License requirements : None

void NXOpen::Annotations::FeatureControlFrameBuilder::SetCharacteristic ( NXOpen::Annotations::FeatureControlFrameBuilder::FcfCharacteristic  characteristic)

Sets the characteristic
Created in NX6.0.0.



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

Parameters
characteristiccharacteristic
void NXOpen::Annotations::FeatureControlFrameBuilder::SetFrameStyle ( NXOpen::Annotations::FeatureControlFrameBuilder::FcfFrameStyle  frameStyle)

Sets the frame style
Created in NX6.0.0.



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

Parameters
frameStyleframestyle
NXOpen::Annotations::StyleBuilder* NXOpen::Annotations::FeatureControlFrameBuilder::Style ( )

Returns the style
Created in NX6.0.0.



License requirements : None

NXOpen::Annotations::TextWithSymbolsBuilder* NXOpen::Annotations::FeatureControlFrameBuilder::Text ( )

Returns the text
Created in NX6.0.0.



License requirements : None


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