NX Open C++ Reference Guide
Public Types | Public Member Functions
NXOpen::Features::SheetMetal::NormalCutoutBuilder Class Reference

Represents a NormalCutout feature builder. More...

Inheritance diagram for NXOpen::Features::SheetMetal::NormalCutoutBuilder:
NXOpen::Features::SheetMetal::SheetmetalBaseBuilder NXOpen::Features::FeatureBuilder NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

List of all members.

Public Types

enum  CutTypeOptions { CutTypeOptionsThicknessCut, CutTypeOptionsMidPlaneCut }
 This enum represents the cut type for the normal cutout. More...
enum  DepthSideOptions { DepthSideOptionsSectionNormalSide, DepthSideOptionsSectionReverseNormalSide, DepthSideOptionsSymmetric }
 This enum represents the depth direction for the normal cutout. More...
enum  DepthTypeOptions { DepthTypeOptionsFinite, DepthTypeOptionsFromTo, DepthTypeOptionsThroughNext, DepthTypeOptionsThroughAll }
 This enum represents the depth type for the normal cutout. More...
enum  SectionSideOptions { SectionSideOptionsLeft, SectionSideOptionsRight }
 This enum represents the side of the section that the normal cutout removes material. More...
enum  TypeOptions { TypeOptionsSketchType, TypeOptionsNonPlanarCurveType }
 Represents the type of the normal cutout - sketch type OR 3D-curve type. More...

Public Member Functions

NXOpen::Features::SheetMetal::NormalCutoutBuilder::CutTypeOptions CutType ()
 Returns the cut type for the normal cutout.
NXOpen::ExpressionDepth ()
 Returns the depth of the cutout.
NXOpen::Features::SheetMetal::NormalCutoutBuilder::DepthSideOptions DepthSide ()
 Returns the depth side for the normal cutout.
NXOpen::Features::SheetMetal::NormalCutoutBuilder::DepthTypeOptions DepthType ()
 Returns the depth type for the normal cutout.
NXOpen::ISurfaceFrom ()
 Returns the face or datum plane from which the cutout begins.
NXOpen::SectionSection ()
 Returns the section used by the normal cutout.
NXOpen::Features::SheetMetal::NormalCutoutBuilder::SectionSideOptions SectionSide ()
 Returns the side of the section that the normal cutout removes material.
void SetCutType (NXOpen::Features::SheetMetal::NormalCutoutBuilder::CutTypeOptions cutType)
 Sets the cut type for the normal cutout.
void SetDepth (const NXString &depth)
 
Created in NX4.0.0.
void SetDepthSide (NXOpen::Features::SheetMetal::NormalCutoutBuilder::DepthSideOptions depthSide)
 Sets the depth side for the normal cutout.
void SetDepthType (NXOpen::Features::SheetMetal::NormalCutoutBuilder::DepthTypeOptions type)
 Sets the depth type for the normal cutout.
void SetFrom (NXOpen::ISurface *ffrom)
 Sets the face or datum plane from which the cutout begins.
void SetSection (NXOpen::Section *section)
 Sets the section used by the normal cutout.
void SetSectionSide (NXOpen::Features::SheetMetal::NormalCutoutBuilder::SectionSideOptions sectionSide)
 Sets the side of the section that the normal cutout removes material.
void SetSketch (NXOpen::Features::SketchFeature *sketch)
 Sets the internal sketch used by the normal cutout, if it exists.
void SetTo (NXOpen::ISurface *to)
 Sets the face or datum plane at which the cutout ends.
void SetType (NXOpen::Features::SheetMetal::NormalCutoutBuilder::TypeOptions type)
 Sets the type for the normal cutout.
NXOpen::Features::SketchFeatureSketch ()
 Returns the internal sketch used by the normal cutout, if it exists.
NXOpen::ISurfaceTo ()
 Returns the face or datum plane at which the cutout ends.
NXOpen::Features::SheetMetal::NormalCutoutBuilder::TypeOptions Type ()
 Returns the type for the normal cutout.
int ValidateBuilderData ()
 Verify that the builder data is valid for creating a normal cutout.

Detailed Description

Represents a NormalCutout feature builder.


To create a new instance of this class, use Features::SheetMetal::SheetmetalManager::CreateNormalCutoutFeatureBuilder

Created in NX4.0.0.


Member Enumeration Documentation

This enum represents the cut type for the normal cutout.

Enumerator:
CutTypeOptionsThicknessCut 

thickness cut

CutTypeOptionsMidPlaneCut 

mid plane cut

This enum represents the depth direction for the normal cutout.

Not used if the normal cutout is from-to.

Enumerator:
DepthSideOptionsSectionNormalSide 

Material removed on the side of the section normal.

DepthSideOptionsSectionReverseNormalSide 

Material removed on the side opposite to that of the section normal.

DepthSideOptionsSymmetric 

Material removed in both directions equally.

