CAMSetup Class

class NXOpen.CAM.CAMSetup

Bases: NXOpen.CAM.CAMObject

cam setup

To obtain an instance of this class, use NXOpen.Part.CAMSetup()

New in version NX4.0.0.

Properties

Property Description
IsLibrarySetup Returns the flag indicating if this setup is initialized from a library.
IsOccurrence Returns whether this object is an occurrence or not.
JournalIdentifier Returns the identifier that would be recorded in a journal for this object.
LibraryReference Returns or sets the template library reference
Name Returns the custom name of the object.
OutputBallCenter Returns or sets the setting for ball center output at posting time
OwningComponent Returns the owning component, if this object is an occurrence.
OwningPart Returns the owning part of this object
Prototype Returns the prototype of this object if it is an occurrence.
Tag Returns the Tag for this object.
CAMGroupCollection Returns the NCGroupCollection instance belonging to this setup
CAMOperationCollection Returns the OperationCollection instance belonging to this setup

Methods

Method Description
ApproveObjects Approve objects
AskPathExists Tells if the object has a path
BufferObjects Buffer objects to the clipboard and prepare for copy later
CopyFromComponent Copy From Component.
CopyObjects Copy objects
CopyObjectsWithReference Copy objects with reference
CreateAttributeIterator Create an attribute iterator
CreateCutDepthChecker Creates a Cut Depth Checker.
CreateEmptyPath Create an empty path for the object
CreateFeatureProcessBuilder Creates a CAM.
CreateFeatureRecognitionBuilder Creates a CAM.
CreateFeatureTeaching Creates a CAM.
CreateFeedsBuilder Create Feeds builder.
CreateFeedsOptimizeBuilder Creates a feeds optimize builder
CreateGougeCheckBuilder Create Gouge Check builder.
CreateMirrorBuilder Create Mirror builder.
CreateNCAssistantBuilder Creates NC Assistant builder
CreateNcmctPartMountingBuilder Creates a Part Mounting Builder.
CreateObjectNotes Create Notes.
CreateObjectWorkInstructionBuilder Create Object Work Instruction builder for authoring Work Instructions.
CreateObjectsUdeSet Create ObjectsUdeSet.
CreateOperationTeaching Creates a CAM.
CreateOperationTransformBuilder Create Transform builder.
CreatePreprocessGeometryBuilder Creates a preprocess geometry builder
CreateSurfaceRegions Creates a surface regions builder
CreateToolPathDivideBuilder Create Tool Path Divide builder
CreateToolPathSplitBuilder Create Tool Path Split by Holder builder
CreateToolPathTiltBuilder Create Tool Path Tilt builder
CreateWorkInstructionBuilder Create Work Instruction builder for authoring Work Instructions.
CreateWorkInstructionOutputBuilder Create Work Instruction Output builder for publishing Work Instructions.
CustomizationUpdateFromObject Customize from Object
CustomizationUpdateFromTemplate Customize from Template
CutObjects Cut objects
Delete3dWorkpieces Delete 3D workpieces of the selected operations
DeleteAllAttributesByType Deletes all attributes of a specific type.
DeleteAttributeByTypeAndTitle Deletes an attribute by type and title.
DeleteToolPath Delete tool path
DeleteUserAttribute Deletes the first attribute encountered with the given Type, Title.
DeleteUserAttributes Deletes the attributes on the object, if any, that satisfy the given iterator
DeleteVnckMachineData Removes vnck machine data
DeleteWorkInstructions Delete Work Instructions
DivideToolPaths Tool Path Divide
FindObject Finds the NXOpen.NXObject with the given identifier as recorded in a journal.
GenerateToolPath Generate tool path
GetAttributeTitlesByType Gets all the attribute titles of a specific type.
GetBooleanUserAttribute Gets a boolean attribute by Title and array Index.
GetBooleanValue Get the boolean value of the parameter index from the object
GetCamExitObject Get the param object which is invoking the exit API
GetComputationalTimeUserAttribute Gets a time attribute by Title and array Index.
GetFeedRate Get the feed rate value and unit of the parameter index from the object
GetFeedRateColor Get the feed rate color of the parameter index from the object.
GetIntegerArrayValue Get the integer array value of the parameter index from the object.
GetIntegerAttribute Gets an integer attribute by title.
GetIntegerUserAttribute Gets an integer attribute by Title and array Index.
GetIntegerValue Get the integer value of the parameter index from the object.
GetMachineLibref Get machine libref
GetNextUserAttribute Gets the next attribute encountered on the object, if any, that satisfies the given iterator.
GetObject Get the object value of the parameter index from the object
GetObjectArrayValue Get the object array value of the parameter index from the object.
GetPartMaterial Part material
GetPartMaterialData Get part material data
GetPath Returns the path
GetPdmReferenceAttributeValue Gets the value of PDM Reference attribute for given object.
GetRealArrayValue Get the real array value of the parameter index from the object.
GetRealAttribute Gets a real attribute by title.
GetRealUserAttribute Gets a real attribute by Title and array Index.
GetRealValue Get the real value of the parameter index from the object.
GetReferenceAttribute Gets the reference string (not the calculated value) of a string attribute that uses a reference string.
GetRoot Get root of the specified branch.
GetStatus Get the status of the input object.
GetStringArrayValue Get the string array value of the parameter index from the object.
GetStringAttribute Gets a string attribute value by title.
GetStringUserAttribute Gets a string attribute by Title and array Index.
GetStringValue Get the string value of the parameter index from the object
GetTimeAttribute Gets a time attribute by title.
GetTimeUserAttribute Gets a time attribute by Title and array Index.
GetUserAttribute Gets the first attribute encountered on the object, if any, with a given Title, Type and array Index.
GetUserAttributeAsString Gets the first attribute encountered on the object, if any, with a given title, type and array index.
GetUserAttributeCount Gets the count of set attributes on the object, if any, that satisfy the given iterator.
GetUserAttributeLock Determine the lock of the given attribute.
GetUserAttributeSize Gets the size of the first attribute encountered on the object, if any, with a given Title and Type.
GetUserAttributeSourceObjects Returns an array of objects from which this object presents attributes.
GetUserAttributes Gets all the attributes that have been set on the given object, if any, that satisfy the given iterator.
GetUserAttributesAsStrings Gets all the attributes that have been set on the given object.
GetWireEdmFeedRate Get the feed rate value and side of the parameter index from the object, side is only used in wire edm.
GougeCheck Gouge Check
Has911Attribute Check if a 911 attribute exists in an object.
HasSuppressedGeom Check for suppressed geometry
HasUserAttribute Determines if an attribute exists on the object, that satisfies the given iterator
IsGroup Check if the specified object is a group.
IsOperation Check if the specified object is an operation.
IsToolPathLocked Lock Tool Path
ListToolPath List tool path
LockToolPaths Lock Tool Path
MinToolLen Minimum tool length
MoveObjects Move objects
Optimize Optimize
OutputClsf Output CLSF
ParallelCreate3d Parallel create 3D
ParallelGenerate Parallel Generate tool path
Postprocess Postprocess
PostprocessWithSetting Postprocess
Print Prints a representation of this object to the system log file.
Remove911Attribute Remove a specific 911 attribute from an object.
RemoveAll911Attributes Remove all 911 attributes from an object.
RemoveDependencies Remove dependencies of selected objects
RemoveMachine Removes: - The machine part component from the CAM assembly - The machine kinematics from the CAM Setup - Carriers and Pockets from the CAM Setup, this means cleanup the Operation Navigator
RemoveSuppressedGeom Remove suppressed geometry
ReplayToolPath Replay tool path
RestoreDependencies Restore dependencies of selected objects
RetrieveDevice Retrieve a device from library
RetrieveTool Retrieve a tool from library
SavePath This must be called to establish proper part status
SetAttribute Creates or modifies an integer attribute.
SetBooleanUserAttribute Creates or modifies a boolean attribute with the option to update or not.
SetBooleanValue Set a boolean value to the parameter index for the object.
SetFeedRate Set feed rate value and unit to the parameter index for the object.
SetFeedRateColor Set feed rate display color to the parameter index for the object.
SetIntegerArrayValue Set integer array value to the parameter index for the object.
SetIntegerValue Set an integer value to the parameter index for the object.
SetMachiningData Set Machining Data
SetName Sets the custom name of the object.
SetObject Set a object to the parameter index for the object.
SetObjectArrayValue Set object array to the parameter index for the object
SetPartMaterial Part material
SetPdmReferenceAttribute Sets the value of PDM Reference attribute on the object.
SetRealArrayValue Set real array to the parameter index for the object.
SetRealValue Set a real value to the parameter index for the object.
SetReferenceAttribute Creates or modifies a string attribute which uses a reference string.
SetStringArrayValue Set string array to the parameter index for the object
SetStringValue Set a string value to the parameter index for the object.
SetTemplateStatus Set Template status
SetTimeAttribute Creates or modifies a time attribute.
SetTimeUserAttribute Creates or modifies a time attribute with the option to update or not.
SetUserAttribute Creates or modifies an attribute with the option to update or not.
SetUserAttributeLock Lock or unlock the given attribute.
SetWireEdmFeedRate Set feed rate value and side to the parameter index for the object, side is only used in wire edm.
Show2dWorkpiece Show 2D workpiece
Show2dWorkpieceIn Show ingoing 2D workpiece
Show2dWorkpieceOut Show outgoing 2D workpiece
Show3dWorkpiece Show 3D workpiece
ShowSpinning3dWorkpiece Show spinning 3D workpiece
SplitToolPaths Tool Path Split by Holder
SwitchLayerLayout Switch Layer and Layout
TiltToolPaths Tool Path Tilt
TrimToolPath Interactive Tool Path Trim
UnapproveObjects Unapprove objects
UpdateGeometryDependencies Update geometry dependencies of selected objects
UpdateResourcesOnRule Update Resources (Machine, Tools, Devices) based on assembly loading rule

