NX Open C++ Reference Guide
Public Types | Public Member Functions
NXOpen::Annotations::FeatureControlFrameDataBuilder Class Reference

Represents a FeatureControlFrameDataBuilder. More...

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

List of all members.

Public Types

enum  AreaSymbolType { AreaSymbolTypeRectangular, AreaSymbolTypeCircular, AreaSymbolTypeSpherical, AreaSymbolTypeSquare }
 Specifies the unit type. More...
enum  ToleranceMaterialModifier { ToleranceMaterialModifierNone, ToleranceMaterialModifierLeastMaterialCondition, ToleranceMaterialModifierMaximumMaterialCondition, ToleranceMaterialModifierRegardlessOfFeatureSize }
 Specifies the tolerance material modifier condition. More...
enum  ToleranceZoneShape { ToleranceZoneShapeNone, ToleranceZoneShapeDiameter, ToleranceZoneShapeSphericalDiameter, ToleranceZoneShapeSquare }
 Specifies the zone shape for the feature control frame. More...

Public Member Functions

NXOpen::Annotations::FeatureControlFrameDataBuilder::AreaSymbolType AreaSymbol ()
 Returns the material modifier
Created in NX7.5.0.
bool CircleU ()
 Returns the circle utoggle
Created in NX6.0.0.
NXString CircleUvalue ()
 Returns the circle u value Only available when Annotations::FeatureControlFrameDataBuilder::CircleU is true.
bool CommonZone ()
 Returns the common zone toggle
Created in NX6.0.0.
bool FreeState ()
 Returns the free state toggle
Created in NX6.0.0.
NXOpen::Annotations::FeatureControlFrameDataBuilder::ToleranceMaterialModifier MaterialModifier ()
 Returns the material modifier
Created in NX6.0.0.
bool MaximumTolerance ()
 Returns the maximum tolerance toggle
Created in NX6.0.0.
NXString MaximumToleranceValue ()
 Returns the maximum tolerance value Only available when Annotations::FeatureControlFrameDataBuilder::MaximumTolerance is true.
NXOpen::Annotations::CompoundDatumReferenceBuilderPrimaryCompoundDatumReference ()
 Returns the primary compound datum reference
Created in NX7.5.0.
NXOpen::Annotations::DatumReferenceBuilderPrimaryDatumReference ()
 Returns the primary datum reference
Created in NX6.0.0.
void PrimaryDatumReferences (std::vector< NXOpen::Annotations::DatumReferenceBuilder * > &primaryDatumReferences)
 Get the datum references
Created in NX6.0.0.
bool Projected ()
 Returns the projected toggle
Created in NX6.0.0.
NXString ProjectedValue ()
 Returns the projected value Only available when Annotations::FeatureControlFrameDataBuilder::Projected is true.
NXOpen::Annotations::CompoundDatumReferenceBuilderSecondaryCompoundDatumReference ()
 Returns the secondary compound datum reference
Created in NX7.5.0.
NXOpen::Annotations::DatumReferenceBuilderSecondaryDatumReference ()
 Returns the secondary datum reference
Created in NX6.0.0.
void SetAreaSymbol (NXOpen::Annotations::FeatureControlFrameDataBuilder::AreaSymbolType areaSymbol)
 Sets the material modifier
Created in NX7.5.0.
void SetCircleU (bool circleU)
 Sets the circle utoggle
Created in NX6.0.0.
void SetCircleUvalue (const NXString &circleUValue)
 Sets the circle u value Only available when Annotations::FeatureControlFrameDataBuilder::CircleU is true.
void SetCommonZone (bool commonZone)
 Sets the common zone toggle
Created in NX6.0.0.
void SetFreeState (bool freeState)
 Sets the free state toggle
Created in NX6.0.0.
void SetMaterialModifier (NXOpen::Annotations::FeatureControlFrameDataBuilder::ToleranceMaterialModifier materialModifier)
 Sets the material modifier
Created in NX6.0.0.
void SetMaximumTolerance (bool maximumTolerance)
 Sets the maximum tolerance toggle
Created in NX6.0.0.
void SetMaximumToleranceValue (const NXString &maximumToleranceValue)
 Sets the maximum tolerance value Only available when Annotations::FeatureControlFrameDataBuilder::MaximumTolerance is true.
void SetPrimaryCompoundDatumReference (NXOpen::Annotations::CompoundDatumReferenceBuilder *primaryDatumReference)
 Sets the primary compound datum reference
Created in NX7.5.0.
void SetProjected (bool projected)
 Sets the projected toggle
Created in NX6.0.0.
void SetProjectedValue (const NXString &projectedValue)
 Sets the projected value Only available when Annotations::FeatureControlFrameDataBuilder::Projected is true.
void SetSecondaryCompoundDatumReference (NXOpen::Annotations::CompoundDatumReferenceBuilder *secondaryDatumReference)
 Sets the secondary compound datum reference
