NXOpen .NET Reference  12.0.0
Public Member Functions | List of all members
NXOpen.CAM.FBM.Feature Class Reference

Interface for CAM Feature objects More...

Inheritance diagram for NXOpen.CAM.FBM.Feature:
NXOpen.NXObject NXOpen.IFitTo NXOpen.INXObject NXOpen.INXObject NXOpen.CAM.CAMFeature

Public Member Functions

unsafe NXOpen.CAM.CAMAttribute GetAttribute (string attributeName)
 Gets and 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 SetAttribute (NXOpen.CAM.CAMAttribute tagAttribute)
 Sets the attribute value(s) to the same value(s) as another attribute More...
 
unsafe double GetAttributeDoubleValue (string attributeName)
 Returns the actual attribute value 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 bool IsAttributeOverridden (string attributeName)
 Returns true if attribute is overridden More...
 
unsafe void ResetAttributeValue (string attributeName)
 Resets an attribute to its original value More...
 
unsafe void ResetAttributes ()
 Resets all attributes to their original value More...
 
unsafe void FlipDirection ()
 Flip feature direction More...
 
unsafe void SetCoordinateSystem (NXOpen.Point3d ptValue, NXOpen.Vector3d xAxis, NXOpen.Vector3d yAxis)
 Change the feature coordinate system More...
 
unsafe string GetMachiningArea (NXOpen.DisplayableObject tagEntit)
 Returns the machining area the input entity is part of. More...
 
unsafe void Unlock ()
 Unlock Feature More...
 
- Public Member Functions inherited from NXOpen.NXObject
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 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 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 NXOpen.AttributeIterator CreateAttributeIterator ()
 Create an attribute iterator 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 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 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 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
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 bool GetBooleanUserAttribute (string title, int index)
 Gets a boolean attribute by Title and array Index. More...
 
unsafe int GetIntegerUserAttribute (string title, int index)
 Gets an integer attribute by Title and array Index. More...
 
unsafe double GetRealUserAttribute (string title, int index)
 Gets a real attribute by Title and array Index. More...
 
unsafe string GetStringUserAttribute (string title, int index)
 Gets a string attribute by Title and array Index. More...
 
unsafe string GetTimeUserAttribute (string title, int index)
 Gets a time 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
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 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 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 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.NXObject.AttributeType type, NXOpen.Update.Option option)
 Deletes the attributes encountered with the given Type with option to update or not. More...
 
unsafe void SetUserAttributeLock (string title, NXOpen.NXObject.AttributeType type, bool @lock)
 Lock or unlock the given attribute. More...
 
unsafe bool GetUserAttributeLock (string title, NXOpen.NXObject.AttributeType type)
 Determine the lock of the given attribute. More...
 
unsafe NXOpen.NXObject[] GetUserAttributeSourceObjects ()
 Returns an array of objects from which this object presents attributes. More...
 
unsafe void SetPdmReferenceAttribute (string attributeTitle, string attributeValue)
 Sets the value of PDM Reference attribute on the object. More...
 
unsafe string GetPdmReferenceAttributeValue (string attributeTitle)
 Gets the value of PDM Reference attribute for given object. 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
NXOpen.NXObject.AttributeInformation[] 
GetUserAttributes (bool includeUnset, bool addStringValues)
 Gets all the attributes of the given object. 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 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 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 int GetIntegerAttribute (string title)
 Gets an integer attribute by title. More...
 
unsafe double GetRealAttribute (string title)
 Gets a real attribute by title. More...
 
unsafe string GetStringAttribute (string title)
 Gets a string attribute value by title. More...
 
unsafe string GetTimeAttribute (NXOpen.NXObject.DateAndTimeFormat format, string title)
 Gets a time attribute by title. 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 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 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
NXOpen.NXObject.AttributeInformation[] 
GetAttributeTitlesByType (NXOpen.NXObject.AttributeType type)
 Gets all the attribute titles of a specific type. More...
 
