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

Represents a Annotations::SurfaceFinish builder
To create a new instance of this class, use 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

List of all members.

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 Member Functions

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

Detailed Description

Represents a Annotations::SurfaceFinish builder
To create a new instance of this class, use 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

Returns the a1
Created in NX6.0.0.



License requirements : None

Returns the a2
Created in NX6.0.0.



License requirements : None

Returns the angle
Created in NX7.5.0.



License requirements : None

Returns the b
Created in NX6.0.0.



License requirements : None

Returns the c
Created in NX6.0.0.



License requirements : None

Returns the d
Created in NX6.0.0.



License requirements : None

Returns the e
Created in NX6.0.0.



License requirements : None

Returns the f1
Created in NX6.0.0.



License requirements : None

Returns the f2
Created in NX6.0.0.



License requirements : None

Returns the finish
Created in NX6.0.0.



License requirements : None

Returns the invert symbol
Created in NX7.5.2.



License requirements : None

Returns the invert text flag
Created in NX7.5.0.



License requirements : None

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



License requirements : None

Returns the parantheses.

This method is deprecated.

Deprecated:
Deprecated in NX8.0.0.


Created in NX7.5.0.

License requirements : None

Returns the parentheses
Created in NX8.0.0.



License requirements : None

Sets the a1
Created in NX6.0.0.



License requirements : None

Parameters:
a1a1

Sets the a2
Created in NX6.0.0.



License requirements : None

Parameters:
a2a2

Sets the angle
Created in NX7.5.0.



License requirements : None

Parameters:
angleangle

Sets the b
Created in NX6.0.0.



License requirements : None

Parameters:
bb

Sets the c
Created in NX6.0.0.



License requirements : None

Parameters:
cc

Sets the d
Created in NX6.0.0.



License requirements : None

Parameters:
dd

Sets the e
Created in NX6.0.0.



License requirements : None

Parameters:
ee

Sets the f1
Created in NX6.0.0.



License requirements : None

Parameters:
f1f1

Sets the f2
Created in NX6.0.0.



License requirements : None

Parameters:
f2f2

Sets the finish
Created in NX6.0.0.



License requirements : None

Parameters:
finishfinish

Sets the invert symbol
Created in NX7.5.2.



License requirements : None

Parameters:
invertSymbolinvertsymbol

Sets the invert text flag
Created in NX7.5.0.



License requirements : None

Parameters:
invertTextinverttext

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



License requirements : None

Parameters:
lowerTolerancelowertolerance

Sets the parantheses.

This method is deprecated.

Deprecated:
Deprecated in NX8.0.0.


Created in NX7.5.0.

License requirements : None

Parameters:
paranthesesTypeparanthesestype

Sets the parentheses
Created in NX8.0.0.



License requirements : None

Parameters:
parenthesesTypeparenthesestype

Sets the single roughness value
Created in NX8.0.0.



License requirements : None

Parameters:
singleRoughnessValuesingleroughnessvalue

Sets the standard
Created in NX6.0.0.



License requirements : None

Parameters:
standardstandard

Sets the title
Created in NX6.0.0.



License requirements : None

Parameters:
titletitle

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



License requirements : None

Parameters:
tolerancetolerance

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



License requirements : None

Parameters:
toleranceTypetolerancetype

Returns the single roughness value
Created in NX8.0.0.



License requirements : None

Returns the standard
Created in NX6.0.0.



License requirements : None

Returns the title
Created in NX6.0.0.



License requirements : None

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



License requirements : None

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 2011 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.