Enumerations

CAMSetupOutputUnits Enumeration Output units used in output clsf and postprocess.
CAMSetupPaste Enumeration Paste position.
CAMSetupPostprocessSettingsOutputWarning Enumeration Output warning setting for Postprocess
CAMSetupPostprocessSettingsReviewTool Enumeration Review tool setting for Postprocess
CAMSetupUde Enumeration The UDE type
CAMSetupView Enumeration ONT view.

Property Detail

IsLibrarySetup

CAMSetup.IsLibrarySetup

Returns the flag indicating if this setup is initialized from a library.

-------------------------------------

Getter Method

Signature IsLibrarySetup

Returns:
Return type:bool

New in version NX7.5.3.

License requirements: None.

IsOccurrence

CAMSetup.IsOccurrence

Returns whether this object is an occurrence or not.

-------------------------------------

Getter Method

Signature IsOccurrence

Returns:This object is an occurrence
Return type:bool

New in version NX3.0.0.

License requirements: None.

JournalIdentifier

CAMSetup.JournalIdentifier

Returns the identifier that would be recorded in a journal for this object.

This may not be the same across different releases of the software.

-------------------------------------

Getter Method

Signature JournalIdentifier

Returns:
Return type:str

New in version NX3.0.0.

License requirements: None.

LibraryReference

