NXOpen .NET Reference
12.0.0
|
Represents interface for all CAM Object More...
Classes | |
struct | _ErrorItem |
Error Item | |
struct | ErrorItem |
Error Item More... | |
Public Member Functions | |
unsafe void | SetIntegerValue (string title, int value) |
Set an integer value 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 | SetStringValue (string title, string value) |
Set a string value to the parameter index for the object. More... | |
unsafe void | SetBooleanValue (string title, bool value) |
Set a boolean 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 | 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 | 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... | |
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 | SetRealArrayValue (string title, double[] value) |
Set real array 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 | SetObjectArrayValue (string title, NXOpen.NXObject[] value) |
Set object array to the parameter index for the object More... | |
unsafe int | GetIntegerValue (string title) |
Get the integer 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 bool | GetBooleanValue (string title) |
Get the boolean 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 NXOpen.NXObject | GetObject (string title) |
Get the object 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 | 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 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 double[] | GetRealArrayValue (string title) |
Get the real array value of the parameter index from the object. More... | |
unsafe string[] | GetStringArrayValue (string title) |
Get the string array 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.CAMObject.Status | GetStatus () |
Get the status of the input 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 bool | Has911Attribute (NXOpen.CAM.CAMObject.Attr attrId) |
Check if a 911 attribute exists in an object. More... | |
unsafe NXOpen.CAM.Path | GetPath () |
Returns the path More... | |
unsafe void | SavePath (NXOpen.CAM.Path theBuilder) |
This must be called to establish proper part status More... | |
unsafe bool | AskPathExists () |
Tells if the object has a path More... | |
unsafe NXOpen.CAM.Path | CreateEmptyPath () |
Create an empty path for the object 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 | |
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... | |
Represents interface for all CAM Object
To create or edit an instance of this class, use NXOpen.CAM.ParamBuilder
Created in NX4.0.0
Represents the CAM attribute type.
unsafe bool NXOpen.CAM.CAMObject.AskPathExists | ( | ) |
Tells if the object has a path
Created in NX11.0.2
License requirements: cam_base ("CAM BASE")
unsafe NXOpen.CAM.Path NXOpen.CAM.CAMObject.CreateEmptyPath | ( | ) |
Create an empty path for the object
Created in NX11.0.2
License requirements: cam_base ("CAM BASE")
unsafe bool NXOpen.CAM.CAMObject.GetBooleanValue | ( | string | title | ) |
Get the boolean value of the parameter index from the object
Created in NX4.0.0
License requirements: cam_base ("CAM BASE")
title | the name of the parameter index |
unsafe NXOpen.CAM.CAMObject.FeedRateUnit NXOpen.CAM.CAMObject.GetFeedRate | ( | string | title, |
out double | value | ||
) |
Get the feed rate value and unit of the parameter index from the object
Created in NX4.0.0
License requirements: cam_base ("CAM BASE")
title | the name of the parameter index |
value | the feed rate value |
unsafe int NXOpen.CAM.CAMObject.GetFeedRateColor | ( | string | title | ) |
Get the feed rate color of the parameter index from the object.
Created in NX4.0.0
License requirements: cam_base ("CAM BASE")
title | the name of the parameter index |
unsafe int [] NXOpen.CAM.CAMObject.GetIntegerArrayValue | ( | string | title | ) |
Get the integer array value of the parameter index from the object.
Created in NX4.0.0
License requirements: cam_base ("CAM BASE")
title | the name of the parameter index |
unsafe int NXOpen.CAM.CAMObject.GetIntegerValue | ( | string | title | ) |
Get the integer value of the parameter index from the object.
Created in NX4.0.0
License requirements: cam_base ("CAM BASE")
title | the name of the parameter index |
unsafe NXOpen.NXObject NXOpen.CAM.CAMObject.GetObject | ( | string | title | ) |
Get the object value of the parameter index from the object
Created in NX4.0.0
License requirements: cam_base ("CAM BASE")
title | the name of the parameter index |
unsafe NXOpen.NXObject [] NXOpen.CAM.CAMObject.GetObjectArrayValue | ( | string | title | ) |
Get the object array value of the parameter index from the object.
Created in NX4.0.0
License requirements: cam_base ("CAM BASE")
title | the name of the parameter index |
unsafe NXOpen.CAM.Path NXOpen.CAM.CAMObject.GetPath | ( | ) |
Returns the path
Created in NX11.0.2
License requirements: cam_base ("CAM BASE")
unsafe double [] NXOpen.CAM.CAMObject.GetRealArrayValue | ( | string | title | ) |
Get the real array value of the parameter index from the object.
Created in NX4.0.0
License requirements: cam_base ("CAM BASE")
title | the name of the parameter index |
unsafe double NXOpen.CAM.CAMObject.GetRealValue | ( | string | title | ) |
Get the real value of the parameter index from the object.
Created in NX4.0.0
License requirements: cam_base ("CAM BASE")
title | the name of the parameter index |
unsafe NXOpen.CAM.CAMObject.Status NXOpen.CAM.CAMObject.GetStatus | ( | ) |
Get the status of the input object.
Created in NX6.0.0
License requirements: cam_base ("CAM BASE")
unsafe string [] NXOpen.CAM.CAMObject.GetStringArrayValue | ( | string | title | ) |
Get the string array value of the parameter index from the object.
Created in NX4.0.0
License requirements: cam_base ("CAM BASE")
title | the name of the parameter index |
unsafe string NXOpen.CAM.CAMObject.GetStringValue | ( | string | title | ) |
Get the string value of the parameter index from the object
Created in NX4.0.0
License requirements: cam_base ("CAM BASE")
title | the name of the parameter index |
unsafe int NXOpen.CAM.CAMObject.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.
Created in NX4.0.0
License requirements: cam_base ("CAM BASE")
title | the name of the parameter index |
value | the feed rate value |
unsafe bool NXOpen.CAM.CAMObject.Has911Attribute | ( | NXOpen.CAM.CAMObject.Attr | attrId | ) |
Check if a 911 attribute exists in an object.
Created in NX5.0.0
License requirements: cam_base ("CAM BASE")
attrId | the attribute Id |
unsafe void NXOpen.CAM.CAMObject.Remove911Attribute | ( | NXOpen.CAM.CAMObject.Attr | attrId | ) |
Remove a specific 911 attribute from an object.
Created in NX5.0.0
License requirements: cam_base ("CAM BASE")
attrId | the attribute Id |
unsafe void NXOpen.CAM.CAMObject.RemoveAll911Attributes | ( | ) |
Remove all 911 attributes from an object.
Created in NX5.0.0
License requirements: cam_base ("CAM BASE")
unsafe void NXOpen.CAM.CAMObject.SavePath | ( | NXOpen.CAM.Path | theBuilder | ) |
This must be called to establish proper part status
Created in NX11.0.2
License requirements: cam_base ("CAM BASE")
theBuilder |
unsafe void NXOpen.CAM.CAMObject.SetBooleanValue | ( | string | title, |
bool | value | ||
) |
Set a boolean value to the parameter index for the object.
Created in NX4.0.0
License requirements: cam_base ("CAM BASE")
title | the name of the parameter index |
value | the boolean value |
unsafe void NXOpen.CAM.CAMObject.SetFeedRate | ( | string | title, |
double | value, | ||
NXOpen.CAM.CAMObject.FeedRateUnit | unit | ||
) |
Set feed rate value and unit to the parameter index for the object.
Created in NX4.0.0
License requirements: cam_base ("CAM BASE")
title | the name of the parameter index |
value | the feed rate value |
unit | the feed rate unit |
unsafe void NXOpen.CAM.CAMObject.SetFeedRateColor | ( | string | title, |
int | value | ||
) |
Set feed rate display color to the parameter index for the object.
Created in NX4.0.0
License requirements: cam_base ("CAM BASE")
title | the name of the paramter index |
value | the color number |
unsafe void NXOpen.CAM.CAMObject.SetIntegerArrayValue | ( | string | title, |
int[] | value | ||
) |
Set integer array value to the parameter index for the object.
Created in NX4.0.0
License requirements: cam_base ("CAM BASE")
title | the name of the parameter index |
value | the integer array |
unsafe void NXOpen.CAM.CAMObject.SetIntegerValue | ( | string | title, |
int | value | ||
) |
Set an integer value to the parameter index for the object.
Created in NX4.0.0
License requirements: cam_base ("CAM BASE")
title | the name of the parameter index |
value | the integer value |
unsafe void NXOpen.CAM.CAMObject.SetObject | ( | string | title, |
NXOpen.NXObject | value | ||
) |
Set a object to the parameter index for the object.
Created in NX4.0.0
License requirements: cam_base ("CAM BASE")
title | the name of the parameter index |
value | the object |
unsafe void NXOpen.CAM.CAMObject.SetObjectArrayValue | ( | string | title, |
NXOpen.NXObject[] | value | ||
) |
Set object array to the parameter index for the object
Created in NX4.0.0
License requirements: cam_base ("CAM BASE")
title | the name of the parameter index |
value | the object array |
unsafe void NXOpen.CAM.CAMObject.SetRealArrayValue | ( | string | title, |
double[] | value | ||
) |
Set real array to the parameter index for the object.
Created in NX4.0.0
License requirements: cam_base ("CAM BASE")
title | the name of the parameter index |
value | the real array |
unsafe void NXOpen.CAM.CAMObject.SetRealValue | ( | string | title, |
double | value | ||
) |
Set a real value to the parameter index for the object.
Created in NX4.0.0
License requirements: cam_base ("CAM BASE")
title | the name of the parameter index |
value | the real value |
unsafe void NXOpen.CAM.CAMObject.SetStringArrayValue | ( | string | title, |
string[] | value | ||
) |
Set string array to the parameter index for the object
Created in NX4.0.0
License requirements: cam_base ("CAM BASE")
title | the name of the parameter index |
value | the string array |
unsafe void NXOpen.CAM.CAMObject.SetStringValue | ( | string | title, |
string | value | ||
) |
Set a string value to the parameter index for the object.
Created in NX4.0.0
License requirements: cam_base ("CAM BASE")
title | the name of the parameter index |
value | the string value |
unsafe void NXOpen.CAM.CAMObject.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.
Created in NX4.0.0
License requirements: cam_base ("CAM BASE")
title | the name of the parameter index |
value | the feed rate value |
side | Inside = 0, Outside = 1 |