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

Represents a Tooling::StockSizeBuilder builder. More...

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

Public Types

enum  Cylinder { CylinderCircumscribed, CylinderInscribedCircle }
 Represents the base circle type of cylinder. More...
 
enum  Shape { ShapeBlock, ShapeCylinder }
 Represents the shape of stock size. More...
 

Public Member Functions

NXOpen::ExpressionClearance ()
 Returns the clearance of the stocksize.
 
void CreateRefCsys (const NXOpen::Point3d &inputOrigin, const NXOpen::Matrix3x3 &inputMatrix)
 Creates the reference csys for stock size.
 
NXOpen::Tooling::StockSizeBuilder::Cylinder CylinderType ()
 Returns the cylinder type to generate a cylinder for the stock size.
 
void EditStockSizeAttr (NXOpen::NXObject *workPart)
 Add or edit stock size attributes.
 
void ModifyRefCsys (const NXOpen::Point3d &inputOrigin, const NXOpen::Matrix3x3 &inputMatrix)
 Modifies the reference csys for stock size.
 
NXOpen::CoordinateSystemRefCsys ()
 Returns the reference csys to calculate stocksize.
 
NXOpen::SelectBodyListSelectBody ()
 Returns the selected body to calculate a bounding box for stock size.
 
void SetCylinderType (NXOpen::Tooling::StockSizeBuilder::Cylinder enumCylinderType)
 Sets the cylinder type to generate a cylinder for the stock size.
 
void SetRefCsys (NXOpen::CoordinateSystem *refCsys)
 Sets the reference csys to calculate stocksize.
 
void SetSizePrecision (int integerPrecision)
 Sets the size precision of the stock.
 
void SetStockType (NXOpen::Tooling::StockSizeBuilder::Shape enumStockType)
 Sets the stock shape to be generated, it can be a box or cylinder.
 
void SetStringStock (const NXString &stringStock)
 Sets the stock size string, it is seperated by " X ".
 
void SetStringStock (const char *stringStock)
 Sets the stock size string, it is seperated by " X ".
 
int SizePrecision ()
 Returns the size precision of the stock.
 
NXOpen::Tooling::StockSizeBuilder::Shape StockType ()
 Returns the stock shape to be generated, it can be a box or cylinder.
 
NXString StringStock ()
 Returns the stock size string, it is seperated by " X ".
 
- Public Member Functions inherited from NXOpen::Builder
NXOpen::NXObjectCommit ()
 Commits any edits that have been applied to the builder.
 
void Destroy ()
 Deletes the builder, and cleans up any objects created by the builder.
 
std::vector< NXOpen::NXObject * > GetCommittedObjects ()
 For builders that create more than one object, this method returns the objects that are created by commit.
 
NXOpen::NXObjectGetObject ()
 Returns the object currently being edited by this builder.
 
void ShowResults ()
 Updates the model to reflect the result of an edit to the model for all builders that support showing results.
 
virtual bool Validate ()
 Validate whether the inputs to the component are sufficient for commit to be called.
 
- Public Member Functions inherited from NXOpen::TaggedObject
tag_t GetTag () const
 
<b>Deprecated</b>:<br>

   Use Tag instead.

 
tag_t Tag () const
 Returns the tag of this object.
 

Detailed Description

Represents a Tooling::StockSizeBuilder builder.


To create a new instance of this class, use Tooling::StockSizeCollection::CreateStocksizeBuilder
Default values.

Property Value

Clearance.Value

0 (millimeters part), 0 (inches part)

CylinderType

Circumscribed

SizePrecision

0

StockType

Block


Created in NX6.0.0.

Member Enumeration Documentation

Represents the base circle type of cylinder.

Enumerator:
CylinderCircumscribed 

circumcircle based cylinder

CylinderInscribedCircle 

inscribed circle based cylinder

Represents the shape of stock size.

Enumerator:
ShapeBlock 

The shape is a block.

ShapeCylinder 

The shape is a cylinder.

Member Function Documentation