CAMSetup.LibraryReference

Returns or sets the template library reference

-------------------------------------

Getter Method

Signature LibraryReference

Returns:
Return type:str

New in version NX7.5.3.

License requirements: None.

-------------------------------------

Setter Method

Signature LibraryReference

Parameters:libraryReference (str) –

New in version NX7.5.3.

License requirements: cam_base (“CAM BASE”)

Name

CAMSetup.Name

Returns the custom name of the object.

-------------------------------------

Getter Method

Signature Name

Returns:
Return type:str

New in version NX3.0.0.

License requirements: None.

OutputBallCenter

CAMSetup.OutputBallCenter

Returns or sets the setting for ball center output at posting time

-------------------------------------

Getter Method

Signature OutputBallCenter

Returns:
Return type:bool

New in version NX9.0.1.

License requirements: None.

-------------------------------------

Setter Method

Signature OutputBallCenter

Parameters:outputBallCenter (bool) –

New in version NX9.0.1.

License requirements: cam_base (“CAM BASE”)

OwningComponent

CAMSetup.OwningComponent

Returns the owning component, if this object is an occurrence.

-------------------------------------

Getter Method

Signature OwningComponent

Returns:
Return type:NXOpen.Assemblies.Component

New in version NX3.0.0.

License requirements: None.

OwningPart

CAMSetup.OwningPart

Returns the owning part of this object

-------------------------------------

Getter Method

Signature OwningPart

Returns:The owning part of this object or null if it does not have an owner
Return type:NXOpen.BasePart

New in version NX3.0.0.

License requirements: None.

Prototype

CAMSetup.Prototype

Returns the prototype of this object if it is an occurrence.

-------------------------------------

Getter Method

Signature Prototype

Returns:The prototype of this object or null if this object is not an occurrence
Return type:NXOpen.INXObject

New in version NX3.0.0.

License requirements: None.

CAMGroupCollection

CAMSetup.CAMGroupCollection

Returns the NCGroupCollection instance belonging to this setup

Signature CAMGroupCollection

New in version NX3.0.0.

Returns:
Return type:NXOpen.CAM.NCGroupCollection

CAMOperationCollection

CAMSetup.CAMOperationCollection

Returns the OperationCollection instance belonging to this setup

Signature CAMOperationCollection

New in version NX3.0.0.

Returns:
Return type:NXOpen.CAM.OperationCollection

Method Detail

ApproveObjects

CAMSetup.ApproveObjects

Approve objects

Signature ApproveObjects(objects)

Parameters:objects (list of NXOpen.CAM.CAMObject) – array of objects

New in version NX6.0.0.

License requirements: cam_base (“CAM BASE”)

BufferObjects

CAMSetup.BufferObjects

Buffer objects to the clipboard and prepare for copy later

Signature BufferObjects(view, objectsToBeBuffered)

Parameters:

New in version NX6.0.0.

License requirements: cam_base (“CAM BASE”)

CopyFromComponent

CAMSetup.CopyFromComponent

Copy From Component.

Signature CopyFromComponent()

New in version NX11.0.1.

License requirements: cam_base (“CAM BASE”)

CopyObjects

CAMSetup.CopyObjects

Copy objects

Signature CopyObjects(view, objectsToBeMoved, destinationObject, pastePosition)

Parameters:
Returns:

array of new objects
Return type:

list of NXOpen.CAM.CAMObject

New in version NX4.0.0.

License requirements: cam_base (“CAM BASE”)

CopyObjectsWithReference

CAMSetup.CopyObjectsWithReference

Copy objects with reference

Signature CopyObjectsWithReference(view, objectsToBeMoved, destinationObject, pastePosition)

Parameters:
Returns:

array of new objects
Return type:

list of NXOpen.CAM.CAMObject

New in version NX9.0.0.

License requirements: cam_base (“CAM BASE”)

CreateCutDepthChecker

CAMSetup.CreateCutDepthChecker

Creates a Cut Depth Checker.

Note: Commit will not return an object

Signature CreateCutDepthChecker()

Returns:the cut depth checker object
Return type:NXOpen.CAM.CutDepthChecker

New in version NX8.5.0.

License requirements: cam_base (“CAM BASE”)

CreateFeatureProcessBuilder

CAMSetup.CreateFeatureProcessBuilder

Creates a CAM.

FeatureProcessBuilder

Signature CreateFeatureProcessBuilder()

Returns:
Return type:NXOpen.CAM.FeatureProcessBuilder

New in version NX7.5.0.

License requirements: ug_holemaking (“UG Holemaking”)

CreateFeatureRecognitionBuilder

CAMSetup.CreateFeatureRecognitionBuilder

Creates a CAM.

FeatureRecognitionBuilder