Created in NX7.5.0.
void SetStatisticalTolerance (bool statisticalTolerance)
 Sets the statistical tolerance toggle
Created in NX6.0.0.
void SetTangentPlane (bool tangentPlane)
 Sets the tangent plane toggle
Created in NX6.0.0.
void SetTertiaryCompoundDatumReference (NXOpen::Annotations::CompoundDatumReferenceBuilder *tertiaryDatumReference)
 Sets the tertiary compound datum reference
Created in NX7.5.0.
void SetToleranceValue (const NXString &toleranceValue)
 Sets the tolerance value string
Created in NX6.0.0.
void SetUnitBasis (bool unitBasis)
 Sets the unit basis toggle Only available when feature control frame characteristic is Annotations::FeatureControlFrameBuilder::FcfCharacteristicStraightness Annotations::FeatureControlFrameBuilder::FcfCharacteristicFlatness Annotations::FeatureControlFrameBuilder::FcfCharacteristicProfileOfALine Annotations::FeatureControlFrameBuilder::FcfCharacteristicProfileOfASurface
Created in NX6.0.0.
void SetUnitBasisValue1 (const NXString &unitBasisValue1)
 Sets the unit basis value1 Only available when Annotations::FeatureControlFrameDataBuilder::UnitBasis is true.
void SetUnitBasisValue2 (const NXString &unitBasisValue2)
 Sets the unit basis value2 Only available when Annotations::FeatureControlFrameDataBuilder::UnitBasis is true.
void SetZoneShape (NXOpen::Annotations::FeatureControlFrameDataBuilder::ToleranceZoneShape zoneShape)
 Sets the zone shape
Created in NX6.0.0.
bool StatisticalTolerance ()
 Returns the statistical tolerance toggle
Created in NX6.0.0.
bool TangentPlane ()
 Returns the tangent plane toggle
Created in NX6.0.0.
NXOpen::Annotations::CompoundDatumReferenceBuilderTertiaryCompoundDatumReference ()
 Returns the tertiary compound datum reference
Created in NX7.5.0.
NXOpen::Annotations::DatumReferenceBuilderTertiaryDatumReference ()
 Returns the tertiary datum reference
Created in NX6.0.0.
NXString ToleranceValue ()
 Returns the tolerance value string
Created in NX6.0.0.
bool UnitBasis ()
 Returns the unit basis toggle Only available when feature control frame characteristic is Annotations::FeatureControlFrameBuilder::FcfCharacteristicStraightness Annotations::FeatureControlFrameBuilder::FcfCharacteristicFlatness Annotations::FeatureControlFrameBuilder::FcfCharacteristicProfileOfALine Annotations::FeatureControlFrameBuilder::FcfCharacteristicProfileOfASurface
Created in NX6.0.0.
NXString UnitBasisValue1 ()
 Returns the unit basis value1 Only available when Annotations::FeatureControlFrameDataBuilder::UnitBasis is true.
NXString UnitBasisValue2 ()
 Returns the unit basis value2 Only available when Annotations::FeatureControlFrameDataBuilder::UnitBasis is true.
virtual bool Validate ()
 Validate whether the inputs to the component are sufficient for commit to be called.
NXOpen::Annotations::FeatureControlFrameDataBuilder::ToleranceZoneShape ZoneShape ()
 Returns the zone shape
Created in NX6.0.0.

Detailed Description

Represents a FeatureControlFrameDataBuilder.


Created in NX6.0.0.


Member Enumeration Documentation

Specifies the unit type.

Enumerator:
AreaSymbolTypeRectangular 

Rectangular.

AreaSymbolTypeCircular 

Circular.

AreaSymbolTypeSpherical 

Spherical.

AreaSymbolTypeSquare 

Square.

Specifies the tolerance material modifier condition.

Enumerator:
ToleranceMaterialModifierNone 

no material modifier

ToleranceMaterialModifierLeastMaterialCondition 

least material condition

ToleranceMaterialModifierMaximumMaterialCondition 

maximum material condition

ToleranceMaterialModifierRegardlessOfFeatureSize 

regardless of feature size condition

Specifies the zone shape for the feature control frame.

Enumerator:
ToleranceZoneShapeNone 

no zone shape

ToleranceZoneShapeDiameter 

diameter

ToleranceZoneShapeSphericalDiameter 

spherical diameter

ToleranceZoneShapeSquare 

square


Member Function Documentation

Returns the material modifier
Created in NX7.5.0.



License requirements : None

Returns the circle utoggle
Created in NX6.0.0.



License requirements : None

Returns the circle u value Only available when Annotations::FeatureControlFrameDataBuilder::CircleU is true.


Created in NX6.0.0.

License requirements : None

Returns the common zone toggle
Created in NX6.0.0.



License requirements : None

Returns the free state toggle
Created in NX6.0.0.



License requirements : None

