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

Progressive Die Wizard blank layout builder
To create a new instance of this class, use NXOpen::Tooling::BlankLayoutCollection::CreateBlankLayoutBuilder
Default values. More...

Inheritance diagram for NXOpen::Tooling::BlankLayoutBuilder:
NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Types

enum  LeftRightSideOption { LeftRightSideOptionAverage, LeftRightSideOptionLeft, LeftRightSideOptionRight }
 Specifies the option of left right side type. More...
 
enum  SideWebOption { SideWebOptionAverage, SideWebOptionBottom, SideWebOptionTop }
 Specifies the option of side webs type. More...
 
enum  SnapSizeOption {
  SnapSizeOptionTenth, SnapSizeOptionFifth, SnapSizeOptionHalf, SnapSizeOptionOne,
  SnapSizeOptionTwo, SnapSizeOptionFive, SnapSizeOptionTen
}
 Specifies the option of snap size. More...
 
enum  Types {
  TypesCreateLayout, TypesAddBlank, TypesCopyBlank, TypesRemoveBlank,
  TypesSetBasePoint, TypesFlipBlank
}
 Specifies the option of blank layout type. More...
 

Public Member Functions

NXOpen::PointBasePoint ()
 Returns the base point. More...
 
NXOpen::SelectBodyBlank ()
 Returns the blank. More...
 
NXString BlankNameStr ()
 Returns the selected blank name. More...
 
double Bottom ()
 Returns the bottom boundary distance between blank and strip. More...
 
double LeftDistance ()
 Returns the left boudary distance between blank and strip. More...
 
NXOpen::Tooling::BlankLayoutBuilder::LeftRightSideOption LeftRightSide ()
 Returns the type of use left or right side to decide the distance between blank and strip. More...
 
bool LockPitchAndWidth ()
 Returns the lock pitch and width values from being changed during processing. More...
 
NXString MaterialUtilization ()
 Returns the material utilization of the blank. More...
 
bool MinimumSpaceSize ()
 Returns the option to report minimum space size or not. More...
 
NXString MinimumSpaceSizeValue ()
 Returns the minimum distance between the adjacent blanks. More...
 
double Pitch ()
 Returns the distance between the adjacent stations. More...
 
double RightDistance ()
 Returns the right boundary distance between blank and strip. More...
 
double Rotate ()
 Returns the value to rotate the blank around the base point. More...
 
void SetBasePoint (NXOpen::Point *point)
 Sets the base point. More...
 
void SetBlankNameStr (const NXString &blankNameStr)
 Sets the selected blank name. More...
 
void SetBlankNameStr (const char *blankNameStr)
 Sets the selected blank name. More...
 
void SetBottom (double bottom)
 Sets the bottom boundary distance between blank and strip. More...
 
void SetLeftDistance (double leftDistance)
 Sets the left boudary distance between blank and strip. More...
 
void SetLeftRightSide (NXOpen::Tooling::BlankLayoutBuilder::LeftRightSideOption leftRightSide)
 Sets the type of use left or right side to decide the distance between blank and strip. More...
 
void SetLockPitchAndWidth (bool lockPitchAndWidth)
 Sets the lock pitch and width values from being changed during processing. More...
 
void SetMaterialUtilization (const NXString &materialUtilization)
 Sets the material utilization of the blank. More...
 
void SetMaterialUtilization (const char *materialUtilization)
 Sets the material utilization of the blank. More...
 
void SetMinimumSpaceSize (bool minimumSpaceSize)
 Sets the option to report minimum space size or not. More...
 
void SetMinimumSpaceSizeValue (const NXString &minimumSpaceSizeValue)
 Sets the minimum distance between the adjacent blanks. More...
 
void SetMinimumSpaceSizeValue (const char *minimumSpaceSizeValue)
 Sets the minimum distance between the adjacent blanks. More...
 
void SetPitch (double pitch)
 Sets the distance between the adjacent stations. More...
 
void SetRightDistance (double rightDistance)
 Sets the right boundary distance between blank and strip. More...
 
void SetRotate (double rotate)
 Sets the value to rotate the blank around the base point. More...
 
void SetSideWeb (NXOpen::Tooling::BlankLayoutBuilder::SideWebOption sideWeb)
 Sets the type of the overlap on the strip. More...
 
void SetSnapSize (NXOpen::Tooling::BlankLayoutBuilder::SnapSizeOption snapSize)
 Sets the option to set the increment of the scale bar. More...
 
