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

Represents a MachinePocketGroup Builder
To create a new instance of this class, use NXOpen::CAM::NCGroupCollection::CreateMachinePocketGroupBuilder

Created in NX5.0.0. More...

Inheritance diagram for NXOpen::CAM::MachinePocketGroupBuilder:
NXOpen::CAM::NCGroupBuilder NXOpen::CAM::ParamBuilder NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Types

enum  RegisterType { RegisterTypeSameAsPocketId, RegisterTypeSpecify }
 the register type
More...
 

Public Member Functions

NXOpen::CAM::InheritableIntBuilderAdjustIdBuilder ()
 Returns the adjust id
Created in NX6.0.0. More...
 
NXOpen::CAM::MachinePocketGroupBuilder::RegisterType AdjustRegisterType ()
 Returns the adjust register type
More...
 
NXString ChannelName ()
 Returns the channel's name
Created in NX7.5.0. More...
 
NXOpen::CAM::HoldingSystemBuilderCreateHoldingSystemBuilder (int position, const NXString &name)
 Creates a new holding system builder. More...
 
NXOpen::CAM::HoldingSystemBuilderCreateHoldingSystemBuilder (int position, const char *name)
 Creates a new holding system builder. More...
 
NXOpen::CAM::InheritableIntBuilderCutcomIdBuilder ()
 Returns the cutcom id
Created in NX6.0.0. More...
 
NXOpen::CAM::MachinePocketGroupBuilder::RegisterType CutcomRegisterType ()
 Returns the cutcom register type
More...
 
NXOpen::CAM::HoldingSystemBuilderListHoldingSystemsList ()
 Returns the holding systems list
Created in NX6.0.0. More...
 
int NumberOfTools ()
 Returns the number of tools
Created in NX8.5.0. More...
 
NXOpen::CAM::InheritableIntBuilderPocketIdBuilder ()
 Returns the pocket id
Created in NX5.0.0. More...
 
NXOpen::CAM::InheritableTextBuilderPocketIdStringBuilder ()
 Returns the pocket id in string
Created in NX8.5.0. More...
 
void SetAdjustRegisterType (NXOpen::CAM::MachinePocketGroupBuilder::RegisterType type)
 Sets the adjust register type
More...
 
void SetChannelName (const NXString &name)
 Sets the channel's name
Created in NX7.5.0. More...
 
void SetChannelName (const char *name)
 Sets the channel's name
Created in NX7.5.0. More...
 
void SetCutcomRegisterType (NXOpen::CAM::MachinePocketGroupBuilder::RegisterType type)
 Sets the cutcom register type
More...
 
void SetNumberOfTools (int numTools)
 Sets the number of tools
Created in NX8.5.0. More...
 
- Public Member Functions inherited from NXOpen::CAM::NCGroupBuilder
NXString Description ()
 Returns the description
Created in NX9.0.0. More...
 
NXOpen::CAM::UdeSetEndUdeSet ()
 Returns the end ude set
Created in NX7.5.0. More...
 
void SetDescription (const NXString &description)
 Sets the description
Created in NX9.0.0. More...
 
void SetDescription (const char *description)
 Sets the description
Created in NX9.0.0. More...
 
NXOpen::CAM::UdeSetStartUdeSet ()
 Returns the start ude set
Created in NX7.5.0. More...
 
- Public Member Functions inherited from NXOpen::CAM::ParamBuilder
NXOpen::CAM::UdeCycleEvent ()
 Returns the cycle event
Created in NX7.5.0. More...
 
NXOpen::CAM::CycleCycleTable ()
 Returns the cycle
Created in NX9.0.0. More...
 
NXOpen::TaggedObjectGetCustomizableItemBuilder (const NXString &name)
 Returns the customizable item builder for the given customizable item name. More...
 
NXOpen::TaggedObjectGetCustomizableItemBuilder (const char *name)
 Returns the customizable item builder for the given customizable item name. More...
 
std::vector< NXStringGetCustomizableItemNames ()
 Returns the names for all customizable item ids. More...
 
NXOpen::CAM::ParamBuilder::OptimizationTypes OptimizationMethod ()
 Returns the optim method
Created in NX5.0.0. More...
 
void SetOptimizationMethod (NXOpen::CAM::ParamBuilder::OptimizationTypes optimMethod)
 Sets the optim method
Created in NX5.0.0. 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

Represents a MachinePocketGroup Builder
To create a new instance of this class, use NXOpen::CAM::NCGroupCollection::CreateMachinePocketGroupBuilder

Created in NX5.0.0.


Member Enumeration Documentation

the register type

Deprecated:
Deprecated in NX8.5.0.