Signature CreateFeatureRecognitionBuilder(param)

Parameters:param (NXOpen.CAM.CAMObject) – not used
Returns:
Return type:NXOpen.CAM.FeatureRecognitionBuilder

New in version NX6.0.0.

License requirements: cam_base (“CAM BASE”)

CreateFeatureTeaching

CAMSetup.CreateFeatureTeaching

Creates a CAM.

FeatureTeaching

Signature CreateFeatureTeaching(param)

Parameters:param (NXOpen.CAM.CAMObject) – not used
Returns:
Return type:NXOpen.CAM.FeatureTeaching

New in version NX8.0.0.

License requirements: cam_base (“CAM BASE”)

CreateFeedsBuilder

CAMSetup.CreateFeedsBuilder

Create Feeds builder.

Signature CreateFeedsBuilder(params)

Parameters:params (list of NXOpen.CAM.CAMObject) – array of objects
Returns:created object feed builder
Return type:NXOpen.CAM.ObjectsFeedsBuilder

New in version NX6.0.0.

License requirements: cam_base (“CAM BASE”)

CreateFeedsOptimizeBuilder

CAMSetup.CreateFeedsOptimizeBuilder

Creates a feeds optimize builder

Signature CreateFeedsOptimizeBuilder(param)

Parameters:param (NXOpen.CAM.CAMObject) – the object to be edited
Returns:feeds optimize builder created
Return type:NXOpen.CAM.FeedsOptimizeBuilder

New in version NX7.5.0.

License requirements: cam_base (“CAM BASE”)

CreateGougeCheckBuilder

CAMSetup.CreateGougeCheckBuilder

Create Gouge Check builder.

Signature CreateGougeCheckBuilder(objects)

Parameters:objects (list of NXOpen.CAM.CAMObject) – array of objects
Returns:created Gouge Check Builder
Return type:NXOpen.CAM.GougeCheckBuilder

New in version NX11.0.0.

License requirements: cam_base (“CAM BASE”)

CreateMirrorBuilder

CAMSetup.CreateMirrorBuilder

Create Mirror builder.

Signature CreateMirrorBuilder(objectsToMirror)

Parameters:objectsToMirror (list of NXOpen.CAM.CAMObject) – array of objects to mirror
Returns:created Mirror Builder
Return type:NXOpen.CAM.MirrorBuilder

New in version NX9.0.3.

License requirements: cam_base (“CAM BASE”)

CreateNCAssistantBuilder

CAMSetup.CreateNCAssistantBuilder

Creates NC Assistant builder

Signature CreateNCAssistantBuilder()

Returns:NC Assistant builder created
Return type:NXOpen.CAM.NCAssistantBuilder

New in version NX7.5.0.

License requirements: cam_base (“CAM BASE”)

CreateNcmctPartMountingBuilder

CAMSetup.CreateNcmctPartMountingBuilder

Creates a Part Mounting Builder.

Note: Commit a Part Mounting Builder will perform the Part Mounting and no object is returned.

Signature CreateNcmctPartMountingBuilder(libRef)

Parameters:libRef (str) – a unique library reference identifier
Returns:part mounting builder created
Return type:NXOpen.CAM.NcmctPartMountingBuilder

New in version NX8.0.0.

License requirements: cam_base (“CAM BASE”)

CreateObjectNotes

CAMSetup.CreateObjectNotes

Create Notes.

Signature CreateObjectNotes(opr)

Parameters:opr (NXOpen.CAM.CAMObject) –
Returns:created object notes
Return type:NXOpen.CAM.ObjectNotes

New in version NX9.0.0.

License requirements: cam_base (“CAM BASE”)

CreateObjectWorkInstructionBuilder

CAMSetup.CreateObjectWorkInstructionBuilder

Create Object Work Instruction builder for authoring Work Instructions.

Signature CreateObjectWorkInstructionBuilder(param)

Parameters:param (NXOpen.CAM.CAMObject) –
Returns:created builder object
Return type:NXOpen.CAM.ObjectWorkInstructionBuilder

New in version NX9.0.3.

License requirements: cam_base (“CAM BASE”)

CreateObjectsUdeSet

CAMSetup.CreateObjectsUdeSet

Overloaded method CreateObjectsUdeSet

  • CreateObjectsUdeSet(params, udeType)
  • CreateObjectsUdeSet(params, udeType, features)

-------------------------------------

Create ObjectsUdeSet.

Signature CreateObjectsUdeSet(params, udeType)

Parameters:
Returns:

created objects ude set
Return type:

NXOpen.CAM.ObjectsUdeSet

New in version NX7.5.0.

License requirements: cam_base (“CAM BASE”)

-------------------------------------

Create ObjectsUdeSet for features

Signature CreateObjectsUdeSet(params, udeType, features)

Parameters:
Returns:

created objects ude set
Return type:

NXOpen.CAM.ObjectsUdeSet

New in version NX7.5.0.

License requirements: cam_base (“CAM BASE”)

-------------------------------------

CreateOperationTeaching

CAMSetup.CreateOperationTeaching

Creates a CAM.

OperationTeaching

Signature CreateOperationTeaching(param)

Parameters:param (NXOpen.CAM.CAMObject) – not used
Returns:
Return type:NXOpen.CAM.OperationTeaching

New in version NX8.0.0.

License requirements: cam_base (“CAM BASE”)