void SetThreeBlanks (bool threeBlanks)
 Sets the usage of three blanks or one blank. More...
 
void SetTop (double top)
 Sets the top boudary distance between blank and strip. More...
 
void SetType (NXOpen::Tooling::BlankLayoutBuilder::Types type)
 Sets the blank layout type. More...
 
void SetWidth (double width)
 Sets the width of the strip. More...
 
void SetXShift (double xShift)
 Sets the value to shift the blank in the X direction. More...
 
void SetYShift (double yShift)
 Sets the value to shift the blank in the Y direction. More...
 
NXOpen::Tooling::BlankLayoutBuilder::SideWebOption SideWeb ()
 Returns the type of the overlap on the strip. More...
 
NXOpen::Tooling::BlankLayoutBuilder::SnapSizeOption SnapSize ()
 Returns the option to set the increment of the scale bar. More...
 
bool ThreeBlanks ()
 Returns the usage of three blanks or one blank. More...
 
double Top ()
 Returns the top boudary distance between blank and strip. More...
 
NXOpen::Tooling::BlankLayoutBuilder::Types Type ()
 Returns the blank layout type. More...
 
double Width ()
 Returns the width of the strip. More...
 
double XShift ()
 Returns the value to shift the blank in the X direction. More...
 
double YShift ()
 Returns the value to shift the blank in the Y direction. More...
 
- Public Member Functions inherited from NXOpen::Builder
NXOpen::NXObjectCommit ()
 Commits any edits that have been applied to the builder. More...
 
void Destroy ()
 Deletes the builder, and cleans up any objects created by the builder. More...
 
std::vector< NXOpen::NXObject * > GetCommittedObjects ()
 For builders that create more than one object, this method returns the objects that are created by commit. More...
 
NXOpen::NXObjectGetObject ()
 Returns the object currently being edited by this builder. More...
 
void ShowResults ()
 Updates the model to reflect the result of an edit to the model for all builders that support showing results. 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

Progressive Die Wizard blank layout builder
To create a new instance of this class, use NXOpen::Tooling::BlankLayoutCollection::CreateBlankLayoutBuilder
Default values.

Property Value

Bottom

0

LeftDistance

0

LeftRightSide

Average

LockPitchAndWidth

0

MinimumSpaceSize

0

Pitch

0

RightDistance

0

Rotate

0

SideWeb

Average

SnapSize

One

ThreeBlanks

0

Top

0

Width

0

XShift

0

YShift

0


Created in NX7.5.0.

Member Enumeration Documentation

Specifies the option of left right side type.

Enumerator
LeftRightSideOptionAverage 

the left right side type of average

LeftRightSideOptionLeft 

the left side type

LeftRightSideOptionRight 

the right side type

Specifies the option of side webs type.

Enumerator
SideWebOptionAverage 

the side webs type of average

SideWebOptionBottom 

the side webs type of bottom

SideWebOptionTop 

the side webs type of top

Specifies the option of snap size.

Enumerator
SnapSizeOptionTenth 

the snap size is 0.1

SnapSizeOptionFifth 

the snap size is 0.2

SnapSizeOptionHalf 

the snap size is 1/2

SnapSizeOptionOne 

the snap size is 1

SnapSizeOptionTwo 

the snap size is 2

SnapSizeOptionFive 

the snap size is 5

SnapSizeOptionTen 

the snap size is 10

Specifies the option of blank layout type.

Enumerator
TypesCreateLayout 

the type of create blank layout

TypesAddBlank 

the type of add multiple blank

TypesCopyBlank 

the type of copy blank

TypesRemoveBlank 

the type of remove blank

TypesSetBasePoint 

the type of set the base point of the blank

TypesFlipBlank 

the type of flip blank

Member Function Documentation

NXOpen::Point* NXOpen::Tooling::BlankLayoutBuilder::BasePoint ( )

Returns the base point.


Created in NX7.5.0.

License requirements : None

NXOpen::SelectBody* NXOpen::Tooling::BlankLayoutBuilder::Blank ( )

Returns the blank.


Created in NX7.5.0.

License requirements : None

NXString NXOpen::Tooling::BlankLayoutBuilder::BlankNameStr ( )

Returns the selected blank name.


Created in NX7.5.0.

License requirements : None

double NXOpen::Tooling::BlankLayoutBuilder::Bottom ( )

Returns the bottom boundary distance between blank and strip.


Created in NX7.5.0.

License requirements : None

double NXOpen::Tooling::BlankLayoutBuilder::LeftDistance ( )