Returns the material modifier
Created in NX6.0.0.



License requirements : None

Returns the maximum tolerance toggle
Created in NX6.0.0.



License requirements : None

Returns the maximum tolerance value Only available when Annotations::FeatureControlFrameDataBuilder::MaximumTolerance is true.


Created in NX6.0.0.

License requirements : None

Returns the primary compound datum reference
Created in NX7.5.0.



License requirements : None

Returns the primary datum reference
Created in NX6.0.0.



License requirements : None

Get the datum references
Created in NX6.0.0.



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

Parameters:
primaryDatumReferencesdatum references

Returns the projected toggle
Created in NX6.0.0.



License requirements : None

Returns the projected value Only available when Annotations::FeatureControlFrameDataBuilder::Projected is true.


Created in NX6.0.0.

License requirements : None

Returns the secondary compound datum reference
Created in NX7.5.0.



License requirements : None

Returns the secondary datum reference
Created in NX6.0.0.



License requirements : None

Sets the material modifier
Created in NX7.5.0.



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

Parameters:
areaSymbolareasymbol

Sets the circle utoggle
Created in NX6.0.0.



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

Parameters:
circleUcircleu

Sets the circle u value Only available when Annotations::FeatureControlFrameDataBuilder::CircleU is true.


Created in NX6.0.0.

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

Parameters:
circleUValuecircleuvalue

Sets the common zone toggle
Created in NX6.0.0.



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

Parameters:
commonZonecommonzone

Sets the free state toggle
Created in NX6.0.0.



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

Parameters:
freeStatefreestate

Sets the material modifier
Created in NX6.0.0.



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

Parameters:
materialModifiermaterialmodifier

Sets the maximum tolerance toggle
Created in NX6.0.0.



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

Parameters:
maximumTolerancemaximumtolerance

Sets the maximum tolerance value Only available when Annotations::FeatureControlFrameDataBuilder::MaximumTolerance is true.


Created in NX6.0.0.

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

Parameters:
maximumToleranceValuemaximumtolerancevalue

Sets the primary compound datum reference
Created in NX7.5.0.



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

Parameters:
primaryDatumReferenceprimarydatumreference

Sets the projected toggle
Created in NX6.0.0.



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

Parameters:
projectedprojected

Sets the projected value Only available when Annotations::FeatureControlFrameDataBuilder::Projected is true.


Created in NX6.0.0.

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

Parameters:
projectedValueprojectedvalue

Sets the secondary compound datum reference
Created in NX7.5.0.



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

Parameters:
secondaryDatumReferencesecondarydatumreference

Sets the statistical tolerance toggle
Created in NX6.0.0.



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

Parameters:
statisticalTolerancestatisticaltolerance

Sets the tangent plane toggle
Created in NX6.0.0.



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

Parameters:
tangentPlanetangentplane

Sets the tertiary compound datum reference
Created in NX7.5.0.



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

Parameters:
tertiaryDatumReferencetertiarydatumreference

Sets the tolerance value string
Created in NX6.0.0.



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

Parameters:
toleranceValuetolerancevalue

Sets the unit basis toggle Only available when feature control frame characteristic is Annotations::FeatureControlFrameBuilder::FcfCharacteristicStraightness Annotations::FeatureControlFrameBuilder::FcfCharacteristicFlatness Annotations::FeatureControlFrameBuilder::FcfCharacteristicProfileOfALine Annotations::FeatureControlFrameBuilder::FcfCharacteristicProfileOfASurface
Created in NX6.0.0.



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

Parameters:
unitBasisunitbasis

Sets the unit basis value1 Only available when Annotations::FeatureControlFrameDataBuilder::UnitBasis is true.


Created in NX6.0.0.

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

Parameters:
unitBasisValue1unitbasisvalue1

Sets the unit basis value2 Only available when Annotations::FeatureControlFrameDataBuilder::UnitBasis is true.


Created in NX6.0.0.

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

Parameters:
unitBasisValue2unitbasisvalue2

Sets the zone shape
Created in NX6.0.0.



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

Parameters:
zoneShapezoneshape

Returns the statistical tolerance toggle
Created in NX6.0.0.



License requirements : None

Returns the tangent plane toggle
Created in NX6.0.0.



License requirements : None

Returns the tertiary compound datum reference
Created in NX7.5.0.



License requirements : None

Returns the tertiary datum reference
Created in NX6.0.0.



License requirements : None

Returns the tolerance value string
Created in NX6.0.0.



License requirements : None

Returns the unit basis value1 Only available when Annotations::FeatureControlFrameDataBuilder::UnitBasis is true.


Created in NX6.0.0.

License requirements : None

Returns the unit basis value2 Only available when Annotations::FeatureControlFrameDataBuilder::UnitBasis is true.


Created in NX6.0.0.

License requirements : None

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.

Returns the zone shape
Created in NX6.0.0.



License requirements : None


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