NX Open C++ Reference Guide
Public Types | Public Member Functions | List of all members
NXOpen::Features::SheetMetal::HoleTreatmentBuilder Class Reference

The HoleTreatmentBuilder class is used to manage a builder object for a hole treatment in the flat pattern dialogs. More...

Inheritance diagram for NXOpen::Features::SheetMetal::HoleTreatmentBuilder:
NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Types

enum  TreatmentType { TreatmentTypeNone, TreatmentTypeCentermark }
 Hole Treatment Type. More...
 

Public Member Functions

NXOpen::ExpressionDiameter ()
 Returns the hole diameter value associated with the treatment type
Created in NX12.0.0. More...
 
void SetTreatment (NXOpen::Features::SheetMetal::HoleTreatmentBuilder::TreatmentType treatmentType)
 Sets the treatment type option menu value
Created in NX12.0.0. More...
 
void SetUseGlobal (bool useGlobal)
 Sets the use global toggle value
Created in NX12.0.0. More...
 
NXOpen::Features::SheetMetal::HoleTreatmentBuilder::TreatmentType Treatment ()
 Returns the treatment type option menu value
Created in NX12.0.0. More...
 
bool UseGlobal ()
 Returns the use global toggle value
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

The HoleTreatmentBuilder class is used to manage a builder object for a hole treatment in the flat pattern dialogs.

It includes properties and an enumeration type for a flag that indicates whether the global (flat pattern preferences) value is to be used, an enumeration type that indicates what type of hole treatment to apply, and an expression to indicate the diameter value associated with treatment type.


Created in NX12.0.0.

Member Enumeration Documentation

Hole Treatment Type.

Enumerator
TreatmentTypeNone 

none

TreatmentTypeCentermark 

centermark

Member Function Documentation

NXOpen::Expression* NXOpen::Features::SheetMetal::HoleTreatmentBuilder::Diameter ( )

Returns the hole diameter value associated with the treatment type
Created in NX12.0.0.



License requirements : None

void NXOpen::Features::SheetMetal::HoleTreatmentBuilder::SetTreatment ( NXOpen::Features::SheetMetal::HoleTreatmentBuilder::TreatmentType  treatmentType)

Sets the treatment type option menu value
Created in NX12.0.0.



License requirements : nx_sheet_metal ("NX Sheet Metal") OR nx_flexible_pcb ("NX Flexible PCB")

Parameters
treatmentTypetreatmenttype
void NXOpen::Features::SheetMetal::HoleTreatmentBuilder::SetUseGlobal ( bool  useGlobal)

Sets the use global toggle value
Created in NX12.0.0.



License requirements : nx_sheet_metal ("NX Sheet Metal") OR nx_flexible_pcb ("NX Flexible PCB")

Parameters
useGlobaluseglobal
NXOpen::Features::SheetMetal::HoleTreatmentBuilder::TreatmentType NXOpen::Features::SheetMetal::HoleTreatmentBuilder::Treatment ( )

Returns the treatment type option menu value
Created in NX12.0.0.



License requirements : None

bool NXOpen::Features::SheetMetal::HoleTreatmentBuilder::UseGlobal ( )

Returns the use global toggle value
Created in NX12.0.0.



License requirements : None

virtual bool NXOpen::Features::SheetMetal::HoleTreatmentBuilder::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.