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

Represents a NXOpen::Drafting::AutomationRuleBuilder
Created in NX9.0.0. More...

Inheritance diagram for NXOpen::Drafting::AutomationRuleBuilder:
NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Member Functions

bool AllowInsideGeometry ()
 Returns the allow inside geometry option allows annotation inside geometry
Created in NX9.0.0. More...
 
double EqualDimensionTolerance ()
 Returns the equal dimension comparison tolerance
Created in NX9.0.0. More...
 
std::vector< NXStringGetRulesList ()
 The automation rules in the order of decreasing priorities. More...
 
bool HideFeetAndInchMarks ()
 Returns the hide feet and inch marks option Show/Hide feet and inch marks. More...
 
double Increment ()
 Returns the increment Display dimension value in inches and fractions to nearest specified value
Created in NX9.0.0. More...
 
double LowerThreshold ()
 Returns the lower threshold display dimension value in feet, inches and fractions if it is greater than the specified value
Created in NX9.0.0. More...
 
double MaximumGapToGeometry ()
 Returns the maximum gap from the view geometry to the annotation
Created in NX9.0.0. More...
 
double MinimumGapBetweenAnnotations ()
 Returns the minimum gap between annotations
Created in NX9.0.0. More...
 
double MinimumGapToGeometry ()
 Returns the minimum gap from the view geometry to the annotation
Created in NX9.0.0. More...
 
double ReferenceGeometryGapTolerance ()
 Returns the reference geometry search gap tolerance
Created in NX9.0.0. More...
 
bool RoundFeetAndInches ()
 Returns the round feet and inches determine wheather or not to display dimension value in inches and fractions to nearest specified value
Created in NX9.0.0. More...
 
void SetAllowInsideGeometry (bool allowInsideGeometry)
 Sets the allow inside geometry option allows annotation inside geometry
Created in NX9.0.0. More...
 
void SetEqualDimensionTolerance (double equalDimensionTolerance)
 Sets the equal dimension comparison tolerance
Created in NX9.0.0. More...
 
void SetHideFeetAndInchMarks (bool hideFeetAndInchMarks)
 Sets the hide feet and inch marks option Show/Hide feet and inch marks. More...
 
void SetIncrement (double increment)
 Sets the increment Display dimension value in inches and fractions to nearest specified value
Created in NX9.0.0. More...
 
void SetLowerThreshold (double lowerThreshold)
 Sets the lower threshold display dimension value in feet, inches and fractions if it is greater than the specified value
Created in NX9.0.0. More...
 
void SetMaximumGapToGeometry (double maximumGapToGeometry)
 Sets the maximum gap from the view geometry to the annotation
Created in NX9.0.0. More...
 
void SetMinimumGapBetweenAnnotations (double minimumGapBetweenAnnotations)
 Sets the minimum gap between annotations
Created in NX9.0.0. More...
 
void SetMinimumGapToGeometry (double minimumGapToGeometry)
 Sets the minimum gap from the view geometry to the annotation
Created in NX9.0.0. More...
 
void SetReferenceGeometryGapTolerance (double referenceGeometryGapTolerance)
 Sets the reference geometry search gap tolerance
Created in NX9.0.0. More...
 
void SetRoundFeetAndInches (bool roundFeetAndInches)
 Sets the round feet and inches determine wheather or not to display dimension value in inches and fractions to nearest specified value
Created in NX9.0.0. More...
 
void SetRulesList (std::vector< NXString > &rules)
 The set of order list
Created in NX9.0.0. More...
 
void SetUseFeetInchesAndFraction (bool useFeetInchesAndFraction)
 Sets the use feet inches and fraction determine wheather or not to display dimension value in feet, inches and fractions if it is greater than the specified value
Created in NX9.0.0. More...
 
bool UseFeetInchesAndFraction ()
 Returns the use feet inches and fraction determine wheather or not to display dimension value in feet, inches and fractions if it is greater than the specified value
Created in NX9.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 NXOpen::Drafting::AutomationRuleBuilder
Created in NX9.0.0.


Member Function Documentation

bool NXOpen::Drafting::AutomationRuleBuilder::AllowInsideGeometry ( )

Returns the allow inside geometry option allows annotation inside geometry
Created in NX9.0.0.



License requirements : None

double NXOpen::Drafting::AutomationRuleBuilder::EqualDimensionTolerance ( )

Returns the equal dimension comparison tolerance
Created in NX9.0.0.



License requirements : None

std::vector<NXString> NXOpen::Drafting::AutomationRuleBuilder::GetRulesList ( )

The automation rules in the order of decreasing priorities.

So, the first rule in the VLA has the highest priority

Returns
Rules list
Created in NX9.0.0.

License requirements : None
bool NXOpen::Drafting::AutomationRuleBuilder::HideFeetAndInchMarks ( )

Returns the hide feet and inch marks option Show/Hide feet and inch marks.

True to hide and False to show
Created in NX9.0.0.

License requirements : None

double NXOpen::Drafting::AutomationRuleBuilder::Increment ( )

Returns the increment Display dimension value in inches and fractions to nearest specified value
Created in NX9.0.0.



License requirements : None

double NXOpen::Drafting::AutomationRuleBuilder::LowerThreshold ( )

Returns the lower threshold display dimension value in feet, inches and fractions if it is greater than the specified value
Created in NX9.0.0.



License requirements : None

double NXOpen::Drafting::AutomationRuleBuilder::MaximumGapToGeometry ( )

