NXOpen .NET Reference Guide  1899
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties
Public Types | Public Member Functions | Properties | List of all members
NXOpen.CAM.Tool Class Reference

Represents a NC group More...

Inheritance diagram for NXOpen.CAM.Tool:
NXOpen.CAM.NCGroup NXOpen.CAM.CAMObject NXOpen.NXObject NXOpen.TaggedObject NXOpen.INXObject NXOpen.Utilities.NXRemotableObject IMessageSink

Public Types

enum  Subtypes {
  Undefined, Mill5, Mill7, Mill10,
  MillBall, DrillStandard, DrillCenterBell, DrillCountersink,
  DrillSpotFace, DrillSpotDrill, DrillBore, DrillReam,
  DrillCounterbore, DrillTap, DrillBurnishing, DrillThreadMill,
  DrillBackSpotFace, DrillStep, TurnStandard, TurnButton,
  TurnBoringBar, GrooveStandard, GrooveRing, GrooveFullNoseRadius,
  GrooveUserDefined, ThreadStandard, ThreadButress, ThreadAcme,
  ThreadTrapezoidal, Generic, Probe, MillChamfer,
  MillSpherical, DrillCore, StdLaser, Laser = 34,
  DrillBackCountersink, CoaxialLaser, DrillBoringBar, DrillChamferBoringBar
}
 Tool subtypes More...
 
enum  Types {
  Mill, Drill, Turn, Groove,
  Thread, Wedm, Barrel, Tcutter,
  Form, DrillSpcGroove, Solid, MillForm,
  Laser, Soft = 12
}
 Tool types More...
 

Public Member Functions

unsafe
NXOpen.CAM.GenericTrackingBuilder 
CreateGenericTrackingBuilder (NXOpen.CAM.SolidTrackPoint csoObject)
 Creates a Generic Trackpoint builder More...
 
unsafe
NXOpen.CAM.ProbeTrackingBuilder 
CreateProbeTrackingBuilder (NXOpen.CAM.ProbeTrackPoint csoObject)
 Creates a Probe Trackpoint builder More...
 
unsafe
NXOpen.CAM.SolidTrackingBuilder 
CreateSolidTrackingBuilder (NXOpen.CAM.SolidTrackPoint csoObject)
 Creates a Solid Trackpoint builder More...
 
unsafe void ExportPart (string libRef)
 Export part More...
 
unsafe void GetTypeAndSubtype (out NXOpen.CAM.Tool.Types type, out NXOpen.CAM.Tool.Subtypes subtype)
 Get cutter type and subtype More...
 
unsafe bool RetrieveHolder (string libRef)
 Retrieve holder More...
 
unsafe void UpdateFromLibrary ()
 Update a library tool from the library More...
 
- Public Member Functions inherited from NXOpen.CAM.NCGroup
unsafe NXOpen.INXObject FindObject (string sid)
 Finds the CAM. More...
 
unsafe NXOpen.CAM.CAMObject[] GetMembers ()
 Get all members of the group(single level) More...
 
unsafe NXOpen.CAM.NCGroup GetParent ()
 Get parent of the group More...
 
- Public Member Functions inherited from NXOpen.CAM.CAMObject
unsafe bool AskPathExists ()
 Tells if the object has a path More...
 
unsafe void ConvertToExplorerDialog ()
 Change the dialog customization of the object to use the explorer dialog style More...
 
unsafe NXOpen.CAM.Path CreateEmptyPath ()
 Create an empty path for the object More...
 
unsafe bool GetBooleanValue (string title)
 Get the boolean value of the parameter index from the object More...
 
unsafe
NXOpen.CAM.CAMObject.FeedRateUnit 
GetFeedRate (string title, out double value)
 Get the feed rate value and unit of the parameter index from the object More...
 
unsafe int GetFeedRateColor (string title)
 Get the feed rate color of the parameter index from the object. More...
 
unsafe int[] GetIntegerArrayValue (string title)
 Get the integer array value of the parameter index from the object. More...
 
unsafe int GetIntegerValue (string title)
 Get the integer value of the parameter index from the object. More...
 
unsafe NXOpen.NXObject GetObject (string title)
 Get the object value of the parameter index from the object More...
 
unsafe NXOpen.NXObject[] GetObjectArrayValue (string title)
 Get the object array value of the parameter index from the object. More...
 
unsafe NXOpen.CAM.Path GetPath ()
 Returns the path More...
 
unsafe double[] GetRealArrayValue (string title)
 Get the real array value of the parameter index from the object. More...
 
unsafe double GetRealValue (string title)
 Get the real value of the parameter index from the object. More...
 