CreateOperationTransformBuilder

CAMSetup.CreateOperationTransformBuilder

Create Transform builder.

Note: Commit a Transform Builder will apply a transformation.

Signature CreateOperationTransformBuilder(objectsToTransform)

Parameters:objectsToTransform (list of NXOpen.CAM.CAMObject) – array of objects to transform
Returns:created Transform Builder
Return type:NXOpen.CAM.OperationTransformBuilder

New in version NX6.0.0.

License requirements: cam_base (“CAM BASE”)

CreatePreprocessGeometryBuilder

CAMSetup.CreatePreprocessGeometryBuilder

Creates a preprocess geometry builder

Signature CreatePreprocessGeometryBuilder()

Returns:preprocess geometry builder created
Return type:NXOpen.CAM.PreprocessGeometryBuilder

New in version NX6.0.0.

License requirements: cam_base (“CAM BASE”)

CreateSurfaceRegions

CAMSetup.CreateSurfaceRegions

Creates a surface regions builder

Signature CreateSurfaceRegions(feature)

Parameters:feature (NXOpen.Features.Feature) – Feature to be edited
Returns:surface regions builder created
Return type:NXOpen.CAM.SurfaceRegions

New in version NX8.0.0.

License requirements: cam_base (“CAM BASE”)

CreateToolPathDivideBuilder

CAMSetup.CreateToolPathDivideBuilder

Create Tool Path Divide builder

Signature CreateToolPathDivideBuilder(tpObjectsToDivide)

Parameters:tpObjectsToDivide (list of NXOpen.CAM.CAMObject) – array of objects to divide
Returns:array of new objects
Return type:NXOpen.CAM.ToolPathDivideBuilder

New in version NX4.0.0.

License requirements: cam_base (“CAM BASE”)

CreateToolPathSplitBuilder

CAMSetup.CreateToolPathSplitBuilder

Create Tool Path Split by Holder builder

Signature CreateToolPathSplitBuilder(tpObjectsToDivide)

Parameters:tpObjectsToDivide (list of NXOpen.CAM.CAMObject) – array of objects to divide
Returns:array of new objects
Return type:NXOpen.CAM.ToolPathSplitBuilder

New in version NX6.0.0.

License requirements: cam_base (“CAM BASE”)

CreateToolPathTiltBuilder

CAMSetup.CreateToolPathTiltBuilder

Create Tool Path Tilt builder

Signature CreateToolPathTiltBuilder(tpObjectsToTilt)

Parameters:tpObjectsToTilt (list of NXOpen.CAM.CAMObject) – array of objects to tilt
Returns:array of new objects
Return type:NXOpen.CAM.ToolPathTiltBuilder

New in version NX7.5.0.

License requirements: cam_base (“CAM BASE”)

CreateWorkInstructionBuilder

CAMSetup.CreateWorkInstructionBuilder

Create Work Instruction builder for authoring Work Instructions.

Signature CreateWorkInstructionBuilder(param)

Parameters:param (NXOpen.CAM.CAMObject) –
Returns:created builder object
Return type:NXOpen.CAM.WorkInstructionBuilder

New in version NX9.0.3.

License requirements: cam_base (“CAM BASE”)

CreateWorkInstructionOutputBuilder

CAMSetup.CreateWorkInstructionOutputBuilder

Create Work Instruction Output builder for publishing Work Instructions.

Signature CreateWorkInstructionOutputBuilder()

Returns:created builder object
Return type:NXOpen.CAM.WorkInstructionOutputBuilder

New in version NX9.0.3.

License requirements: cam_base (“CAM BASE”)

CustomizationUpdateFromObject

CAMSetup.CustomizationUpdateFromObject

Customize from Object

Signature CustomizationUpdateFromObject(destinationObject, sourceObject)

Parameters:

New in version NX7.5.0.

License requirements: cam_base (“CAM BASE”)

CustomizationUpdateFromTemplate

CAMSetup.CustomizationUpdateFromTemplate

Customize from Template

Signature CustomizationUpdateFromTemplate(objects)

Parameters:objects (list of NXOpen.CAM.CAMObject) – destination objects for customization

New in version NX7.5.0.

License requirements: cam_base (“CAM BASE”)

CutObjects

CAMSetup.CutObjects

Cut objects

Signature CutObjects(view, objectsToBeMoved)

Parameters:

New in version NX4.0.0.

License requirements: cam_base (“CAM BASE”)

Delete3dWorkpieces

CAMSetup.Delete3dWorkpieces

Delete 3D workpieces of the selected operations

Signature Delete3dWorkpieces(objects)

Parameters:objects (list of NXOpen.CAM.CAMObject) – array of operations

New in version NX9.0.0.

License requirements: cam_base (“CAM BASE”)

DeleteToolPath

CAMSetup.DeleteToolPath

Delete tool path

Signature DeleteToolPath(objects)

Parameters:objects (list of NXOpen.CAM.CAMObject) – array of objects

New in version NX4.0.0.

License requirements: cam_base (“CAM BASE”)

DeleteVnckMachineData

CAMSetup.DeleteVnckMachineData

Removes vnck machine data

Signature DeleteVnckMachineData()

New in version NX8.5.0.

License requirements: cam_base (“CAM BASE”)

DeleteWorkInstructions

CAMSetup.DeleteWorkInstructions

Delete Work Instructions