Returns the left boudary distance between blank and strip.


Created in NX8.0.0.

License requirements : None

NXOpen::Tooling::BlankLayoutBuilder::LeftRightSideOption NXOpen::Tooling::BlankLayoutBuilder::LeftRightSide ( )

Returns the type of use left or right side to decide the distance between blank and strip.


Created in NX8.0.0.

License requirements : None

bool NXOpen::Tooling::BlankLayoutBuilder::LockPitchAndWidth ( )

Returns the lock pitch and width values from being changed during processing.


Created in NX7.5.0.

License requirements : None

NXString NXOpen::Tooling::BlankLayoutBuilder::MaterialUtilization ( )

Returns the material utilization of the blank.


Created in NX7.5.0.

License requirements : None

bool NXOpen::Tooling::BlankLayoutBuilder::MinimumSpaceSize ( )

Returns the option to report minimum space size or not.


Created in NX7.5.0.

License requirements : None

NXString NXOpen::Tooling::BlankLayoutBuilder::MinimumSpaceSizeValue ( )

Returns the minimum distance between the adjacent blanks.


Created in NX7.5.0.

License requirements : None

double NXOpen::Tooling::BlankLayoutBuilder::Pitch ( )

Returns the distance between the adjacent stations.


Created in NX7.5.0.

License requirements : None

double NXOpen::Tooling::BlankLayoutBuilder::RightDistance ( )

Returns the right boundary distance between blank and strip.


Created in NX8.0.0.

License requirements : None

double NXOpen::Tooling::BlankLayoutBuilder::Rotate ( )

Returns the value to rotate the blank around the base point.


Created in NX7.5.0.

License requirements : None

void NXOpen::Tooling::BlankLayoutBuilder::SetBasePoint ( NXOpen::Point point)

Sets the base point.


Created in NX7.5.0.

License requirements : None

Parameters
pointpoint
void NXOpen::Tooling::BlankLayoutBuilder::SetBlankNameStr ( const NXString blankNameStr)

Sets the selected blank name.


Created in NX7.5.0.

License requirements : None

Parameters
blankNameStrSets the blank name
void NXOpen::Tooling::BlankLayoutBuilder::SetBlankNameStr ( const char *  blankNameStr)

Sets the selected blank name.


Created in NX7.5.0.

License requirements : None

Parameters
blankNameStrSets the blank name
void NXOpen::Tooling::BlankLayoutBuilder::SetBottom ( double  bottom)

Sets the bottom boundary distance between blank and strip.


Created in NX7.5.0.

License requirements : None

Parameters
bottombottom
void NXOpen::Tooling::BlankLayoutBuilder::SetLeftDistance ( double  leftDistance)

Sets the left boudary distance between blank and strip.


Created in NX8.0.0.

License requirements : None

Parameters
leftDistanceleftdistance
void NXOpen::Tooling::BlankLayoutBuilder::SetLeftRightSide ( NXOpen::Tooling::BlankLayoutBuilder::LeftRightSideOption  leftRightSide)

Sets the type of use left or right side to decide the distance between blank and strip.


Created in NX8.0.0.

License requirements : None

Parameters
leftRightSideleftrightside
void NXOpen::Tooling::BlankLayoutBuilder::SetLockPitchAndWidth ( bool  lockPitchAndWidth)

Sets the lock pitch and width values from being changed during processing.


Created in NX7.5.0.

License requirements : None

Parameters
lockPitchAndWidthlockpitchandwidth
void NXOpen::Tooling::BlankLayoutBuilder::SetMaterialUtilization ( const NXString materialUtilization)

Sets the material utilization of the blank.


Created in NX7.5.0.

License requirements : None

Parameters
materialUtilizationmaterialutilization
void NXOpen::Tooling::BlankLayoutBuilder::SetMaterialUtilization ( const char *  materialUtilization)

Sets the material utilization of the blank.


Created in NX7.5.0.

License requirements : None

Parameters
materialUtilizationmaterialutilization
void NXOpen::Tooling::BlankLayoutBuilder::SetMinimumSpaceSize ( bool  minimumSpaceSize)

Sets the option to report minimum space size or not.


Created in NX7.5.0.

License requirements : None

Parameters
minimumSpaceSizeminimumspacesize
void NXOpen::Tooling::BlankLayoutBuilder::SetMinimumSpaceSizeValue ( const NXString minimumSpaceSizeValue)

Sets the minimum distance between the adjacent blanks.


Created in NX7.5.0.

License requirements : None