unsafe NXOpen.CAM.CAMObject.Status GetStatus ()
 Get the status of the input object. More...
 
unsafe string[] GetStringArrayValue (string title)
 Get the string array value of the parameter index from the object. More...
 
unsafe string GetStringValue (string title)
 Get the string value of the parameter index from the object More...
 
unsafe int GetWireEdmFeedRate (string title, out double value)
 Get the feed rate value and side of the parameter index from the object, side is only used in wire edm. More...
 
unsafe bool Has911Attribute (NXOpen.CAM.CAMObject.Attr attrId)
 Check if a 911 attribute exists in an object. More...
 
unsafe void Remove911Attribute (NXOpen.CAM.CAMObject.Attr attrId)
 Remove a specific 911 attribute from an object. More...
 
unsafe void RemoveAll911Attributes ()
 Remove all 911 attributes from an object. More...
 
unsafe void SavePath (NXOpen.CAM.Path theBuilder)
 This must be called to establish proper part status More...
 
unsafe void SetBooleanValue (string title, bool value)
 Set a boolean value to the parameter index for the object. More...
 
unsafe void SetFeedRate (string title, double value, NXOpen.CAM.CAMObject.FeedRateUnit unit)
 Set feed rate value and unit to the parameter index for the object. More...
 
unsafe void SetFeedRateColor (string title, int value)
 Set feed rate display color to the parameter index for the object. More...
 
unsafe void SetIntegerArrayValue (string title, int[] value)
 Set integer array value to the parameter index for the object. More...
 
unsafe void SetIntegerValue (string title, int value)
 Set an integer value to the parameter index for the object. More...
 
unsafe void SetObject (string title, NXOpen.NXObject value)
 Set a object to the parameter index for the object. More...
 
unsafe void SetObjectArrayValue (string title, NXOpen.NXObject[] value)
 Set object array to the parameter index for the object More...
 
unsafe void SetRealArrayValue (string title, double[] value)
 Set real array to the parameter index for the object. More...
 
unsafe void SetRealValue (string title, double value)
 Set a real value to the parameter index for the object. More...
 
unsafe void SetStringArrayValue (string title, string[] value)
 Set string array to the parameter index for the object More...
 
unsafe void SetStringValue (string title, string value)
 Set a string value to the parameter index for the object. More...
 
unsafe void SetWireEdmFeedRate (string title, double value, int side)
 Set feed rate value and side to the parameter index for the object, side is only used in wire edm. More...
 
- Public Member Functions inherited from NXOpen.NXObject
unsafe NXOpen.AttributeIterator CreateAttributeIterator ()
 Create an attribute iterator More...
 
unsafe void DeleteAllAttributesByType (NXOpen.NXObject.AttributeType type)
 Deletes all attributes of a specific type. More...
 
unsafe void DeleteAllAttributesByType (NXOpen.NXObject.AttributeType type, NXOpen.Update.Option option)
 Deletes all attributes of a specific type with the option to update or not. More...
 
unsafe void DeleteAttributeByTypeAndTitle (NXOpen.NXObject.AttributeType type, string title)
 Deletes an attribute by type and title. More...
 
unsafe void DeleteAttributeByTypeAndTitle (NXOpen.NXObject.AttributeType type, string title, NXOpen.Update.Option option)
 Deletes an attribute by type and title with the option to update or not. More...
 
unsafe void DeleteUserAttribute (NXOpen.NXObject.AttributeType type, string title, bool deleteEntireArray, NXOpen.Update.Option option)
 Deletes the first attribute encountered with the given Type, Title. More...
 
unsafe void DeleteUserAttributes (NXOpen.AttributeIterator iterator, NXOpen.Update.Option option)
 Deletes the attributes on the object, if any, that satisfy the given iterator More...
 
unsafe void DeleteUserAttributes (NXOpen.NXObject.AttributeType type, NXOpen.Update.Option option)
 Deletes the attributes encountered with the given Type with option to update or not. More...
 
unsafe NXOpen.INXObject FindObject (string journalIdentifier)
 Finds the NXOpen.NXObject with the given identifier as recorded in a journal. More...
 
unsafe
NXOpen.NXObject.AttributeInformation[] 
GetAttributeTitlesByType (NXOpen.NXObject.AttributeType type)
 Gets all the attribute titles of a specific type. More...
 
unsafe bool GetBooleanUserAttribute (string title, int index)
 Gets a boolean attribute by Title and array Index. More...
 
unsafe
NXOpen.NXObject.ComputationalTime 
GetComputationalTimeUserAttribute (string title, int index)
 Gets a time attribute by Title and array Index. More...
 