Signature DeleteWorkInstructions(objects)

Parameters:objects (list of NXOpen.CAM.CAMObject) – array of objects

New in version NX9.0.3.

License requirements: cam_base (“CAM BASE”)

DivideToolPaths

CAMSetup.DivideToolPaths

Tool Path Divide

Signature DivideToolPaths(objects, builder)

Parameters:

New in version NX4.0.0.

License requirements: cam_base (“CAM BASE”)

FindObject

CAMSetup.FindObject

Finds the NXOpen.NXObject with the given identifier as recorded in a journal.

An object may not return the same value as its JournalIdentifier in different versions of the software. However newer versions of the software should find the same object when FindObject is passed older versions of its journal identifier. In general, this method should not be used in handwritten code and exists to support record and playback of journals.

An exception will be thrown if no object can be found with the given journal identifier.

Signature FindObject(journalIdentifier)

Parameters:journalIdentifier (str) – Journal identifier of the object
Returns:
Return type:NXOpen.INXObject

New in version NX3.0.0.

License requirements: None.

GenerateToolPath

CAMSetup.GenerateToolPath

Generate tool path

Signature GenerateToolPath(objects)

Parameters:objects (list of NXOpen.CAM.CAMObject) – array of objects

New in version NX4.0.0.

License requirements: cam_base (“CAM BASE”)

GetCamExitObject

CAMSetup.GetCamExitObject

Get the param object which is invoking the exit API

Signature GetCamExitObject()

Returns:the cam exit object
Return type:NXOpen.CAM.CAMObject

New in version NX8.5.0.

License requirements: cam_base (“CAM BASE”)

GetMachineLibref

CAMSetup.GetMachineLibref

Get machine libref

Signature GetMachineLibref()

Returns:
Return type:str

New in version NX8.5.0.

License requirements: None.

GetPartMaterial

CAMSetup.GetPartMaterial

Part material

Signature GetPartMaterial()

Returns:
Return type:str

New in version NX8.0.1.

License requirements: None.

GetPartMaterialData

CAMSetup.GetPartMaterialData

Get part material data

Signature GetPartMaterialData()

Returns:a tuple
Return type:A tuple consisting of (libref, name, description, code, hardness) libref is a str. name is a str. description is a str. code is a str. hardness is a str.

New in version NX8.0.2.

License requirements: None.

GetRoot

CAMSetup.GetRoot

Get root of the specified branch.

Signature GetRoot(branch)

Parameters:branch (NXOpen.CAM.CAMSetupView) – branch from which to get setup root
Returns:root of the specified branch
Return type:NXOpen.CAM.NCGroup

New in version NX7.5.0.

License requirements: None.

GougeCheck

CAMSetup.GougeCheck

Overloaded method GougeCheck

  • GougeCheck(objects, checkForHolderCollision)
  • GougeCheck(objects, checkForHolderCollision, useParametric, useUserdefStock, userdefStock)

-------------------------------------

Gouge Check

Signature GougeCheck(objects, checkForHolderCollision)

Parameters:
  • objects (list of NXOpen.CAM.CAMObject) – array of objects to do gouge checking
  • checkForHolderCollision (bool) – check for tool holder collision

New in version NX6.0.0.

Deprecated since version NX9.0.0: Use new version with additional arguments instead.

License requirements: cam_base (“CAM BASE”)

-------------------------------------

Gouge Check

Signature GougeCheck(objects, checkForHolderCollision, useParametric, useUserdefStock, userdefStock)

Parameters:
  • objects (list of NXOpen.CAM.CAMObject) – array of objects to do gouge checking
  • checkForHolderCollision (bool) – check for tool holder collision
  • useParametric (bool) – use parametric tool shape
  • useUserdefStock (bool) – use user defined stock
  • userdefStock (float) – user defined stock

New in version NX9.0.0.

License requirements: cam_base (“CAM BASE”)

-------------------------------------

HasSuppressedGeom

CAMSetup.HasSuppressedGeom

Check for suppressed geometry

Signature HasSuppressedGeom(param)

Parameters:param (NXOpen.CAM.CAMObject) – object to test
Returns:
Return type:bool

New in version NX5.0.4.

License requirements: cam_base (“CAM BASE”)

IsGroup

CAMSetup.IsGroup

Check if the specified object is a group.

Signature IsGroup(camObject)

Parameters:camObject (NXOpen.CAM.CAMObject) –
Returns:
Return type:bool

New in version NX7.5.0.

License requirements: None.

IsOperation

CAMSetup.IsOperation

Check if the specified object is an operation.

Signature IsOperation(camobject)

Parameters:camobject (NXOpen.CAM.CAMObject) –
Returns:
Return type:bool

New in version NX7.5.0.

License requirements: None.

IsToolPathLocked

CAMSetup.IsToolPathLocked

Lock Tool Path

Signature IsToolPathLocked(object)

Parameters:object (NXOpen.CAM.CAMObject) – object whose tool path is checked
Returns:tool path lock status
Return type:bool

New in version NX6.0.0.

License requirements: cam_base (“CAM BASE”)

ListToolPath

CAMSetup.ListToolPath

List tool path

Signature ListToolPath(objects)

Parameters:objects (list of NXOpen.CAM.CAMObject) – array of objects

New in version NX4.0.0.

License requirements: cam_base (“CAM BASE”)

LockToolPaths

