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

Represents a NXOpen::Annotations::SurfaceFinish builder
To create a new instance of this class, use NXOpen::Annotations::PmiAttributeCollection::CreateSurfaceFinishBuilder

Created in NX6.0.0. More...

Inheritance diagram for NXOpen::Annotations::SurfaceFinishBuilder:
NXOpen::Annotations::BaseSurfaceFinishBuilder NXOpen::Annotations::PmiAttributeBuilder NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Types

enum  FinishType {
  FinishTypeBasic, FinishTypeModifier, FinishTypeModifierAllAround, FinishTypeMaterialRemovalRequired,
  FinishTypeModifierMaterialRemovalRequired, FinishTypeModifierMaterialRemovalRequiredAllAround, FinishTypeMaterialRemovalProhibited, FinishTypeModifierMaterialRemovalProhibited,
  FinishTypeModifierMaterialRemovalProhibitedAllAround
}
 the valid types for pmi finish type More...
 
enum  StandardType {
  StandardTypeAnsi, StandardTypeIso, StandardTypeJis, StandardTypeDin,
  StandardTypeIso2002, StandardTypeDin2002, StandardTypeGb, StandardTypeEskd
}
 the valid types for pmi surface finish standards More...
 
- Public Types inherited from NXOpen::Annotations::BaseSurfaceFinishBuilder
enum  ParanthesesType { ParanthesesTypeNone, ParanthesesTypeLeft, ParanthesesTypeRight, ParanthesesTypeBoth }
 the valid parantheses types. More...
 
enum  ParenthesesType { ParenthesesTypeNone, ParenthesesTypeLeft, ParenthesesTypeRight, ParenthesesTypeBoth }
 the valid parentheses types More...
 
enum  ToleranceOption {
  ToleranceOptionNone, ToleranceOptionEqualBilateral, ToleranceOptionBilateral, ToleranceOptionUnilateralPlus,
  ToleranceOptionUnilateralMinus, ToleranceOptionPlusLimitTwoLines, ToleranceOptionMinusLimitTwoLines, ToleranceOptionPlusLimitOneLine,
  ToleranceOptionMinusLimitOneLine
}
 the valid surface finish tolerance types More...
 

Public Member Functions

NXString A1 ()
 Returns the a1
Created in NX6.0.0. More...
 
NXString A2 ()
 Returns the a2
Created in NX6.0.0. More...
 
double Angle ()
 Returns the angle
Created in NX7.5.0. More...
 
NXString B ()
 Returns the b
Created in NX6.0.0. More...
 
NXString C ()
 Returns the c
Created in NX6.0.0. More...
 
NXString D ()
 Returns the d
Created in NX6.0.0. More...
 
NXString E ()
 Returns the e
Created in NX6.0.0. More...
 
NXString F1 ()
 Returns the f1
Created in NX6.0.0. More...
 
NXString F2 ()
 Returns the f2
Created in NX6.0.0. More...
 
NXOpen::Annotations::SurfaceFinishBuilder::FinishType Finish ()
 Returns the finish
Created in NX6.0.0. More...
 
void InheritFrom (NXOpen::Annotations::SurfaceFinish *inheritTag)
 The surface finish is inherited form existing surface finish. More...
 
bool InvertSymbol ()
 Returns the invert symbol
Created in NX7.5.2. More...
 
bool InvertText ()
 Returns the invert text flag
Created in NX7.5.0. More...
 
double LowerTolerance ()
 Returns the lower tolerance applicable for all the tolerance types other than Bilateral
Created in NX7.5.0. More...
 
NXOpen::Annotations::BaseSurfaceFinishBuilder::ParanthesesType Parantheses ()
 Returns the parantheses. More...
 
NXOpen::Annotations::BaseSurfaceFinishBuilder::ParenthesesType Parentheses ()
 Returns the parentheses
Created in NX8.0.0. More...
 
void SetA1 (const NXString &a1)
 Sets the a1
Created in NX6.0.0. More...
 