Returns the maximum gap from the view geometry to the annotation
Created in NX9.0.0.



License requirements : None

double NXOpen::Drafting::AutomationRuleBuilder::MinimumGapBetweenAnnotations ( )

Returns the minimum gap between annotations
Created in NX9.0.0.



License requirements : None

double NXOpen::Drafting::AutomationRuleBuilder::MinimumGapToGeometry ( )

Returns the minimum gap from the view geometry to the annotation
Created in NX9.0.0.



License requirements : None

double NXOpen::Drafting::AutomationRuleBuilder::ReferenceGeometryGapTolerance ( )

Returns the reference geometry search gap tolerance
Created in NX9.0.0.



License requirements : None

bool NXOpen::Drafting::AutomationRuleBuilder::RoundFeetAndInches ( )

Returns the round feet and inches determine wheather or not to display dimension value in inches and fractions to nearest specified value
Created in NX9.0.0.



License requirements : None

void NXOpen::Drafting::AutomationRuleBuilder::SetAllowInsideGeometry ( bool  allowInsideGeometry)

Sets the allow inside geometry option allows annotation inside geometry
Created in NX9.0.0.



License requirements : nx_drawing_auto ("NX Drawing Automation")

Parameters
allowInsideGeometryallowinsidegeometry
void NXOpen::Drafting::AutomationRuleBuilder::SetEqualDimensionTolerance ( double  equalDimensionTolerance)

Sets the equal dimension comparison tolerance
Created in NX9.0.0.



License requirements : nx_drawing_auto ("NX Drawing Automation")

Parameters
equalDimensionToleranceequaldimensiontolerance
void NXOpen::Drafting::AutomationRuleBuilder::SetHideFeetAndInchMarks ( bool  hideFeetAndInchMarks)

Sets the hide feet and inch marks option Show/Hide feet and inch marks.

True to hide and False to show
Created in NX9.0.0.

License requirements : nx_drawing_auto ("NX Drawing Automation")

Parameters
hideFeetAndInchMarkshidefeetandinchmarks
void NXOpen::Drafting::AutomationRuleBuilder::SetIncrement ( double  increment)

Sets the increment Display dimension value in inches and fractions to nearest specified value
Created in NX9.0.0.



License requirements : nx_drawing_auto ("NX Drawing Automation")

Parameters
incrementincrement
void NXOpen::Drafting::AutomationRuleBuilder::SetLowerThreshold ( double  lowerThreshold)

Sets the lower threshold display dimension value in feet, inches and fractions if it is greater than the specified value
Created in NX9.0.0.



License requirements : nx_drawing_auto ("NX Drawing Automation")

Parameters
lowerThresholdlowerthreshold
void NXOpen::Drafting::AutomationRuleBuilder::SetMaximumGapToGeometry ( double  maximumGapToGeometry)

Sets the maximum gap from the view geometry to the annotation
Created in NX9.0.0.



License requirements : nx_drawing_auto ("NX Drawing Automation")

Parameters
maximumGapToGeometrymaximumgaptogeometry
void NXOpen::Drafting::AutomationRuleBuilder::SetMinimumGapBetweenAnnotations ( double  minimumGapBetweenAnnotations)

Sets the minimum gap between annotations
Created in NX9.0.0.



License requirements : nx_drawing_auto ("NX Drawing Automation")

Parameters
minimumGapBetweenAnnotationsminimumgapbetweenannotations
void NXOpen::Drafting::AutomationRuleBuilder::SetMinimumGapToGeometry ( double  minimumGapToGeometry)

Sets the minimum gap from the view geometry to the annotation
Created in NX9.0.0.



License requirements : nx_drawing_auto ("NX Drawing Automation")

Parameters
minimumGapToGeometryminimumgaptogeometry
void NXOpen::Drafting::AutomationRuleBuilder::SetReferenceGeometryGapTolerance ( double  referenceGeometryGapTolerance)

Sets the reference geometry search gap tolerance
Created in NX9.0.0.



License requirements : nx_drawing_auto ("NX Drawing Automation")

Parameters
referenceGeometryGapTolerancereferencegeometrygaptolerance
void NXOpen::Drafting::AutomationRuleBuilder::SetRoundFeetAndInches ( bool  roundFeetAndInches)

Sets the round feet and inches determine wheather or not to display dimension value in inches and fractions to nearest specified value
Created in NX9.0.0.



License requirements : nx_drawing_auto ("NX Drawing Automation")

Parameters
roundFeetAndInchesroundfeetandinches
void NXOpen::Drafting::AutomationRuleBuilder::SetRulesList ( std::vector< NXString > &  rules)

The set of order list
Created in NX9.0.0.



License requirements : nx_drawing_auto ("NX Drawing Automation")

Parameters
rulesRules list
void NXOpen::Drafting::AutomationRuleBuilder::SetUseFeetInchesAndFraction ( bool  useFeetInchesAndFraction)

Sets the use feet inches and fraction determine wheather or not to display dimension value in feet, inches and fractions if it is greater than the specified value
Created in NX9.0.0.



License requirements : nx_drawing_auto ("NX Drawing Automation")

Parameters
useFeetInchesAndFractionusefeetinchesandfraction
bool NXOpen::Drafting::AutomationRuleBuilder::UseFeetInchesAndFraction ( )

Returns the use feet inches and fraction determine wheather or not to display dimension value in feet, inches and fractions if it is greater than the specified value
Created in NX9.0.0.



License requirements : None

virtual bool NXOpen::Drafting::AutomationRuleBuilder::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.