Parameters
minimumSpaceSizeValueminimumspacesizevalue
void NXOpen::Tooling::BlankLayoutBuilder::SetMinimumSpaceSizeValue ( const char *  minimumSpaceSizeValue)

Sets the minimum distance between the adjacent blanks.


Created in NX7.5.0.

License requirements : None

Parameters
minimumSpaceSizeValueminimumspacesizevalue
void NXOpen::Tooling::BlankLayoutBuilder::SetPitch ( double  pitch)

Sets the distance between the adjacent stations.


Created in NX7.5.0.

License requirements : None

Parameters
pitchpitch
void NXOpen::Tooling::BlankLayoutBuilder::SetRightDistance ( double  rightDistance)

Sets the right boundary distance between blank and strip.


Created in NX8.0.0.

License requirements : None

Parameters
rightDistancerightdistance
void NXOpen::Tooling::BlankLayoutBuilder::SetRotate ( double  rotate)

Sets the value to rotate the blank around the base point.


Created in NX7.5.0.

License requirements : None

Parameters
rotaterotate
void NXOpen::Tooling::BlankLayoutBuilder::SetSideWeb ( NXOpen::Tooling::BlankLayoutBuilder::SideWebOption  sideWeb)

Sets the type of the overlap on the strip.


Created in NX7.5.0.

License requirements : None

Parameters
sideWebsideweb
void NXOpen::Tooling::BlankLayoutBuilder::SetSnapSize ( NXOpen::Tooling::BlankLayoutBuilder::SnapSizeOption  snapSize)

Sets the option to set the increment of the scale bar.


Created in NX7.5.0.

License requirements : None

Parameters
snapSizesnapsize
void NXOpen::Tooling::BlankLayoutBuilder::SetThreeBlanks ( bool  threeBlanks)

Sets the usage of three blanks or one blank.


Created in NX8.0.0.

License requirements : None

Parameters
threeBlanksthreeblanks
void NXOpen::Tooling::BlankLayoutBuilder::SetTop ( double  top)

Sets the top boudary distance between blank and strip.


Created in NX7.5.0.

License requirements : None

Parameters
toptop
void NXOpen::Tooling::BlankLayoutBuilder::SetType ( NXOpen::Tooling::BlankLayoutBuilder::Types  type)

Sets the blank layout type.


Created in NX7.5.0.

License requirements : None

Parameters
typetype
void NXOpen::Tooling::BlankLayoutBuilder::SetWidth ( double  width)

Sets the width of the strip.


Created in NX7.5.0.

License requirements : None

Parameters
widthwidth
void NXOpen::Tooling::BlankLayoutBuilder::SetXShift ( double  xShift)

Sets the value to shift the blank in the X direction.


Created in NX7.5.0.

License requirements : None

Parameters
xShiftxshift
void NXOpen::Tooling::BlankLayoutBuilder::SetYShift ( double  yShift)

Sets the value to shift the blank in the Y direction.


Created in NX7.5.0.

License requirements : None

Parameters
yShiftyshift
NXOpen::Tooling::BlankLayoutBuilder::SideWebOption NXOpen::Tooling::BlankLayoutBuilder::SideWeb ( )

Returns the type of the overlap on the strip.


Created in NX7.5.0.

License requirements : None

NXOpen::Tooling::BlankLayoutBuilder::SnapSizeOption NXOpen::Tooling::BlankLayoutBuilder::SnapSize ( )

Returns the option to set the increment of the scale bar.


Created in NX7.5.0.

License requirements : None

bool NXOpen::Tooling::BlankLayoutBuilder::ThreeBlanks ( )

Returns the usage of three blanks or one blank.


Created in NX8.0.0.

License requirements : None

double NXOpen::Tooling::BlankLayoutBuilder::Top ( )

Returns the top boudary distance between blank and strip.


Created in NX7.5.0.

License requirements : None

NXOpen::Tooling::BlankLayoutBuilder::Types NXOpen::Tooling::BlankLayoutBuilder::Type ( )

Returns the blank layout type.


Created in NX7.5.0.

License requirements : None

double NXOpen::Tooling::BlankLayoutBuilder::Width ( )

Returns the width of the strip.


Created in NX7.5.0.

License requirements : None

double NXOpen::Tooling::BlankLayoutBuilder::XShift ( )

Returns the value to shift the blank in the X direction.


Created in NX7.5.0.

License requirements : None

double NXOpen::Tooling::BlankLayoutBuilder::YShift ( )

Returns the value to shift the blank in the Y direction.


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.