void SetA1 (const char *a1)
 Sets the a1
Created in NX6.0.0. More...
 
void SetA2 (const NXString &a2)
 Sets the a2
Created in NX6.0.0. More...
 
void SetA2 (const char *a2)
 Sets the a2
Created in NX6.0.0. More...
 
void SetAngle (double angle)
 Sets the angle
Created in NX7.5.0. More...
 
void SetB (const NXString &b)
 Sets the b
Created in NX6.0.0. More...
 
void SetB (const char *b)
 Sets the b
Created in NX6.0.0. More...
 
void SetC (const NXString &c)
 Sets the c
Created in NX6.0.0. More...
 
void SetC (const char *c)
 Sets the c
Created in NX6.0.0. More...
 
void SetD (const NXString &d)
 Sets the d
Created in NX6.0.0. More...
 
void SetD (const char *d)
 Sets the d
Created in NX6.0.0. More...
 
void SetE (const NXString &e)
 Sets the e
Created in NX6.0.0. More...
 
void SetE (const char *e)
 Sets the e
Created in NX6.0.0. More...
 
void SetF1 (const NXString &f1)
 Sets the f1
Created in NX6.0.0. More...
 
void SetF1 (const char *f1)
 Sets the f1
Created in NX6.0.0. More...
 
void SetF2 (const NXString &f2)
 Sets the f2
Created in NX6.0.0. More...
 
void SetF2 (const char *f2)
 Sets the f2
Created in NX6.0.0. More...
 
void SetFinish (NXOpen::Annotations::SurfaceFinishBuilder::FinishType finish)
 Sets the finish
Created in NX6.0.0. More...
 
void SetInvertSymbol (bool invertSymbol)
 Sets the invert symbol
Created in NX7.5.2. More...
 
void SetInvertText (bool invertText)
 Sets the invert text flag
Created in NX7.5.0. More...
 
void SetLowerTolerance (double lowerTolerance)
 Sets the lower tolerance applicable for all the tolerance types other than Bilateral
Created in NX7.5.0. More...
 
void SetParantheses (NXOpen::Annotations::BaseSurfaceFinishBuilder::ParanthesesType paranthesesType)
 Sets the parantheses. More...
 
void SetParentheses (NXOpen::Annotations::BaseSurfaceFinishBuilder::ParenthesesType parenthesesType)
 Sets the parentheses
Created in NX8.0.0. More...
 
void SetSingleRoughnessValue (bool singleRoughnessValue)
 Sets the single roughness value
Created in NX8.0.0. More...
 
void SetStandard (NXOpen::Annotations::SurfaceFinishBuilder::StandardType standard)
 Sets the standard
Created in NX6.0.0. More...
 
void SetTitle (const NXString &title)
 Sets the title
Created in NX6.0.0. More...
 
void SetTitle (const char *title)
 Sets the title
Created in NX6.0.0. More...
 
void SetTolerance (double tolerance)
 Sets the tolerance in case of bilateral tolerance type otherwise upper tolerance
Created in NX7.5.0. More...
 
void SetToleranceType (NXOpen::Annotations::BaseSurfaceFinishBuilder::ToleranceOption toleranceType)
 Sets the tolerance type is applicable only where Material Removal is required
Created in NX7.5.0. More...
 
bool SingleRoughnessValue ()
 Returns the single roughness value
Created in NX8.0.0. More...
 
NXOpen::Annotations::SurfaceFinishBuilder::StandardType Standard ()
 Returns the standard
Created in NX6.0.0. More...
 
NXString Title ()
 Returns the title
Created in NX6.0.0. More...
 
double Tolerance ()
 Returns the tolerance in case of bilateral tolerance type otherwise upper tolerance
Created in NX7.5.0. More...
 
NXOpen::Annotations::BaseSurfaceFinishBuilder::ToleranceOption ToleranceType ()
 Returns the tolerance type is applicable only where Material Removal is required
Created in NX7.5.0. More...
 

Detailed Description