unsafe int GetIntegerAttribute (string title)
 Gets an integer attribute by title. More...
 
unsafe int GetIntegerUserAttribute (string title, int index)
 Gets an integer attribute by Title and array Index. More...
 
unsafe bool GetNextUserAttribute (NXOpen.AttributeIterator iterator, out NXOpen.NXObject.AttributeInformation info)
 Gets the next attribute encountered on the object, if any, that satisfies the given iterator. More...
 
unsafe string GetPdmReferenceAttributeValue (string attributeTitle)
 Gets the value of PDM Reference attribute for given object. More...
 
unsafe double GetRealAttribute (string title)
 Gets a real attribute by title. More...
 
unsafe double GetRealUserAttribute (string title, int index)
 Gets a real attribute by Title and array Index. More...
 
unsafe string GetReferenceAttribute (string title)
 Gets the reference string (not the calculated value) of a string attribute that uses a reference string. More...
 
unsafe string GetStringAttribute (string title)
 Gets a string attribute value by title. More...
 
unsafe string GetStringUserAttribute (string title, int index)
 Gets a string attribute by Title and array Index. More...
 
unsafe string GetTimeAttribute (NXOpen.NXObject.DateAndTimeFormat format, string title)
 Gets a time attribute by title. More...
 
unsafe string GetTimeUserAttribute (string title, int index)
 Gets a time attribute by Title and array Index. More...
 
unsafe
NXOpen.NXObject.AttributeInformation 
GetUserAttribute (string title, NXOpen.NXObject.AttributeType type, int index)
 Gets the first attribute encountered on the object, if any, with a given Title, Type and array Index. More...
 
unsafe
NXOpen.NXObject.AttributeInformation[] 
GetUserAttribute (string title, bool includeUnset, bool addStringValues, NXOpen.NXObject.AttributeType type)
 Gets the first attribute (or attribute array) encountered on the object, if any, with a given Title and Type. More...
 
unsafe string GetUserAttributeAsString (string title, NXOpen.NXObject.AttributeType type, int index)
 Gets the first attribute encountered on the object, if any, with a given title, type and array index. More...
 
unsafe int GetUserAttributeCount (NXOpen.AttributeIterator iterator)
 Gets the count of set attributes on the object, if any, that satisfy the given iterator. More...
 
unsafe int GetUserAttributeCount (NXOpen.AttributeIterator iterator, bool countArrayAsOneAttribute)
 Gets the count of set attributes on the object, if any, that satisfy the given iterator. More...
 
unsafe int GetUserAttributeCount (NXOpen.NXObject.AttributeType type)
 Gets the count of set attributes on the object, if any, of the given type. More...
 
unsafe int GetUserAttributeCount (NXOpen.NXObject.AttributeType type, bool includeUnset, bool countArrayAsOneAttribute)
 Gets the count of attributes on the object, if any, of the given type. More...
 
unsafe bool GetUserAttributeLock (string title, NXOpen.NXObject.AttributeType type)
 Determine the lock of the given attribute. More...
 
unsafe
NXOpen.NXObject.AttributeInformation[] 
GetUserAttributes (NXOpen.AttributeIterator iterator)
 Gets all the attributes that have been set on the given object, if any, that satisfy the given iterator. More...
 
unsafe
NXOpen.NXObject.AttributeInformation[] 
GetUserAttributes ()
 Gets all the attributes that have been set on the given object. More...
 
unsafe
NXOpen.NXObject.AttributeInformation[] 
GetUserAttributes (bool includeUnset)
 Gets all the attributes of the given object. More...
 
unsafe
NXOpen.NXObject.AttributeInformation[] 
GetUserAttributes (bool includeUnset, bool addStringValues)
 Gets all the attributes of the given object. More...
 
unsafe string[] GetUserAttributesAsStrings ()
 Gets all the attributes that have been set on the given object. More...
 
unsafe int GetUserAttributeSize (string title, NXOpen.NXObject.AttributeType type)
 Gets the size of the first attribute encountered on the object, if any, with a given Title and Type. More...
 
unsafe NXOpen.NXObject[] GetUserAttributeSourceObjects ()
 Returns an array of objects from which this object presents attributes. More...
 
unsafe bool HasUserAttribute (NXOpen.AttributeIterator iterator)
 Determines if an attribute exists on the object, that satisfies the given iterator More...
 
unsafe bool HasUserAttribute (string title, NXOpen.NXObject.AttributeType type, int index)
 Determines if an attribute with the given Title, Type and array Index is present on the object Unset attributes will not be detected by this function, as its purpose is to test for the actual presence of the attribute on the object. More...
 
