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.CAMFeature Class Reference

Represents a CAM Feature More...

Inheritance diagram for NXOpen.CAM.CAMFeature:
NXOpen.CAM.FBM.Feature NXOpen.NXObject NXOpen.IFitTo NXOpen.TaggedObject NXOpen.INXObject NXOpen.INXObject NXOpen.Utilities.NXRemotableObject IMessageSink

Public Types

enum  ProcessStatus { Empty, Regenerate, Incomplete, Complete }
 Process status of the feature More...
 
enum  State { Deleted, Changed, Updated, UpToDate }
 Update status of the feature More...
 

Public Member Functions

unsafe void ApproveChanges ()
 Approve changes on a CAMFeature More...
 
unsafe NXOpen.Face[] GetFaces ()
 Get the faces associated with the CAMFeature More...
 
unsafe NXOpen.DisplayableObject[] GetGeometry ()
 Get the geometry links associated with the feature More...
 
unsafe NXOpen.CAM.NCGroup[] GetGroups ()
 Get the feature groups in which the CAMFeature is classified More...
 
unsafe NXOpen.CAM.Operation[] GetOperations ()
 Get the operations manufacturing the CAMFeature More...
 
unsafe
NXOpen.CAM.CAMFeature.ProcessStatus 
GetProcessStatus (NXOpen.CAM.NCGroup group)
 Get the process status of the CAMFeature in the context of a feature group More...
 
- Public Member Functions inherited from NXOpen.CAM.FBM.Feature
unsafe void FlipDirection ()
 Flip feature direction More...
 
unsafe NXOpen.CAM.CAMAttribute GetAttribute (string attributeName)
 Gets and attribute More...
 
unsafe double GetAttributeDoubleValue (string attributeName)
 Returns the actual attribute value More...
 
unsafe string GetMachiningArea (NXOpen.DisplayableObject tagEntit)
 Returns the machining area the input entity is part of. More...
 
unsafe bool IsAttributeOverridden (string attributeName)
 Returns true if attribute is overridden More...
 
unsafe void OverrideAttributeValue (string attributeName, double dValue)
 Overrides the attribute value More...
 
unsafe void OverrideAttributeValue (string attributeName, int nValue)
 Overrides the attribute value More...
 
unsafe void OverrideAttributeValue (string attributeName, bool bValue)
 Overrides the attribute value More...
 
unsafe void OverrideAttributeValue (string attributeName, string strValue)
 Overrides the attribute value More...
 
unsafe void OverrideAttributeValue (string attributeName, NXOpen.Point3d ptValue)
 Overrides the attribute value More...
 
unsafe void OverrideAttributeValue (string attributeName, NXOpen.Vector3d vecValue)
 Overrides the attribute value More...
 
unsafe void ResetAttributes ()
 Resets all attributes to their original value More...
 
unsafe void ResetAttributeValue (string attributeName)
 Resets an attribute to its original value More...
 
unsafe void SetAttribute (NXOpen.CAM.CAMAttribute tagAttribute)
 Sets the attribute value(s) to the same value(s) as another attribute More...
 
unsafe void SetAttributeValue (string attributeName, double dValue)
 Sets the attribute value More...
 
unsafe void SetAttributeValue (string attributeName, string strValue)
 Sets the attribute value More...
 
unsafe void SetAttributeValue (string attributeName, int nValue)
 Sets the attribute value More...
 
unsafe void SetAttributeValue (string attributeName, bool bValue)
 Sets the attribute value More...
 
unsafe void SetCoordinateSystem (NXOpen.Point3d ptValue, NXOpen.Vector3d xAxis, NXOpen.Vector3d yAxis)
 Change the feature coordinate system More...
 
unsafe void Unlock ()
 Unlock Feature 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.CAMAttributeCollection Attributes [get]
 The attributes of the machining feature More...
 
unsafe
NXOpen.CartesianCoordinateSystem 
CoordinateSystem [get]
 Returns the coordinate system of the CAMFeature More...
 
unsafe string Name [get, set]
 Returns or sets the name of the CAMFeature More...
 
unsafe string SourceType [get]
 Returns the source of the CAMFeature More...
 
unsafe NXOpen.CAM.CAMFeature.State Status [get]
 Returns the update status of the CAMFeature More...
 
unsafe string Type [get]
 Returns the type name of the CAMFeature More...
 

Additional Inherited Members

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

Detailed Description

Represents a CAM Feature

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

Created in NX7.5.0

Member Enumeration Documentation

Process status of the feature

Enumerator
Empty 

Feature has no operations

Regenerate 

One or more of the feature's operation toolpaths need to regenerate

Incomplete 

One or more of the feature's operation toolpaths are not completed

Complete 

The feature's operation toolpaths are complete

Update status of the feature

Enumerator
Deleted 

Feature is not valid

Changed 

Feature is changed and out of date

Updated 

Feature is changed and updated

UpToDate 

Feature is up to date

Member Function Documentation

unsafe void NXOpen.CAM.CAMFeature.ApproveChanges ( )
inline

Approve changes on a CAMFeature

Created in NX7.5.1

License requirements: cam_base ("CAM BASE")

unsafe NXOpen.Face [] NXOpen.CAM.CAMFeature.GetFaces ( )
inline

Get the faces associated with the CAMFeature

Created in NX7.5.0

License requirements: None.

Returns
unsafe NXOpen.DisplayableObject [] NXOpen.CAM.CAMFeature.GetGeometry ( )
inline

Get the geometry links associated with the feature

Created in NX8.5.0

License requirements: None.

Returns
unsafe NXOpen.CAM.NCGroup [] NXOpen.CAM.CAMFeature.GetGroups ( )
inline

Get the feature groups in which the CAMFeature is classified

Created in NX7.5.0

License requirements: None.

Returns
unsafe NXOpen.CAM.Operation [] NXOpen.CAM.CAMFeature.GetOperations ( )
inline

Get the operations manufacturing the CAMFeature

Created in NX7.5.0

License requirements: None.

Returns
unsafe NXOpen.CAM.CAMFeature.ProcessStatus NXOpen.CAM.CAMFeature.GetProcessStatus ( NXOpen.CAM.NCGroup  group)
inline

Get the process status of the CAMFeature in the context of a feature group

Created in NX7.5.0

License requirements: None.

Parameters
groupfeature group for the operation process context
Returns

Property Documentation

NXOpen.CAM.CAMAttributeCollection NXOpen.CAM.CAMFeature.Attributes
get

The attributes of the machining feature

Created in NX8.0.0

unsafe NXOpen.CartesianCoordinateSystem NXOpen.CAM.CAMFeature.CoordinateSystem
get

Returns the coordinate system of the CAMFeature

Created in NX8.0.0

License requirements: None.

unsafe string NXOpen.CAM.CAMFeature.Name
getset

Returns or sets the name of the CAMFeature

Created in NX7.5.0

License requirements to get this property: None.

License requirements to set this property: cam_base ("CAM BASE")

unsafe string NXOpen.CAM.CAMFeature.SourceType
get

Returns the source of the CAMFeature

Created in NX7.5.0

License requirements: None.

unsafe NXOpen.CAM.CAMFeature.State NXOpen.CAM.CAMFeature.Status
get

Returns the update status of the CAMFeature

Created in NX7.5.0

License requirements: None.

unsafe string NXOpen.CAM.CAMFeature.Type
get

Returns the type name of the CAMFeature

Created in NX7.5.0

License requirements: None.


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