unsafe string[] GetUserAttributesAsStrings ()
 Gets all the attributes that have been set on the given object. More...
 
unsafe NXOpen.INXObject FindObject (string journalIdentifier)
 Finds the NXOpen.NXObject with the given identifier as recorded in a journal. More...
 
unsafe void Print ()
 Prints a representation of this object to the system log file. More...
 
unsafe void SetName (string name)
 Sets the custom name of the object. More...
 

Additional Inherited Members

- Public Types inherited from NXOpen.NXObject
enum  AttributeType {
  Invalid, Null, Boolean, Integer,
  Real, String, Time, Reference,
  Any = 100
}
 Specifies attribute type. More...
 
enum  DateAndTimeFormat { Numeric, Textual }
 Specifies the format of the date and time attribute. More...
 
- Properties inherited from NXOpen.NXObject
unsafe bool IsOccurrence [get]
 Returns whether this object is an occurrence or not. More...
 
unsafe string JournalIdentifier [get]
 Returns the identifier that would be recorded in a journal for this object. More...
 
unsafe string Name [get]
 Returns the custom name of the object. More...
 
unsafe NXOpen.Assemblies.Component OwningComponent [get]
 Returns the owning component, if this object is an occurrence. More...
 
unsafe NXOpen.BasePart OwningPart [get]
 Returns the owning part of this object More...
 
unsafe NXOpen.INXObject Prototype [get]
 Returns the prototype of this object if it is an occurrence. More...
 
- Properties inherited from NXOpen.INXObject
bool IsOccurrence [get]
 Returns whether this object is an occurrence or not. More...
 
string JournalIdentifier [get]
 Returns the identifier that would be recorded in a journal for this object. More...
 
string Name [get]
 Returns the custom name of the object. More...
 
NXOpen.Assemblies.Component OwningComponent [get]
 Returns the owning component, if this object is an occurrence. More...
 
NXOpen.BasePart OwningPart [get]
 Returns the owning part of this object More...
 
NXOpen.INXObject Prototype [get]
 Returns the prototype of this object if it is an occurrence. More...
 

Detailed Description

Interface for CAM Feature objects

This is an abstract class, and cannot be instantiated.

Created in NX9.0.0

Member Function Documentation

unsafe void NXOpen.CAM.FBM.Feature.FlipDirection ( )

Flip feature direction

Created in NX9.0.0

License requirements: cam_base ("CAM BASE")

unsafe NXOpen.CAM.CAMAttribute NXOpen.CAM.FBM.Feature.GetAttribute ( string  attributeName)

Gets and attribute

Created in NX9.0.0

License requirements: None.

Parameters
attributeNamethe attribute name
Returns
the attribute
unsafe double NXOpen.CAM.FBM.Feature.GetAttributeDoubleValue ( string  attributeName)

Returns the actual attribute value

Created in NX9.0.0

License requirements: None.

Parameters
attributeNamethe attribute name
Returns
the attribute value
unsafe string NXOpen.CAM.FBM.Feature.GetMachiningArea ( NXOpen.DisplayableObject  tagEntit)

Returns the machining area the input entity is part of.

If the input entity is not part of the feature the return string is empty

Created in NX9.0.3

License requirements: None.

Parameters
tagEntitinput geometry
Returns
unsafe bool NXOpen.CAM.FBM.Feature.IsAttributeOverridden ( string  attributeName)

Returns true if attribute is overridden

Created in NX9.0.0

License requirements: None.

Parameters
attributeNamethe attribute name
Returns
the override flag
unsafe void NXOpen.CAM.FBM.Feature.OverrideAttributeValue ( string  attributeName,
double  dValue 
)

Overrides the attribute value

Created in NX9.0.0

License requirements: cam_base ("CAM BASE")

Parameters
attributeNamethe attribute name
dValuethe attribute value
unsafe void NXOpen.CAM.FBM.Feature.OverrideAttributeValue ( string  attributeName,
int  nValue 
)

Overrides the attribute value