unsafe void Print ()
 Prints a representation of this object to the system log file. More...
 
unsafe void SetAttribute (string title, int value)
 Creates or modifies an integer attribute. More...
 
unsafe void SetAttribute (string title, int value, NXOpen.Update.Option option)
 Creates or modifies an integer attribute with the option to update or not. More...
 
unsafe void SetAttribute (string title, double value)
 Creates or modifies a real attribute. More...
 
unsafe void SetAttribute (string title, double value, NXOpen.Update.Option option)
 Creates or modifies a real attribute with the option to update or not. More...
 
unsafe void SetAttribute (string title, string value)
 Creates or modifies a string attribute. More...
 
unsafe void SetAttribute (string title, string value, NXOpen.Update.Option option)
 Creates or modifies a string attribute with the option to update or not. More...
 
unsafe void SetAttribute (string title)
 Creates or modifies a null attribute which is an attribute with a title and no value. More...
 
unsafe void SetAttribute (string title, NXOpen.Update.Option option)
 Creates or modifies a null attribute with the option to update or not. More...
 
unsafe void SetBooleanUserAttribute (string title, int index, bool value, NXOpen.Update.Option option)
 Creates or modifies a boolean attribute with the option to update or not. More...
 
unsafe void SetName (string name)
 Sets the custom name of the object. More...
 
unsafe void SetPdmReferenceAttribute (string attributeTitle, string attributeValue)
 Sets the value of PDM Reference attribute on the object. More...
 
unsafe void SetReferenceAttribute (string title, string value)
 Creates or modifies a string attribute which uses a reference string. More...
 
unsafe void SetReferenceAttribute (string title, string value, NXOpen.Update.Option option)
 Creates or modifies a string attribute which uses a reference string, with the option to update or not. More...
 
unsafe void SetTimeAttribute (string title, string value)
 Creates or modifies a time attribute. More...
 
unsafe void SetTimeAttribute (string title, string value, NXOpen.Update.Option option)
 Creates or modifies a time attribute with the option to update or not. More...
 
unsafe void SetTimeUserAttribute (string title, int index, string value, NXOpen.Update.Option option)
 Creates or modifies a time attribute with the option to update or not. More...
 
unsafe void SetTimeUserAttribute (string title, int index, NXOpen.NXObject.ComputationalTime value, NXOpen.Update.Option option)
 Creates or modifies a time attribute with the option to update or not. More...
 
unsafe void SetUserAttribute (NXOpen.NXObject.AttributeInformation info, NXOpen.Update.Option option)
 Creates or modifies an attribute with the option to update or not. More...
 
unsafe void SetUserAttribute (string title, int index, int value, NXOpen.Update.Option option)
 Creates or modifies an integer attribute with the option to update or not. More...
 
unsafe void SetUserAttribute (string title, int index, double value, NXOpen.Update.Option option)
 Creates or modifies a real attribute with the option to update or not. More...
 
unsafe void SetUserAttribute (string title, int index, string value, NXOpen.Update.Option option)
 Creates or modifies a string attribute with the option to update or not. More...
 
unsafe void SetUserAttribute (string title, int index, NXOpen.Update.Option option)
 Creates or modifies a null attribute with the option to update or not. More...
 
unsafe void SetUserAttributeLock (string title, NXOpen.NXObject.AttributeType type, bool @lock)
 Lock or unlock the given attribute. More...
 
- Public Member Functions inherited from NXOpen.TaggedObject
void PrintTestData (String variableName)
 <exclude> More...
 
void PrintTestData (String variableName, int lineNumber)
 <exclude> More...
 
override string ToString ()
 Returns a String that represents the current Object. More...
 
- Public Member Functions inherited from NXOpen.Utilities.NXRemotableObject
IMessageCtrl AsyncProcessMessage (IMessage msg, IMessageSink replySink)
 Asynchronously processes the given message. More...
 
IMessage SyncProcessMessage (IMessage msg)
 Synchronously processes the given message. More...
 

Properties

NXOpen.CAM.TrackPointCollection CAMTrackPointCollection [get]
 Returns the CAMTrackPointCollection More...
 

Additional Inherited Members

- Protected Member Functions inherited from NXOpen.TaggedObject
new void initialize ()
 <exclude> More...
 

Detailed Description

Represents a NC group

To obtain an instance of this class use NXOpen.CAM.NCGroupCollection

Created in NX5.0.0

Member Enumeration Documentation

Tool subtypes

Enumerator
Undefined 
Mill5 