Represents a NXOpen::Annotations::SurfaceFinish builder
To create a new instance of this class, use NXOpen::Annotations::PmiAttributeCollection::CreateSurfaceFinishBuilder

Created in NX6.0.0.


Member Enumeration Documentation

the valid types for pmi finish type

Enumerator
FinishTypeBasic 

Basic.

FinishTypeModifier 

Modifier.

FinishTypeModifierAllAround 

Modifier, All Around.

FinishTypeMaterialRemovalRequired 

Material Removal Required.

FinishTypeModifierMaterialRemovalRequired 

Modifier, Material Removal Required.

FinishTypeModifierMaterialRemovalRequiredAllAround 

Modifier, Material Removal Required, All Around.

FinishTypeMaterialRemovalProhibited 

Material Removal Prohibited.

FinishTypeModifierMaterialRemovalProhibited 

Modifier, Material Removal Prohibited.

FinishTypeModifierMaterialRemovalProhibitedAllAround 

Modifier, Material Removal Prohibited, All Around.

the valid types for pmi surface finish standards

Enumerator
StandardTypeAnsi 

ANSI.

StandardTypeIso 

ISO.

StandardTypeJis 

JIS.

StandardTypeDin 

DIN.

StandardTypeIso2002 

ISO 2002.

StandardTypeDin2002 

DIN 2002.

StandardTypeGb 

GB131-93.

StandardTypeEskd 

ESKD.

Member Function Documentation

NXString NXOpen::Annotations::SurfaceFinishBuilder::A1 ( )

Returns the a1
Created in NX6.0.0.



License requirements : None

NXString NXOpen::Annotations::SurfaceFinishBuilder::A2 ( )

Returns the a2
Created in NX6.0.0.



License requirements : None

double NXOpen::Annotations::SurfaceFinishBuilder::Angle ( )

Returns the angle
Created in NX7.5.0.



License requirements : None

NXString NXOpen::Annotations::SurfaceFinishBuilder::B ( )

Returns the b
Created in NX6.0.0.



License requirements : None

NXString NXOpen::Annotations::SurfaceFinishBuilder::C ( )

Returns the c
Created in NX6.0.0.



License requirements : None

NXString NXOpen::Annotations::SurfaceFinishBuilder::D ( )

Returns the d
Created in NX6.0.0.



License requirements : None

NXString NXOpen::Annotations::SurfaceFinishBuilder::E ( )

Returns the e
Created in NX6.0.0.



License requirements : None

NXString NXOpen::Annotations::SurfaceFinishBuilder::F1 ( )

Returns the f1
Created in NX6.0.0.



License requirements : None

NXString NXOpen::Annotations::SurfaceFinishBuilder::F2 ( )

Returns the f2
Created in NX6.0.0.



License requirements : None

NXOpen::Annotations::SurfaceFinishBuilder::FinishType NXOpen::Annotations::SurfaceFinishBuilder::Finish ( )

Returns the finish
Created in NX6.0.0.



License requirements : None

void NXOpen::Annotations::SurfaceFinishBuilder::InheritFrom ( NXOpen::Annotations::SurfaceFinish inheritTag)

The surface finish is inherited form existing surface finish.


Created in NX8.5.0.

License requirements : None

Parameters
inheritTaginherittag
bool NXOpen::Annotations::SurfaceFinishBuilder::InvertSymbol ( )

Returns the invert symbol
Created in NX7.5.2.



License requirements : None

bool NXOpen::Annotations::SurfaceFinishBuilder::InvertText ( )

Returns the invert text flag
Created in NX7.5.0.



License requirements : None

double NXOpen::Annotations::SurfaceFinishBuilder::LowerTolerance ( )

Returns the lower tolerance applicable for all the tolerance types other than Bilateral
Created in NX7.5.0.



License requirements : None

NXOpen::Annotations::BaseSurfaceFinishBuilder::ParanthesesType NXOpen::Annotations::SurfaceFinishBuilder::Parantheses ( )

Returns the parantheses.

This method is deprecated.