CAMSetup.LockToolPaths

Lock Tool Path

Signature LockToolPaths(objects, lock)

Parameters:
  • objects (list of NXOpen.CAM.CAMObject) – array of objects
  • lock (bool) – lock the tool path if true, else unlock the tool path

New in version NX6.0.0.

License requirements: cam_base (“CAM BASE”)

MinToolLen

CAMSetup.MinToolLen

Minimum tool length

Signature MinToolLen(objects)

Parameters:objects (list of NXOpen.CAM.CAMObject) – array of objects

New in version NX7.5.0.

License requirements: cam_base (“CAM BASE”)

MoveObjects

CAMSetup.MoveObjects

Move objects

Signature MoveObjects(view, objectsToBeMoved, destinationObject, pastePosition)

Parameters:

New in version NX4.0.0.

License requirements: cam_base (“CAM BASE”)

Optimize

CAMSetup.Optimize

Signature Optimize(objects, consolidateTools, minimizeToolChanges, createOptimizationGroup)

Parameters:
  • objects (list of NXOpen.CAM.CAMObject) – array of objects to optimize
  • consolidateTools (bool) – consolidate tools
  • minimizeToolChanges (bool) – minimize tool changes
  • createOptimizationGroup (bool) – create optimization group

New in version NX6.0.0.

License requirements: cam_base (“CAM BASE”)

OutputClsf

CAMSetup.OutputClsf

Output CLSF

Signature OutputClsf(objects, clsfFormat, outfileName, outputUnits)

Parameters:

New in version NX4.0.0.

License requirements: cam_base (“CAM BASE”)

ParallelCreate3d

CAMSetup.ParallelCreate3d

Parallel create 3D

Signature ParallelCreate3d(objects)

Parameters:objects (list of NXOpen.CAM.CAMObject) – array of objects

New in version NX9.0.1.

License requirements: cam_base (“CAM BASE”)

ParallelGenerate

CAMSetup.ParallelGenerate

Parallel Generate tool path

Signature ParallelGenerate(objects)

Parameters:objects (list of NXOpen.CAM.CAMObject) – array of objects

New in version NX7.5.5.

License requirements: cam_base (“CAM BASE”)

Postprocess

CAMSetup.Postprocess

Signature Postprocess(objects, machineType, outfileName, outputUnits)

Parameters:

New in version NX4.0.0.

License requirements: cam_base (“CAM BASE”)

PostprocessWithSetting

CAMSetup.PostprocessWithSetting

Postprocess

Signature PostprocessWithSetting(objects, machineType, outfileName, outputUnits, outputWarning, reviewTool)

Parameters:

New in version NX8.0.0.

License requirements: cam_base (“CAM BASE”)

Print

CAMSetup.Print

Prints a representation of this object to the system log file.

Signature Print()

New in version NX3.0.0.

License requirements: None.

RemoveDependencies

CAMSetup.RemoveDependencies

Remove dependencies of selected objects

Signature RemoveDependencies(objects)

Parameters:objects (list of NXOpen.CAM.CAMObject) – array of objects

New in version NX9.0.0.

License requirements: cam_base (“CAM BASE”)

RemoveMachine

CAMSetup.RemoveMachine

Removes: - The machine part component from the CAM assembly - The machine kinematics from the CAM Setup - Carriers and Pockets from the CAM Setup, this means cleanup the Operation Navigator

Signature RemoveMachine()

New in version NX8.5.0.

License requirements: cam_base (“CAM BASE”)

RemoveSuppressedGeom

CAMSetup.RemoveSuppressedGeom

Remove suppressed geometry

Signature RemoveSuppressedGeom(param)

Parameters:param (NXOpen.CAM.CAMObject) – object to operate on

New in version NX5.0.4.

License requirements: cam_base (“CAM BASE”)

ReplayToolPath

CAMSetup.ReplayToolPath

Replay tool path

Signature ReplayToolPath(objects)

Parameters:objects (list of NXOpen.CAM.CAMObject) – array of objects

New in version NX4.0.0.

License requirements: cam_base (“CAM BASE”)

RestoreDependencies

CAMSetup.RestoreDependencies

Restore dependencies of selected objects

Signature RestoreDependencies(objects)

Parameters:objects (list of NXOpen.CAM.CAMObject) – array of objects

New in version NX9.0.0.

License requirements: cam_base (“CAM BASE”)

RetrieveDevice

CAMSetup.RetrieveDevice

Retrieve a device from library

Signature RetrieveDevice(libRef)

Parameters:libRef (str) – a unique library reference identifier
Returns:machine device created
Return type:NXOpen.CAM.NCGroup

New in version NX8.0.0.

License requirements: None.

RetrieveTool

CAMSetup.RetrieveTool

Overloaded method RetrieveTool

  • RetrieveTool(libRef)
  • RetrieveTool(libRef, target)

-------------------------------------

Retrieve a tool from library

Signature RetrieveTool(libRef)

Parameters:libRef (str) – the library name
Returns:a tuple
Return type:A tuple consisting of (libTool, success). libTool is a NXOpen.CAM.Tool. created the tool library success is a bool.

New in version NX7.5.0.

License requirements: None.

-------------------------------------

Retrieve a tool from library to the target

Signature RetrieveTool(libRef, target)

Parameters:
  • libRef (str) – the library name
  • target (NXOpen.CAM.CAMObject) – the target where the tool is mounted
