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

Represents a FcfIndicatorBuilder
To create a new instance of this class, use NXOpen::Annotations::AnnotationManager::CreateFeatureControlFrameIndicatorBuilder

Created in NX12.0.0. More...

Inheritance diagram for NXOpen::Annotations::FeatureControlFrameIndicatorBuilder:
NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Types

enum  FcfIndicatorCharacteristic { FcfIndicatorCharacteristicParallel, FcfIndicatorCharacteristicPerpendicular, FcfIndicatorCharacteristicAngular, FcfIndicatorCharacteristicIncluding }
 Specifies the characteristic of the FCF indicator. More...
 
enum  FcfIndicatorDirection { FcfIndicatorDirectionAfter, FcfIndicatorDirectionBefore }
 Specifies the direction of the FCF indicator. More...
 
enum  FcfIndicatorType { FcfIndicatorTypeIntersectionPlane, FcfIndicatorTypeOrientationPlane, FcfIndicatorTypeCollectionPlane, FcfIndicatorTypeDirectionFeature }
 Specifies the type of FCF indicator. More...
 

Public Member Functions

NXOpen::Annotations::FeatureControlFrameIndicatorBuilder::FcfIndicatorDirection Direction ()
 Returns the direction
Created in NX12.0.0. More...
 
NXOpen::Annotations::FeatureControlFrameIndicatorBuilder::FcfIndicatorType IndicatorType ()
 Returns the indicator type
Created in NX12.0.0. More...
 
NXOpen::Annotations::DatumReferenceBuilderLabel ()
 Returns the label
Created in NX12.0.0. More...
 
void SetDirection (NXOpen::Annotations::FeatureControlFrameIndicatorBuilder::FcfIndicatorDirection direction)
 Sets the direction
Created in NX12.0.0. More...
 
void SetIndicatorType (NXOpen::Annotations::FeatureControlFrameIndicatorBuilder::FcfIndicatorType indicatorType)
 Sets the indicator type
Created in NX12.0.0. More...
 
void SetSymbol (NXOpen::Annotations::FeatureControlFrameIndicatorBuilder::FcfIndicatorCharacteristic symbol)
 Sets the charactersitic
Created in NX12.0.0. More...
 
NXOpen::Annotations::FeatureControlFrameIndicatorBuilder::FcfIndicatorCharacteristic Symbol ()
 Returns the charactersitic
Created in NX12.0.0. 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 FcfIndicatorBuilder
To create a new instance of this class, use NXOpen::Annotations::AnnotationManager::CreateFeatureControlFrameIndicatorBuilder

Created in NX12.0.0.


Member Enumeration Documentation

Specifies the characteristic of the FCF indicator.

Enumerator
FcfIndicatorCharacteristicParallel 

parallel

FcfIndicatorCharacteristicPerpendicular 

perpendicular

FcfIndicatorCharacteristicAngular 

angular

FcfIndicatorCharacteristicIncluding 

including

Specifies the direction of the FCF indicator.

Enumerator
FcfIndicatorDirectionAfter 

after

FcfIndicatorDirectionBefore 

before

Specifies the type of FCF indicator.

Enumerator
FcfIndicatorTypeIntersectionPlane 

intersection plane

FcfIndicatorTypeOrientationPlane 

orientation plane

FcfIndicatorTypeCollectionPlane 

collection plane

FcfIndicatorTypeDirectionFeature 

direction feature

Member Function Documentation

NXOpen::Annotations::FeatureControlFrameIndicatorBuilder::FcfIndicatorDirection NXOpen::Annotations::FeatureControlFrameIndicatorBuilder::Direction ( )

Returns the direction
Created in NX12.0.0.



License requirements : None

NXOpen::Annotations::FeatureControlFrameIndicatorBuilder::FcfIndicatorType NXOpen::Annotations::FeatureControlFrameIndicatorBuilder::IndicatorType ( )

Returns the indicator type
Created in NX12.0.0.



License requirements : None

NXOpen::Annotations::DatumReferenceBuilder* NXOpen::Annotations::FeatureControlFrameIndicatorBuilder::Label ( )

Returns the label
Created in NX12.0.0.



License requirements : None

void NXOpen::Annotations::FeatureControlFrameIndicatorBuilder::SetDirection ( NXOpen::Annotations::FeatureControlFrameIndicatorBuilder::FcfIndicatorDirection  direction)

Sets the direction
Created in NX12.0.0.



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

Parameters
directiondirection
void NXOpen::Annotations::FeatureControlFrameIndicatorBuilder::SetIndicatorType ( NXOpen::Annotations::FeatureControlFrameIndicatorBuilder::FcfIndicatorType  indicatorType)

Sets the indicator type
Created in NX12.0.0.



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

Parameters
indicatorTypeindicatortype
void NXOpen::Annotations::FeatureControlFrameIndicatorBuilder::SetSymbol ( NXOpen::Annotations::FeatureControlFrameIndicatorBuilder::FcfIndicatorCharacteristic  symbol)

Sets the charactersitic
Created in NX12.0.0.



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

Parameters
symbolsymbol
NXOpen::Annotations::FeatureControlFrameIndicatorBuilder::FcfIndicatorCharacteristic NXOpen::Annotations::FeatureControlFrameIndicatorBuilder::Symbol ( )

Returns the charactersitic
Created in NX12.0.0.



License requirements : None

virtual bool NXOpen::Annotations::FeatureControlFrameIndicatorBuilder::Validate ( )
virtual

Validate whether the inputs to the component are sufficient for commit to be called.

If the component is not in a state to commit then an exception is thrown. For example, if the component requires you to set some property, this method will throw an exception if you haven't set it. This method throws a not-yet-implemented NXException for some components.

Returns
Was self validation successful
Created in NX3.0.1.

License requirements : None

Implements NXOpen::GeometricUtilities::IComponentBuilder.


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