Deprecated:
Deprecated in NX8.0.0. Use NXOpen::Annotations::SurfaceFinishBuilder::Parentheses and NXOpen::Annotations::SurfaceFinishBuilder::SetParentheses instead.


Created in NX7.5.0.

License requirements : None

NXOpen::Annotations::BaseSurfaceFinishBuilder::ParenthesesType NXOpen::Annotations::SurfaceFinishBuilder::Parentheses ( )

Returns the parentheses
Created in NX8.0.0.



License requirements : None

void NXOpen::Annotations::SurfaceFinishBuilder::SetA1 ( const NXString a1)

Sets the a1
Created in NX6.0.0.



License requirements : None

Parameters
a1a1
void NXOpen::Annotations::SurfaceFinishBuilder::SetA1 ( const char *  a1)

Sets the a1
Created in NX6.0.0.



License requirements : None

Parameters
a1a1
void NXOpen::Annotations::SurfaceFinishBuilder::SetA2 ( const NXString a2)

Sets the a2
Created in NX6.0.0.



License requirements : None

Parameters
a2a2
void NXOpen::Annotations::SurfaceFinishBuilder::SetA2 ( const char *  a2)

Sets the a2
Created in NX6.0.0.



License requirements : None

Parameters
a2a2
void NXOpen::Annotations::SurfaceFinishBuilder::SetAngle ( double  angle)

Sets the angle
Created in NX7.5.0.



License requirements : None

Parameters
angleangle
void NXOpen::Annotations::SurfaceFinishBuilder::SetB ( const NXString b)

Sets the b
Created in NX6.0.0.



License requirements : None

Parameters
bb
void NXOpen::Annotations::SurfaceFinishBuilder::SetB ( const char *  b)

Sets the b
Created in NX6.0.0.



License requirements : None

Parameters
bb
void NXOpen::Annotations::SurfaceFinishBuilder::SetC ( const NXString c)

Sets the c
Created in NX6.0.0.



License requirements : None

Parameters
cc
void NXOpen::Annotations::SurfaceFinishBuilder::SetC ( const char *  c)

Sets the c
Created in NX6.0.0.



License requirements : None

Parameters
cc
void NXOpen::Annotations::SurfaceFinishBuilder::SetD ( const NXString d)

Sets the d
Created in NX6.0.0.



License requirements : None

Parameters
dd
void NXOpen::Annotations::SurfaceFinishBuilder::SetD ( const char *  d)

Sets the d
Created in NX6.0.0.



License requirements : None

Parameters
dd
void NXOpen::Annotations::SurfaceFinishBuilder::SetE ( const NXString e)

Sets the e
Created in NX6.0.0.



License requirements : None

Parameters
ee
void NXOpen::Annotations::SurfaceFinishBuilder::SetE ( const char *  e)

Sets the e
Created in NX6.0.0.



License requirements : None

Parameters
ee
void NXOpen::Annotations::SurfaceFinishBuilder::SetF1 ( const NXString f1)

Sets the f1
Created in NX6.0.0.



License requirements : None

Parameters
f1f1
void NXOpen::Annotations::SurfaceFinishBuilder::SetF1 ( const char *  f1)

Sets the f1
Created in NX6.0.0.



License requirements : None

Parameters
f1f1
void NXOpen::Annotations::SurfaceFinishBuilder::SetF2 ( const NXString f2)

Sets the f2
Created in NX6.0.0.



License requirements : None

Parameters
f2f2
void NXOpen::Annotations::SurfaceFinishBuilder::SetF2 ( const char *  f2)

Sets the f2
Created in NX6.0.0.



License requirements : None

Parameters
f2f2
void NXOpen::Annotations::SurfaceFinishBuilder::SetFinish ( NXOpen::Annotations::SurfaceFinishBuilder::FinishType  finish)

Sets the finish
Created in NX6.0.0.



License requirements : None

Parameters
finishfinish
void NXOpen::Annotations::SurfaceFinishBuilder::SetInvertSymbol ( bool  invertSymbol)