Milling tool-5 parameters

Mill7 

Milling tool-7 parameters

Mill10 

Milling tool-10 parameters

MillBall 

Milling tool-Ball mill

DrillStandard 

Drilling tool

DrillCenterBell 

Centerdrill

DrillCountersink 

Countersink

DrillSpotFace 

Spot facing tool

DrillSpotDrill 

Spot drill

DrillBore 

Boring tool

DrillReam 

Reamer

DrillCounterbore 

Counterbore

DrillTap 

Tap

DrillBurnishing 

Burnishing tool

DrillThreadMill 

Thread mill

DrillBackSpotFace 

Back spot facing tool

DrillStep 

Step drill

TurnStandard 

Turning tool-Standard

TurnButton 

Turning tool-Button

TurnBoringBar 

Turning tool-Boring bar

GrooveStandard 

Grooving tool-Standard

GrooveRing 

Grooving tool-Ring

GrooveFullNoseRadius 

Grooving tool-Full nose radius

GrooveUserDefined 

Grooving tool-User defined

ThreadStandard 

Threading tool-Standard

ThreadButress 

Threading tool-Butress

ThreadAcme 

Threading tool-ACME

ThreadTrapezoidal 

Threading tool-Trapezoidal

Generic 

Solid tool generic

Probe 

Probe

MillChamfer 

Milling chamfer mill

MillSpherical 

Milling spherical mill

DrillCore 

Core Drill

StdLaser 

Standard Laser tool

Laser 
DrillBackCountersink 

Back Countersink

CoaxialLaser 

Coaxial Laser tool

DrillBoringBar 

Boring Bar tool

DrillChamferBoringBar 

Chamfer Boring Bar tool

Tool types

Enumerator
Mill 

Milling tool

Drill 

Drilling tool

Turn 

Turning tool

Groove 

Grooving tool

Thread 

Threading tool

Wedm 

WEDM tool

Barrel 

Milling tool-Barrel

Tcutter 

Milling tool-T cutter

Form 

Form tool

DrillSpcGroove 

Milling tool-T cutter

Solid 

Solid tool

MillForm 

User defined mill tool

Laser 

laser tool

Soft 

Member Function Documentation

unsafe NXOpen.CAM.GenericTrackingBuilder NXOpen.CAM.Tool.CreateGenericTrackingBuilder ( NXOpen.CAM.SolidTrackPoint  csoObject)
inline

Creates a Generic Trackpoint builder

Created in NX4.0.0

License requirements: cam_base ("CAM BASE")

Parameters
csoObjectsolid tracking point to be edited
Returns
generic trackpoint builder created
unsafe NXOpen.CAM.ProbeTrackingBuilder NXOpen.CAM.Tool.CreateProbeTrackingBuilder ( NXOpen.CAM.ProbeTrackPoint  csoObject)
inline

Creates a Probe Trackpoint builder

Created in NX4.0.0

License requirements: cam_base ("CAM BASE")

Parameters
csoObjectprobe tracking point to be edited
Returns
probe trackpoint builder created
unsafe NXOpen.CAM.SolidTrackingBuilder NXOpen.CAM.Tool.CreateSolidTrackingBuilder ( NXOpen.CAM.SolidTrackPoint  csoObject)
inline

Creates a Solid Trackpoint builder

Created in NX4.0.0

License requirements: cam_base ("CAM BASE")

Parameters
csoObjectsolid tracking point to be edited
Returns
solid trackpoint builder created
unsafe void NXOpen.CAM.Tool.ExportPart ( string  libRef)
inline

Export part

Created in NX10.0.2

License requirements: None.

Parameters
libRefname of the part including the location
unsafe void NXOpen.CAM.Tool.GetTypeAndSubtype ( out NXOpen.CAM.Tool.Types  type,
out NXOpen.CAM.Tool.Subtypes  subtype 
)
inline

Get cutter type and subtype

Created in NX7.5.0

License requirements: None.

Parameters
typetool type
subtypetool subtype
unsafe bool NXOpen.CAM.Tool.RetrieveHolder ( string  libRef)
inline

Retrieve holder

Created in NX8.0.0

License requirements: None.

Parameters
libReftool library reference
Returns
unsafe void NXOpen.CAM.Tool.UpdateFromLibrary ( )
inline

Update a library tool from the library

Created in NX7.5.0

License requirements: cam_base ("CAM BASE")

Property Documentation

NXOpen.CAM.TrackPointCollection NXOpen.CAM.Tool.CAMTrackPointCollection
get

Returns the CAMTrackPointCollection

Created in NX3.0.0


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