NXOpen::Expression* NXOpen::Tooling::StockSizeBuilder::Clearance ( )

Returns the clearance of the stocksize.


Created in NX8.0.0.

License requirements : None

void NXOpen::Tooling::StockSizeBuilder::CreateRefCsys ( const NXOpen::Point3d inputOrigin,
const NXOpen::Matrix3x3 inputMatrix 
)

Creates the reference csys for stock size.


Created in NX8.0.0.

License requirements : None

Parameters
inputOrigininputorigin
inputMatrixinputmatrix
NXOpen::Tooling::StockSizeBuilder::Cylinder NXOpen::Tooling::StockSizeBuilder::CylinderType ( )

Returns the cylinder type to generate a cylinder for the stock size.


Created in NX6.0.0.

License requirements : None

void NXOpen::Tooling::StockSizeBuilder::EditStockSizeAttr ( NXOpen::NXObject workPart)

Add or edit stock size attributes.


Created in NX8.0.0.

License requirements : None

Parameters
workPartworkpart
void NXOpen::Tooling::StockSizeBuilder::ModifyRefCsys ( const NXOpen::Point3d inputOrigin,
const NXOpen::Matrix3x3 inputMatrix 
)

Modifies the reference csys for stock size.


Created in NX8.0.0.

License requirements : None

Parameters
inputOrigininputorigin
inputMatrixinputmatrix
NXOpen::CoordinateSystem* NXOpen::Tooling::StockSizeBuilder::RefCsys ( )

Returns the reference csys to calculate stocksize.


Created in NX8.0.0.

License requirements : None

NXOpen::SelectBodyList* NXOpen::Tooling::StockSizeBuilder::SelectBody ( )

Returns the selected body to calculate a bounding box for stock size.


Created in NX6.0.0.

License requirements : None

void NXOpen::Tooling::StockSizeBuilder::SetCylinderType ( NXOpen::Tooling::StockSizeBuilder::Cylinder  enumCylinderType)

Sets the cylinder type to generate a cylinder for the stock size.


Created in NX6.0.0.

License requirements : None

Parameters
enumCylinderTypeenumcylindertype
void NXOpen::Tooling::StockSizeBuilder::SetRefCsys ( NXOpen::CoordinateSystem refCsys)

Sets the reference csys to calculate stocksize.


Created in NX8.0.0.

License requirements : None

Parameters
refCsysrefcsys
void NXOpen::Tooling::StockSizeBuilder::SetSizePrecision ( int  integerPrecision)

Sets the size precision of the stock.


Created in NX6.0.0.

License requirements : None

Parameters
integerPrecisionintegerprecision
void NXOpen::Tooling::StockSizeBuilder::SetStockType ( NXOpen::Tooling::StockSizeBuilder::Shape  enumStockType)

Sets the stock shape to be generated, it can be a box or cylinder.


Created in NX6.0.0.

License requirements : None

Parameters
enumStockTypeenumstocktype
void NXOpen::Tooling::StockSizeBuilder::SetStringStock ( const NXString stringStock)

Sets the stock size string, it is seperated by " X ".


Created in NX6.0.0.

License requirements : None

Parameters
stringStockstringstock
void NXOpen::Tooling::StockSizeBuilder::SetStringStock ( const char *  stringStock)

Sets the stock size string, it is seperated by " X ".


Created in NX6.0.0.

License requirements : None

Parameters
stringStockstringstock
int NXOpen::Tooling::StockSizeBuilder::SizePrecision ( )

Returns the size precision of the stock.


Created in NX6.0.0.

License requirements : None

NXOpen::Tooling::StockSizeBuilder::Shape NXOpen::Tooling::StockSizeBuilder::StockType ( )

Returns the stock shape to be generated, it can be a box or cylinder.


Created in NX6.0.0.

License requirements : None

NXString NXOpen::Tooling::StockSizeBuilder::StringStock ( )

Returns the stock size string, it is seperated by " X ".


Created in NX6.0.0.

License requirements : None


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