InspectionSetup Class

class NXOpen.CAM.InspectionSetup

Bases: NXOpen.CAM.CAMObject

Inspection setup

Use the Part class to get or create an inspection setup

New in version NX7.0.0.

Properties

Property Description
IsOccurrence Returns whether this object is an occurrence or not.
JournalIdentifier Returns the identifier that would be recorded in a journal for this object.
Name Returns the custom name of the object.
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.
CmmInspectionGroupCollection Returns the InspectionGroupCollection instance belonging to this setup
CmmInspectionOperationCollection Returns the InspectionOperationCollection instance belonging to this setup

Methods

Method Description
AskPathExists Tells if the object has a path
BufferObjects Buffer objects to the clipboard and prepare for copy later
CopyObjects Copy objects
CreateAttributeIterator Create an attribute iterator
CreateEmptyPath Create an empty path for the object
CreateNcmctPartMountingBuilder Creates a Part Mounting Builder.
CreateObjectsUdeSet Create ObjectsUdeSet.
CutObjects Cut objects
DeleteAllAttributesByType Deletes all attributes of a specific type.
DeleteAttributeByTypeAndTitle Deletes an attribute by type and title.
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
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
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.
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.
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.
Has911Attribute Check if a 911 attribute exists in an object.
HasUserAttribute Determines if an attribute exists on the object, that satisfies the given iterator
LockToolPaths Lock Tool Path
MoveObjects Move objects
PasteObjects Paste objects after cut
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.
ResequencePaths Resequence selected paths using nearest neighbor order
ResequenceTols Resequence tolerances
RetrieveDevice Retrieve a device from library
RetrievePathMessages Retrieve toolpath validation messages
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.
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
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.
UpdateFeatureNames Update feature names in referencing operations.
UpdateToleranceNames Update tolerance names in referencing operations.

Property Detail

IsOccurrence

InspectionSetup.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

InspectionSetup.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.

Name

InspectionSetup.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.

OwningComponent

InspectionSetup.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

InspectionSetup.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

InspectionSetup.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.

CmmInspectionGroupCollection

InspectionSetup.CmmInspectionGroupCollection

Returns the InspectionGroupCollection instance belonging to this setup

Signature CmmInspectionGroupCollection

New in version NX7.0.0.

Returns:
Return type:NXOpen.CAM.InspectionGroupCollection

CmmInspectionOperationCollection

InspectionSetup.CmmInspectionOperationCollection

Returns the InspectionOperationCollection instance belonging to this setup

Signature CmmInspectionOperationCollection

New in version NX7.0.0.

Returns:
Return type:NXOpen.CAM.InspectionOperationCollection

Method Detail

BufferObjects

InspectionSetup.BufferObjects

Buffer objects to the clipboard and prepare for copy later

Signature BufferObjects(view, objectsToBeBuffered)

Parameters:

New in version NX7.0.0.

License requirements: insp_programming (“INSPECTION PROGRAMMING”)

CopyObjects

InspectionSetup.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 NX7.0.0.

License requirements: insp_programming (“INSPECTION PROGRAMMING”)

CreateNcmctPartMountingBuilder

InspectionSetup.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: insp_programming (“INSPECTION PROGRAMMING”)

CreateObjectsUdeSet

InspectionSetup.CreateObjectsUdeSet

Create ObjectsUdeSet.

Signature CreateObjectsUdeSet(params, udeType)

Parameters:
Returns:

created objects ude set
Return type:

NXOpen.CAM.ObjectsUdeSet

New in version NX9.0.2.

License requirements: insp_programming (“INSPECTION PROGRAMMING”)

CutObjects

InspectionSetup.CutObjects

Cut objects

Signature CutObjects(view, objectsToBeMoved)

Parameters:

New in version NX7.0.0.

License requirements: insp_programming (“INSPECTION PROGRAMMING”)

FindObject

InspectionSetup.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

InspectionSetup.GenerateToolPath

Generate tool path

Signature GenerateToolPath(objects)

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

New in version NX7.0.0.

License requirements: insp_programming (“INSPECTION PROGRAMMING”)

GetRoot

InspectionSetup.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.InspectionGroup

New in version NX9.0.3.

License requirements: None.

LockToolPaths

InspectionSetup.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 NX7.5.4.

License requirements: insp_programming (“INSPECTION PROGRAMMING”)

MoveObjects

InspectionSetup.MoveObjects

Move objects

Signature MoveObjects(view, objectsToBeMoved, destinationObject, pastePosition)

Parameters:

New in version NX7.0.0.

License requirements: insp_programming (“INSPECTION PROGRAMMING”)

PasteObjects

InspectionSetup.PasteObjects

Paste objects after cut

Signature PasteObjects(view, objectsToBeMoved, destinationObject, pastePosition)

Parameters:

New in version NX8.5.1.

License requirements: insp_programming (“INSPECTION PROGRAMMING”)

Postprocess

InspectionSetup.Postprocess

Signature Postprocess(objects, machineType, outfileName, outputUnits)

Parameters:

New in version NX7.0.0.

License requirements: insp_programming (“INSPECTION PROGRAMMING”)

PostprocessWithSetting

InspectionSetup.PostprocessWithSetting

Postprocess

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

Parameters:

New in version NX8.0.0.

License requirements: insp_programming (“INSPECTION PROGRAMMING”)

Print

InspectionSetup.Print

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

Signature Print()

New in version NX3.0.0.

License requirements: None.

ResequencePaths

InspectionSetup.ResequencePaths

Resequence selected paths using nearest neighbor order

Signature ResequencePaths(paths)

Parameters:paths (list of NXOpen.CAM.CAMObject) – array of paths to resequence

New in version NX9.0.0.

License requirements: None.

ResequenceTols

InspectionSetup.ResequenceTols

Resequence tolerances

Signature ResequenceTols(tols)

Parameters:tols (list of NXOpen.CAM.CAMObject) – array of tolerances to resequence

New in version NX9.0.0.

License requirements: None.

RetrieveDevice

InspectionSetup.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.InspectionGroup

New in version NX8.0.0.

License requirements: None.

RetrievePathMessages

InspectionSetup.RetrievePathMessages

Retrieve toolpath validation messages

Signature RetrievePathMessages(objects)

Parameters:objects (list of NXOpen.CAM.CAMObject) – array of object tags
Returns:array of message strings
Return type:list of str

New in version NX9.0.0.

License requirements: None.

RetrieveTool

InspectionSetup.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.InspectionTool. created the tool library success is a bool.

New in version NX7.5.1.

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.InspectionTool. 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.

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

SetName

InspectionSetup.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.

SetTemplateStatus

InspectionSetup.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 NX7.0.0.

License requirements: insp_programming (“INSPECTION PROGRAMMING”)

UpdateFeatureNames

InspectionSetup.UpdateFeatureNames

Update feature names in referencing operations.

Signature UpdateFeatureNames(originalFeatName, newFeatName)

Parameters:
  • originalFeatName (str) – Original feature name
  • newFeatName (str) – New feature name

New in version NX9.0.3.

License requirements: None.

UpdateToleranceNames

InspectionSetup.UpdateToleranceNames

Update tolerance names in referencing operations.

Signature UpdateToleranceNames(originalTolName, newTolName)

Parameters:
  • originalTolName (str) – Original tolerance name
  • newTolName (str) – New tolerance name

New in version NX10.0.3.

License requirements: None.