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

Represents a Jog feature builder. More...

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

List of all members.

Public Types

enum  BendLocationOptions { BendLocationOptionsMaterialInside, BendLocationOptionsMaterialOutside, BendLocationOptionsBendOutside }
 Represents the bend location type. More...
enum  DimensionTypeOptions { DimensionTypeOptionsOffset, DimensionTypeOptionsFull }
 the Dimension options for jog. More...
enum  DirectionTypeOptions { DirectionTypeOptionsSectionNormalSide, DirectionTypeOptionsSectionReverseNormalSide }
 this enum represents the direction for the Jog. More...
enum  FixedSideOptions { FixedSideOptionsSectionSideLeft, FixedSideOptionsSectionSideRight }
 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. More...

Public Member Functions

NXOpen::Features::SheetMetal::JogBuilder::BendLocationOptions BendLocation ()
 Returns
Created in NX5.0.0.
NXOpen::Features::SheetMetal::BendOptionsBendOptions ()
 Returns the bend options
Created in NX5.0.0.
NXOpen::Features::SheetMetal::JogBuilder::DimensionTypeOptions DimensionType ()
 Returns the Offset Dimension
The actual extent distance of the Jog will be determined by the active dimension option.
NXOpen::Features::SheetMetal::JogBuilder::DirectionTypeOptions DirectionType ()
 Returns
Created in NX5.0.0.
bool ExtendProfile ()
 Returns
Created in NX5.0.0.
NXOpen::Features::SheetMetal::JogBuilder::FixedSideOptions FixedSide ()
 Returns
Created in NX5.0.0.
NXOpen::ExpressionGetHeight ()
 Height of the Jog.
NXOpen::SectionSection ()
 Returns
Created in NX5.0.0.
void SetBendLocation (NXOpen::Features::SheetMetal::JogBuilder::BendLocationOptions bendLocation)
 Sets
Created in NX5.0.0.
void SetDimensionType (NXOpen::Features::SheetMetal::JogBuilder::DimensionTypeOptions dimensionType)
 Sets the Offset Dimension
The actual extent distance of the Jog will be determined by the active dimension option.
void SetDirectionType (NXOpen::Features::SheetMetal::JogBuilder::DirectionTypeOptions directionType)
 Sets
Created in NX5.0.0.
void SetExtendProfile (bool extendOption)
 Sets
Created in NX5.0.0.
void SetFixedSide (NXOpen::Features::SheetMetal::JogBuilder::FixedSideOptions sectionSide)
 Sets
Created in NX5.0.0.
void SetHeight (const NXString &height)
 
Created in NX5.0.0.
void SetSection (NXOpen::Section *section)
 Sets
Created in NX5.0.0.
void SetSketch (NXOpen::Features::SketchFeature *sketch)
 Sets
Created in NX5.0.0.
NXOpen::Features::SketchFeatureSketch ()
 Returns
Created in NX5.0.0.
int ValidateBuilderData ()
 Verify whether the builder data is valid for creating a jog or not.

Detailed Description

Represents a Jog feature builder.


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

Created in NX5.0.0.


Member Enumeration Documentation

Represents the bend location type.

Enumerator:
BendLocationOptionsMaterialInside 

material inside

BendLocationOptionsMaterialOutside 

material outside

BendLocationOptionsBendOutside 

bend outside

the Dimension options for jog.

This specifies whether the Jog's depth must be measured from the plane to which the section is attached or from the

Enumerator:
DimensionTypeOptionsOffset 

the actual depth will be depth plus the thickness of sheet.

DimensionTypeOptionsFull 

the actual extent distance will be the value specified as depth.

this enum represents the direction for the Jog.

Enumerator:
DirectionTypeOptionsSectionNormalSide 

jog created on the side of the section normal.

DirectionTypeOptionsSectionReverseNormalSide 

jog created on the side opposite to that of the section normal

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:
FixedSideOptionsSectionSideLeft 

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

FixedSideOptionsSectionSideRight 

Side pointed to by the tangent cross normal vector.


Member Function Documentation

Returns
Created in NX5.0.0.



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

Returns the bend options
Created in NX5.0.0.



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

Returns the Offset Dimension
The actual extent distance of the Jog will be determined by the active dimension option.

In case of Features::SheetMetal::JogBuilder::DimensionTypeOptionsOffset the actual extent distance will be offset dimension distance plus the thickness of sheet. In case of Features::SheetMetal::JogBuilder::DimensionTypeOptionsFull the actual extent distance will be the Full dimension distance.


Created in NX5.0.0.

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

Returns
Created in NX5.0.0.



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

Returns
Created in NX5.0.0.



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

Returns
Created in NX5.0.0.



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

Height of the Jog.

Returns:

Created in NX5.0.0.

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

Returns
Created in NX5.0.0.



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

Sets
Created in NX5.0.0.



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

Parameters:
bendLocationbend location

Sets the Offset Dimension
The actual extent distance of the Jog will be determined by the active dimension option.

In case of Features::SheetMetal::JogBuilder::DimensionTypeOptionsOffset the actual extent distance will be offset dimension distance plus the thickness of sheet. In case of Features::SheetMetal::JogBuilder::DimensionTypeOptionsFull the actual extent distance will be the Full dimension distance.


Created in NX5.0.0.

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

Parameters:
dimensionTypedimension type

Sets
Created in NX5.0.0.



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

Parameters:
directionTypedirection type

Sets
Created in NX5.0.0.



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

Parameters:
extendOptionextend option

Sets
Created in NX5.0.0.



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

Parameters:
sectionSidesection side


Created in NX5.0.0.



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

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

Sets
Created in NX5.0.0.



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

Parameters:
sectionsection

Sets
Created in NX5.0.0.



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

Parameters:
sketchsketch

Returns
Created in NX5.0.0.



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

Verify whether the builder data is valid for creating a jog or not.


If the Builder data is valid, returned value shall be 0


Returns:
Data Validity Flag.
Created in NX5.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.