Returns:

a tuple
Return type:

A tuple consisting of (libTool, nextTarget, success). libTool is a NXOpen.CAM.Tool. created the tool library nextTarget is a NXOpen.CAM.CAMObject. the next target where the tool can be mounted success is a bool.

New in version NX8.5.0.

License requirements: None.

-------------------------------------

SetMachiningData

CAMSetup.SetMachiningData

Set Machining Data

Signature SetMachiningData(objects)

Parameters:objects (list of NXOpen.CAM.CAMObject) – array of objects
Returns:array of errors
Return type:list of NXOpen.CAM.CAMObjectErrorItem_Struct

New in version NX6.0.0.

License requirements: cam_base (“CAM BASE”)

SetName

CAMSetup.SetName

Sets the custom name of the object.

NOTE: This method should not be used to edit a read-only object such as a Mirrored PMI object. If it is, the changes will be overridden when the part is updated.

Signature SetName(name)

Parameters:name (str) –

New in version NX3.0.0.

License requirements: None.

SetPartMaterial

CAMSetup.SetPartMaterial

Part material

Signature SetPartMaterial(libRef)

Parameters:libRef (str) –

New in version NX8.0.1.

License requirements: cam_base (“CAM BASE”)

SetTemplateStatus

CAMSetup.SetTemplateStatus

Set Template status

Signature SetTemplateStatus(objects, useAsParent, createIfParentCreated)

Parameters:
  • objects (list of NXOpen.CAM.CAMObject) – array of objects to adjust
  • useAsParent (bool) – object can be used as a template or not
  • createIfParentCreated (bool) – create if parent is created

New in version NX6.0.0.

License requirements: cam_base (“CAM BASE”)

Show2dWorkpiece

CAMSetup.Show2dWorkpiece

Show 2D workpiece

Signature Show2dWorkpiece(objects)

Parameters:objects (list of NXOpen.CAM.CAMObject) – array of objects

New in version NX4.0.0.

License requirements: cam_base (“CAM BASE”)

Show2dWorkpieceIn

CAMSetup.Show2dWorkpieceIn

Show ingoing 2D workpiece

Signature Show2dWorkpieceIn(objects)

Parameters:objects (list of NXOpen.CAM.CAMObject) – array of objects

New in version NX5.0.0.

License requirements: cam_base (“CAM BASE”)

Show2dWorkpieceOut

CAMSetup.Show2dWorkpieceOut

Show outgoing 2D workpiece

Signature Show2dWorkpieceOut(objects)

Parameters:objects (list of NXOpen.CAM.CAMObject) – array of objects

New in version NX5.0.0.

License requirements: cam_base (“CAM BASE”)

Show3dWorkpiece

CAMSetup.Show3dWorkpiece

Show 3D workpiece

Signature Show3dWorkpiece(objects)

Parameters:objects (list of NXOpen.CAM.CAMObject) – array of objects

New in version NX4.0.0.

License requirements: cam_base (“CAM BASE”)

ShowSpinning3dWorkpiece

CAMSetup.ShowSpinning3dWorkpiece

Show spinning 3D workpiece

Signature ShowSpinning3dWorkpiece(objects)

Parameters:objects (list of NXOpen.CAM.CAMObject) – array of objects

New in version NX9.0.1.

License requirements: cam_base (“CAM BASE”)

SplitToolPaths

CAMSetup.SplitToolPaths

Tool Path Split by Holder

Signature SplitToolPaths(objects, builder)

Parameters:

New in version NX6.0.0.

License requirements: cam_base (“CAM BASE”)

SwitchLayerLayout

CAMSetup.SwitchLayerLayout

Switch Layer and Layout

Signature SwitchLayerLayout(object)

Parameters:object (NXOpen.CAM.CAMObject) – the object for which the layer and layout has to be switched

New in version NX9.0.1.

License requirements: cam_base (“CAM BASE”)

TiltToolPaths

CAMSetup.TiltToolPaths

Tool Path Tilt

Signature TiltToolPaths(objects, builder)

Parameters:

New in version NX7.5.0.

License requirements: cam_base (“CAM BASE”)

TrimToolPath

CAMSetup.TrimToolPath

Interactive Tool Path Trim

Signature TrimToolPath(operationBuilder)

Parameters:operationBuilder (NXOpen.CAM.OperationBuilder) –

New in version NX9.0.3.

License requirements: cam_base (“CAM BASE”)

UnapproveObjects

CAMSetup.UnapproveObjects

Unapprove objects

Signature UnapproveObjects(objects)

Parameters:objects (list of NXOpen.CAM.CAMObject) – array of objects

New in version NX7.5.0.

License requirements: cam_base (“CAM BASE”)

UpdateGeometryDependencies

CAMSetup.UpdateGeometryDependencies

Update geometry dependencies of selected objects

Signature UpdateGeometryDependencies(objects)

Parameters:objects (list of NXOpen.CAM.CAMObject) – array of objects

New in version NX9.0.0.

License requirements: cam_base (“CAM BASE”)

UpdateResourcesOnRule

CAMSetup.UpdateResourcesOnRule

Update Resources (Machine, Tools, Devices) based on assembly loading rule

Signature UpdateResourcesOnRule()

Returns:return whether CAM ressources have been modified or not
Return type:bool

New in version NX10.0.3.

License requirements: None.