Sets the invert symbol
Created in NX7.5.2.



License requirements : None

Parameters
invertSymbolinvertsymbol
void NXOpen::Annotations::SurfaceFinishBuilder::SetInvertText ( bool  invertText)

Sets the invert text flag
Created in NX7.5.0.



License requirements : None

Parameters
invertTextinverttext
void NXOpen::Annotations::SurfaceFinishBuilder::SetLowerTolerance ( double  lowerTolerance)

Sets the lower tolerance applicable for all the tolerance types other than Bilateral
Created in NX7.5.0.



License requirements : None

Parameters
lowerTolerancelowertolerance
void NXOpen::Annotations::SurfaceFinishBuilder::SetParantheses ( NXOpen::Annotations::BaseSurfaceFinishBuilder::ParanthesesType  paranthesesType)

Sets the parantheses.

This method is deprecated.

Deprecated:
Deprecated in NX8.0.0. Use NXOpen::Annotations::SurfaceFinishBuilder::Parentheses and NXOpen::Annotations::SurfaceFinishBuilder::SetParentheses instead.


Created in NX7.5.0.

License requirements : None

Parameters
paranthesesTypeparanthesestype
void NXOpen::Annotations::SurfaceFinishBuilder::SetParentheses ( NXOpen::Annotations::BaseSurfaceFinishBuilder::ParenthesesType  parenthesesType)

Sets the parentheses
Created in NX8.0.0.



License requirements : None

Parameters
parenthesesTypeparenthesestype
void NXOpen::Annotations::SurfaceFinishBuilder::SetSingleRoughnessValue ( bool  singleRoughnessValue)

Sets the single roughness value
Created in NX8.0.0.



License requirements : None

Parameters
singleRoughnessValuesingleroughnessvalue
void NXOpen::Annotations::SurfaceFinishBuilder::SetStandard ( NXOpen::Annotations::SurfaceFinishBuilder::StandardType  standard)

Sets the standard
Created in NX6.0.0.



License requirements : None

Parameters
standardstandard
void NXOpen::Annotations::SurfaceFinishBuilder::SetTitle ( const NXString title)

Sets the title
Created in NX6.0.0.



License requirements : None

Parameters
titletitle
void NXOpen::Annotations::SurfaceFinishBuilder::SetTitle ( const char *  title)

Sets the title
Created in NX6.0.0.



License requirements : None

Parameters
titletitle
void NXOpen::Annotations::SurfaceFinishBuilder::SetTolerance ( double  tolerance)

Sets the tolerance in case of bilateral tolerance type otherwise upper tolerance
Created in NX7.5.0.



License requirements : None

Parameters
tolerancetolerance
void NXOpen::Annotations::SurfaceFinishBuilder::SetToleranceType ( NXOpen::Annotations::BaseSurfaceFinishBuilder::ToleranceOption  toleranceType)

Sets the tolerance type is applicable only where Material Removal is required
Created in NX7.5.0.



License requirements : None

Parameters
toleranceTypetolerancetype
bool NXOpen::Annotations::SurfaceFinishBuilder::SingleRoughnessValue ( )

Returns the single roughness value
Created in NX8.0.0.



License requirements : None

NXOpen::Annotations::SurfaceFinishBuilder::StandardType NXOpen::Annotations::SurfaceFinishBuilder::Standard ( )

Returns the standard
Created in NX6.0.0.



License requirements : None

NXString NXOpen::Annotations::SurfaceFinishBuilder::Title ( )

Returns the title
Created in NX6.0.0.



License requirements : None

double NXOpen::Annotations::SurfaceFinishBuilder::Tolerance ( )

Returns the tolerance in case of bilateral tolerance type otherwise upper tolerance
Created in NX7.5.0.



License requirements : None

NXOpen::Annotations::BaseSurfaceFinishBuilder::ToleranceOption NXOpen::Annotations::SurfaceFinishBuilder::ToleranceType ( )

Returns the tolerance type is applicable only where Material Removal is required
Created in NX7.5.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.