Created in NX9.0.0

License requirements: cam_base ("CAM BASE")

Parameters
attributeNamethe attribute name
nValuethe attribute value
unsafe void NXOpen.CAM.FBM.Feature.OverrideAttributeValue ( string  attributeName,
bool  bValue 
)

Overrides the attribute value

Created in NX9.0.0

License requirements: cam_base ("CAM BASE")

Parameters
attributeNamethe attribute name
bValuethe attribute value
unsafe void NXOpen.CAM.FBM.Feature.OverrideAttributeValue ( string  attributeName,
string  strValue 
)

Overrides the attribute value

Created in NX9.0.0

License requirements: cam_base ("CAM BASE")

Parameters
attributeNamethe attribute name
strValuethe attribute value
unsafe void NXOpen.CAM.FBM.Feature.OverrideAttributeValue ( string  attributeName,
NXOpen.Point3d  ptValue 
)

Overrides the attribute value

Created in NX9.0.0

License requirements: cam_base ("CAM BASE")

Parameters
attributeNamethe attribute name
ptValuethe attribute value
unsafe void NXOpen.CAM.FBM.Feature.OverrideAttributeValue ( string  attributeName,
NXOpen.Vector3d  vecValue 
)

Overrides the attribute value

Created in NX9.0.0

License requirements: cam_base ("CAM BASE")

Parameters
attributeNamethe attribute name
vecValuethe attribute value
unsafe void NXOpen.CAM.FBM.Feature.ResetAttributes ( )

Resets all attributes to their original value

Created in NX9.0.0

License requirements: cam_base ("CAM BASE")

unsafe void NXOpen.CAM.FBM.Feature.ResetAttributeValue ( string  attributeName)

Resets an attribute to its original value

Created in NX9.0.0

License requirements: cam_base ("CAM BASE")

Parameters
attributeNamethe attribute name
unsafe void NXOpen.CAM.FBM.Feature.SetAttribute ( NXOpen.CAM.CAMAttribute  tagAttribute)

Sets the attribute value(s) to the same value(s) as another attribute

Created in NX9.0.1

License requirements: cam_base ("CAM BASE")

Parameters
tagAttributethe attribute
unsafe void NXOpen.CAM.FBM.Feature.SetAttributeValue ( string  attributeName,
double  dValue 
)

Sets the attribute value

Created in NX9.0.0

License requirements: cam_base ("CAM BASE")

Parameters
attributeNamethe attribute name
dValuethe attribute value
unsafe void NXOpen.CAM.FBM.Feature.SetAttributeValue ( string  attributeName,
string  strValue 
)

Sets the attribute value

Created in NX9.0.1

License requirements: cam_base ("CAM BASE")

Parameters
attributeNamethe attribute name
strValuethe attribute value
unsafe void NXOpen.CAM.FBM.Feature.SetAttributeValue ( string  attributeName,
int  nValue 
)

Sets the attribute value

Created in NX9.0.1

License requirements: cam_base ("CAM BASE")

Parameters
attributeNamethe attribute name
nValuethe attribute value
unsafe void NXOpen.CAM.FBM.Feature.SetAttributeValue ( string  attributeName,
bool  bValue 
)

Sets the attribute value

Created in NX9.0.1

License requirements: cam_base ("CAM BASE")

Parameters
attributeNamethe attribute name
bValuethe attribute value
unsafe void NXOpen.CAM.FBM.Feature.SetCoordinateSystem ( NXOpen.Point3d  ptValue,
NXOpen.Vector3d  xAxis,
NXOpen.Vector3d  yAxis 
)

Change the feature coordinate system

Created in NX9.0.1

License requirements: cam_base ("CAM BASE")

Parameters
ptValuethe new feature origin
xAxisthe new feature x axis
yAxisthe new feature y axis
unsafe void NXOpen.CAM.FBM.Feature.Unlock ( )

Unlock Feature

Created in NX11.0.2

License requirements: cam_base ("CAM BASE")


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