NX Open C++ Reference Guide
Public Member Functions
NXOpen::CAM::HolderSectionBuilder Class Reference

Represents a Holder Section Builder
Created in NX5.0.0. More...

Inheritance diagram for NXOpen::CAM::HolderSectionBuilder:
NXOpen::TaggedObject

List of all members.

Public Member Functions

int Add (int inputIndex, double diameter, double length, double taperAngle, double cornerRadius)
 Add a new holder section item.
int AddByUpperDiameter (int inputIndex, double lowerDiameter, double length, double upperDiameter, double cornerRadius)
 Add a new holder section item by upper diameter.
NXOpen::NXObjectCreate (double diameter, double length, double taperAngle, double cornerRadius)
 Create a new holder section item.
void Delete (NXOpen::NXObject *section)
 Delete an existing holder section item
Created in NX5.0.0.
void Delete (int index)
 Delete an existing holder section item by index
Created in NX6.0.0.
void Get (NXOpen::NXObject *section, double *diameter, double *length, double *taperAngle, double *cornerRadius)
 Get the values of an existing holder section item
Created in NX5.0.0.
void GetAllParameters (NXOpen::NXObject *section, double *lowerDiameter, double *length, double *taperAngle, double *upperDiameter, double *cornerRadius)
 Get the values of an existing holder section item, include upper diameter
Created in NX8.0.0.
NXOpen::NXObjectGetSection (int position)
 Get a specific holder section.
void Modify (NXOpen::NXObject *section, double diameter, double length, double taperAngle, double cornerRadius)
 Modify an existing holder section item
Created in NX5.0.0.
void Modify (int index, double diameter, double length, double taperAngle, double cornerRadius)
 Modify an existing holder section item by index
Created in NX6.0.0.
void ModifyByUpperDiameter (int index, double lowerDiameter, double length, double upperDiameter, double cornerRadius)
 Modify an existing holder section item by upper diameter
Created in NX8.0.0.
void MoveDown (int index)
 Move down a holder section item
Created in NX6.0.0.
void MoveUp (int index)
 Move up a holder section item
Created in NX6.0.0.
int NumberOfSections ()
 Returns the number of holder sections
Created in NX5.0.0.
NXOpen::CAM::InheritableDoubleBuilderTlHolderOffsetBuilder ()
 Returns the Offset (inheritable double)
Created in NX5.0.0.

Detailed Description

Represents a Holder Section Builder
Created in NX5.0.0.



Member Function Documentation

int NXOpen::CAM::HolderSectionBuilder::Add ( int  inputIndex,
double  diameter,
double  length,
double  taperAngle,
double  cornerRadius 
)

Add a new holder section item.

Returns:
output the new created item actual index,if error happens, output will be -1
Created in NX6.0.0.

License requirements : cam_base ("CAM BASE")
Parameters:
inputIndexinput the new created item index
diameterthe diameter
lengththe length
taperAnglethe taper angle
cornerRadiusthe corner radius
int NXOpen::CAM::HolderSectionBuilder::AddByUpperDiameter ( int  inputIndex,
double  lowerDiameter,
double  length,
double  upperDiameter,
double  cornerRadius 
)

Add a new holder section item by upper diameter.

Returns:
output the new created item actual index,if error happens, output will be -1
Created in NX8.0.0.

License requirements : cam_base ("CAM BASE")
Parameters:
inputIndexinput the new created item index
lowerDiameterthe lower diameter
lengththe length
upperDiameterthe upper diameter
cornerRadiusthe corner radius
NXOpen::NXObject* NXOpen::CAM::HolderSectionBuilder::Create ( double  diameter,
double  length,
double  taperAngle,
double  cornerRadius 
)

Create a new holder section item.

Returns:
input the current selected item pointer and return new created item pointer. if list is empty, should input NULL
Created in NX5.0.0.

License requirements : cam_base ("CAM BASE")
Parameters:
diameterthe diameter
lengththe length
taperAnglethe taper angle
cornerRadiusthe corner radius

Delete an existing holder section item
Created in NX5.0.0.



License requirements : cam_base ("CAM BASE")

Parameters:
sectionthe pointer of deleted holder section

Delete an existing holder section item by index
Created in NX6.0.0.



License requirements : cam_base ("CAM BASE")

Parameters:
indexthe index of deleted holder section
void NXOpen::CAM::HolderSectionBuilder::Get ( NXOpen::NXObject section,
double *  diameter,
double *  length,
double *  taperAngle,
double *  cornerRadius 
)

Get the values of an existing holder section item
Created in NX5.0.0.



License requirements : cam_base ("CAM BASE")

Parameters:
sectionthe section
diameterthe diameter
lengththe length
taperAnglethe taper angle
cornerRadiusthe corner radius
void NXOpen::CAM::HolderSectionBuilder::GetAllParameters ( NXOpen::NXObject section,
double *  lowerDiameter,
double *  length,
double *  taperAngle,
double *  upperDiameter,
double *  cornerRadius 
)

Get the values of an existing holder section item, include upper diameter
Created in NX8.0.0.



License requirements : None

Parameters:
sectionthe section
lowerDiameterthe lower diameter
lengththe length
taperAnglethe taper angle
upperDiameterthe upper diameter
cornerRadiusthe corner radius

Get a specific holder section.

Returns:
the section
Created in NX5.0.0.

License requirements : cam_base ("CAM BASE")
Parameters:
positionindex in array
void NXOpen::CAM::HolderSectionBuilder::Modify ( NXOpen::NXObject section,
double  diameter,
double  length,
double  taperAngle,
double  cornerRadius 
)

Modify an existing holder section item
Created in NX5.0.0.



License requirements : cam_base ("CAM BASE")

Parameters:
sectionthe pointer of modified holder section
diameterthe diameter
lengththe length
taperAnglethe taper angle
cornerRadiusthe corner radius
void NXOpen::CAM::HolderSectionBuilder::Modify ( int  index,
double  diameter,
double  length,
double  taperAngle,
double  cornerRadius 
)

Modify an existing holder section item by index
Created in NX6.0.0.



License requirements : cam_base ("CAM BASE")

Parameters:
indexthe index of modified holder section
diameterthe diameter
lengththe length
taperAnglethe taper angle
cornerRadiusthe corner radius
void NXOpen::CAM::HolderSectionBuilder::ModifyByUpperDiameter ( int  index,
double  lowerDiameter,
double  length,
double  upperDiameter,
double  cornerRadius 
)

Modify an existing holder section item by upper diameter
Created in NX8.0.0.



License requirements : cam_base ("CAM BASE")

Parameters:
indexthe index of modified holder section
lowerDiameterthe lower diameter
lengththe length
upperDiameterthe upper diameter
cornerRadiusthe corner radius

Move down a holder section item
Created in NX6.0.0.



License requirements : None

Parameters:
indexthe index of item which should be moved down

Move up a holder section item
Created in NX6.0.0.



License requirements : None

Parameters:
indexthe index of item which should be moved up

Returns the number of holder sections
Created in NX5.0.0.



License requirements : cam_base ("CAM BASE")

Returns the Offset (inheritable double)
Created in NX5.0.0.



License requirements : cam_base ("CAM BASE")


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