Only applies when the depth type is Features::SheetMetal::NormalCutoutBuilder::DepthTypeOptionsFinite .

This enum represents the depth type for the normal cutout.

Enumerator:
DepthTypeOptionsFinite 

Finite.

DepthTypeOptionsFromTo 

From To.

DepthTypeOptionsThroughNext 

Though Next.

DepthTypeOptionsThroughAll 

Through All.

This enum represents the side of the section that the normal cutout removes material.

The "left" option represents the side to the left of a person who is walking along the section in the direction of its curves when the section normal is pointing up. The "right" option represents the person's right hand side. This interpretation is the same regardless of whether the section is open or closed. The "right" side at any point along the section can also be represented by the vector resulting from the cross product of the curve tangent (of the section curve at that point) and the section normal. The "left" side is the opposite.

Enumerator:
SectionSideOptionsLeft 

Side pointed to by the inverse of the tangent cross normal vector.

SectionSideOptionsRight 

Side pointed to by the tangent cross normal vector.

Represents the type of the normal cutout - sketch type OR 3D-curve type.

Enumerator:
TypeOptionsSketchType 

Sketch type normal cutout.

TypeOptionsNonPlanarCurveType 

3D curves type normal cutout


Member Function Documentation

Returns the cut type for the normal cutout.

The options are in Features::SheetMetal::NormalCutoutBuilder::CutTypeOptions .


Created in NX4.0.0.

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

Returns the depth of the cutout.

Only applies when the depth type is Features::SheetMetal::NormalCutoutBuilder::DepthTypeOptionsFinite .
Created in NX4.0.0.

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

Returns the depth side for the normal cutout.

The options are in Features::SheetMetal::NormalCutoutBuilder::DepthSideOptions .


Created in NX4.0.0.

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

Returns the depth type for the normal cutout.

The options are in Features::SheetMetal::NormalCutoutBuilder::DepthTypeOptions .


Created in NX4.0.0.

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

Returns the face or datum plane from which the cutout begins.

This is only applicable if the depth type is Features::SheetMetal::NormalCutoutBuilder::DepthTypeOptionsFromTo
Created in NX4.0.0.

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

Returns the section used by the normal cutout.

It can be open or closed.
Created in NX4.0.0.

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

Returns the side of the section that the normal cutout removes material.

The options are in Features::SheetMetal::NormalCutoutBuilder::SectionSideOptions .


Created in NX4.0.0.

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

Sets the cut type for the normal cutout.

The options are in Features::SheetMetal::NormalCutoutBuilder::CutTypeOptions .


Created in NX4.0.0.

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

Parameters:
cutTypecut type


Created in NX4.0.0.



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

Parameters:
depth
NOTE: The full Unicode character set is not supported for this parameter.

Sets the depth side for the normal cutout.

The options are in Features::SheetMetal::NormalCutoutBuilder::DepthSideOptions .


Created in NX4.0.0.

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

Parameters:
depthSidedepth side

Sets the depth type for the normal cutout.

The options are in Features::SheetMetal::NormalCutoutBuilder::DepthTypeOptions .


Created in NX4.0.0.

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

Parameters:
typetype

Sets the face or datum plane from which the cutout begins.

This is only applicable if the depth type is Features::SheetMetal::NormalCutoutBuilder::DepthTypeOptionsFromTo
Created in NX4.0.0.

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

Parameters:
ffromFrom face or datum plane

Sets the section used by the normal cutout.

It can be open or closed.
Created in NX4.0.0.

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

Parameters:
sectionsection

Sets the side of the section that the normal cutout removes material.

The options are in Features::SheetMetal::NormalCutoutBuilder::SectionSideOptions .


Created in NX4.0.0.

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

Parameters:
sectionSidesection side

Sets the internal sketch used by the normal cutout, if it exists.


Created in NX4.0.0.

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

Parameters:
sketchsketch

Sets the face or datum plane at which the cutout ends.

This is only applicable if the depth type is Features::SheetMetal::NormalCutoutBuilder::DepthTypeOptionsFromTo
Created in NX4.0.0.

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

Parameters:
toTo face or datum plane

Sets the type for the normal cutout.

The options are in Features::SheetMetal::NormalCutoutBuilder::TypeOptions .


Created in NX6.0.0.

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

Parameters:
typetype

Returns the internal sketch used by the normal cutout, if it exists.


Created in NX4.0.0.

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

Returns the face or datum plane at which the cutout ends.

This is only applicable if the depth type is Features::SheetMetal::NormalCutoutBuilder::DepthTypeOptionsFromTo
Created in NX4.0.0.

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

Returns the type for the normal cutout.

The options are in Features::SheetMetal::NormalCutoutBuilder::TypeOptions .


Created in NX6.0.0.

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

Verify that the builder data is valid for creating a normal cutout.


If the builder data is valid, a value of 0 is returned.

Returns:
data validity flag (zero is valid, non-zero is invalid).
Created in NX4.0.0.

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

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