This NXOpen::CAM::MachinePocketGroupBuilder::RegisterType is no longer supported.

Enumerator
RegisterTypeSameAsPocketId 

use same as pocket id

RegisterTypeSpecify 

use specify

Member Function Documentation

NXOpen::CAM::InheritableIntBuilder* NXOpen::CAM::MachinePocketGroupBuilder::AdjustIdBuilder ( )

Returns the adjust id
Created in NX6.0.0.



License requirements : None

NXOpen::CAM::MachinePocketGroupBuilder::RegisterType NXOpen::CAM::MachinePocketGroupBuilder::AdjustRegisterType ( )

Returns the adjust register type

Deprecated:
Deprecated in NX8.5.0.

Use CAM::MachinePocketGroupBuilder::AdjustIdBuilder instead.


Created in NX6.0.0.

License requirements : None

NXString NXOpen::CAM::MachinePocketGroupBuilder::ChannelName ( )

Returns the channel's name
Created in NX7.5.0.



License requirements : None

NXOpen::CAM::HoldingSystemBuilder* NXOpen::CAM::MachinePocketGroupBuilder::CreateHoldingSystemBuilder ( int  position,
const NXString name 
)

Creates a new holding system builder.

Returns
holding system builder
Created in NX6.0.0.

License requirements : None
Parameters
positionposition
nameHolding system name
NXOpen::CAM::HoldingSystemBuilder* NXOpen::CAM::MachinePocketGroupBuilder::CreateHoldingSystemBuilder ( int  position,
const char *  name 
)

Creates a new holding system builder.

Returns
holding system builder
Created in NX6.0.0.

License requirements : None
Parameters
positionposition
nameHolding system name
NXOpen::CAM::InheritableIntBuilder* NXOpen::CAM::MachinePocketGroupBuilder::CutcomIdBuilder ( )

Returns the cutcom id
Created in NX6.0.0.



License requirements : None

NXOpen::CAM::MachinePocketGroupBuilder::RegisterType NXOpen::CAM::MachinePocketGroupBuilder::CutcomRegisterType ( )

Returns the cutcom register type

Deprecated:
Deprecated in NX8.5.0.

Use CAM::MachinePocketGroupBuilder::CutcomIdBuilder instead.


Created in NX6.0.0.

License requirements : None

NXOpen::CAM::HoldingSystemBuilderList* NXOpen::CAM::MachinePocketGroupBuilder::HoldingSystemsList ( )

Returns the holding systems list
Created in NX6.0.0.



License requirements : None

int NXOpen::CAM::MachinePocketGroupBuilder::NumberOfTools ( )

Returns the number of tools
Created in NX8.5.0.



License requirements : None

NXOpen::CAM::InheritableIntBuilder* NXOpen::CAM::MachinePocketGroupBuilder::PocketIdBuilder ( )

Returns the pocket id
Created in NX5.0.0.



License requirements : None

NXOpen::CAM::InheritableTextBuilder* NXOpen::CAM::MachinePocketGroupBuilder::PocketIdStringBuilder ( )

Returns the pocket id in string
Created in NX8.5.0.



License requirements : None

void NXOpen::CAM::MachinePocketGroupBuilder::SetAdjustRegisterType ( NXOpen::CAM::MachinePocketGroupBuilder::RegisterType  type)

Sets the adjust register type

Deprecated:
Deprecated in NX8.5.0.

Use CAM::MachinePocketGroupBuilder::AdjustIdBuilder instead.


Created in NX6.0.0.

License requirements : cam_base ("CAM BASE")

Parameters
typetype
void NXOpen::CAM::MachinePocketGroupBuilder::SetChannelName ( const NXString name)

Sets the channel's name
Created in NX7.5.0.



License requirements : cam_base ("CAM BASE")

Parameters
namethe channel's name
void NXOpen::CAM::MachinePocketGroupBuilder::SetChannelName ( const char *  name)

Sets the channel's name
Created in NX7.5.0.



License requirements : cam_base ("CAM BASE")

Parameters
namethe channel's name
void NXOpen::CAM::MachinePocketGroupBuilder::SetCutcomRegisterType ( NXOpen::CAM::MachinePocketGroupBuilder::RegisterType  type)

Sets the cutcom register type

Deprecated:
Deprecated in NX8.5.0.

Use CAM::MachinePocketGroupBuilder::CutcomIdBuilder instead.


Created in NX6.0.0.

License requirements : cam_base ("CAM BASE")

Parameters
typetype
void NXOpen::CAM::MachinePocketGroupBuilder::SetNumberOfTools ( int  numTools)

Sets the number of tools
Created in NX8.5.0.



License requirements : cam_base ("CAM BASE")

Parameters
numToolsthe number of tools

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