Represents a Product Interface Object Builder. More...
Inheritance diagram for NXOpen.Assemblies.ProductInterface.InterfaceObject:
Public Types | |
| enum | InvalidState { Valid, Sleeping, IncorrectOrphan, SelfReferenced } |
| Invalid state of problematic product interface object More... | |
| enum | InterfaceUsageType { Unknown, Output, Input, KeyPerformanceInterface } |
| An enum representing product interface usage types More... | |
 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... | |
Public Member Functions | |
| unsafe string | GetProductInterfaceObjectType () |
| Returns the type of the input product interface object More... | |
| unsafe NXOpen.NXObject | GetProductInterfaceDefiningEntity () |
| Returns the underlying NX object referenced by the input product interface object More... | |
| unsafe string | GetProductInterfaceObjectStatus () |
| Returns the status of the input product interface object More... | |
| unsafe void | SetUserComments (string userComments) |
| Sets the user comments on the input product interface object More... | |
| unsafe string | GetUserComments () |
| Returns the user comments on the input product interface object More... | |
| unsafe void | RemoveProductInterfaceObject () |
| Removes an object from the product interface set; currently supported types are expressions and geometry More... | |
| unsafe void | RenameProductInterfaceObject (string name) |
| Renames an object from the product interface set More... | |
| unsafe NXOpen.Assemblies.ProductInterface.InterfaceObject.InvalidState | CheckProductInterfaceObject () |
| Check the invalid state of product interface object More... | |
| unsafe bool | FixInvalidProductInterfaceObject () |
| Fix the invalid state of product interface object More... | |
| unsafe void | InsertRelatedExpressions (NXOpen.NXObject[] relatedExps) |
| Relate expressions to the product interface More... | |
| unsafe void | RemoveRelatedExpression (NXOpen.NXObject relatedExp) |
| Removes related expression from the product interface object More... | |
| unsafe int | RemoveAllRelatedExpressions () |
| Removes all related expressions from the product interface object More... | |
| unsafe NXOpen.NXObject[] | GetRelatedExpressions () |
| Returns all expressions related to the product interface object More... | |
| unsafe NXOpen.Assemblies.ProductInterface.InterfaceObject.InterfaceUsageType | GetInterfaceUsageType () |
| Returns the usage type of the product interface object More... | |
| unsafe void | SetInterfaceUsageType (NXOpen.Assemblies.ProductInterface.InterfaceObject.InterfaceUsageType usageType) |
| Sets the usage type on the product interface object More... | |
| unsafe void | BreakPIReferencingLinks (NXOpen.Assemblies.ProductInterface.InterfaceObject.InterfaceUsageType usageType) |
| Breaks referencing link of PI when usage type changes. 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... | |
Detailed Description
Represents a Product Interface Object Builder.
It creates a product interface object
To create a new instance of this class, use NXOpen.Assemblies.ProductInterface.ObjectBuilder.AddProductInterfaceObject
Created in NX5.0.0
Member Enumeration Documentation
Member Function Documentation
| unsafe void NXOpen.Assemblies.ProductInterface.InterfaceObject.BreakPIReferencingLinks | ( | NXOpen.Assemblies.ProductInterface.InterfaceObject.InterfaceUsageType | usageType | ) |
Breaks referencing link of PI when usage type changes.
When the product interface type changed to input or key performance interface. Break link feature and inter part expression referring to the product interface.
Created in NX12.0.0
License requirements: None.
- Parameters
-
usageType usage type to be set on the product interface object
| unsafe NXOpen.Assemblies.ProductInterface.InterfaceObject.InvalidState NXOpen.Assemblies.ProductInterface.InterfaceObject.CheckProductInterfaceObject | ( | ) |
Check the invalid state of product interface object
Created in NX10.0.1
License requirements: None.
- Returns
- The state of product interface object
| unsafe bool NXOpen.Assemblies.ProductInterface.InterfaceObject.FixInvalidProductInterfaceObject | ( | ) |
Fix the invalid state of product interface object
Created in NX10.0.1
License requirements: None.
- Returns
- if true the product interface has an issue and is fixed
| unsafe NXOpen.Assemblies.ProductInterface.InterfaceObject.InterfaceUsageType NXOpen.Assemblies.ProductInterface.InterfaceObject.GetInterfaceUsageType | ( | ) |
Returns the usage type of the product interface object
Created in NX12.0.0
License requirements: None.
- Returns
- usage type of the product interface object
| unsafe NXOpen.NXObject NXOpen.Assemblies.ProductInterface.InterfaceObject.GetProductInterfaceDefiningEntity | ( | ) |
Returns the underlying NX object referenced by the input product interface object
Created in NX5.0.1
License requirements: None.
- Returns
- nx item referenced by the product interface
| unsafe string NXOpen.Assemblies.ProductInterface.InterfaceObject.GetProductInterfaceObjectStatus | ( | ) |
Returns the status of the input product interface object
Created in NX5.0.1
License requirements: None.
- Returns
- status of the product interface object
| unsafe string NXOpen.Assemblies.ProductInterface.InterfaceObject.GetProductInterfaceObjectType | ( | ) |
Returns the type of the input product interface object
Created in NX5.0.1
License requirements: None.
- Returns
- type of the product interface object
| unsafe NXOpen.NXObject [] NXOpen.Assemblies.ProductInterface.InterfaceObject.GetRelatedExpressions | ( | ) |
Returns all expressions related to the product interface object
Created in NX12.0.0
License requirements: None.
- Returns
- expressions related to the product interface
| unsafe string NXOpen.Assemblies.ProductInterface.InterfaceObject.GetUserComments | ( | ) |
Returns the user comments on the input product interface object
Created in NX5.0.1
License requirements: None.
- Returns
- user comments on the product interface object
| unsafe void NXOpen.Assemblies.ProductInterface.InterfaceObject.InsertRelatedExpressions | ( | NXOpen.NXObject[] | relatedExps | ) |
Relate expressions to the product interface
Created in NX12.0.0
License requirements: None.
- Parameters
-
relatedExps Expressions to relate to the product interface
| unsafe int NXOpen.Assemblies.ProductInterface.InterfaceObject.RemoveAllRelatedExpressions | ( | ) |
Removes all related expressions from the product interface object
Created in NX12.0.0
License requirements: None.
- Returns
- number of expressions removed
| unsafe void NXOpen.Assemblies.ProductInterface.InterfaceObject.RemoveProductInterfaceObject | ( | ) |
Removes an object from the product interface set; currently supported types are expressions and geometry
Created in NX9.0.0
License requirements: None.
| unsafe void NXOpen.Assemblies.ProductInterface.InterfaceObject.RemoveRelatedExpression | ( | NXOpen.NXObject | relatedExp | ) |
Removes related expression from the product interface object
Created in NX12.0.0
License requirements: None.
- Parameters
-
relatedExp the expression to have a relation to product inerface
| unsafe void NXOpen.Assemblies.ProductInterface.InterfaceObject.RenameProductInterfaceObject | ( | string | name | ) |
Renames an object from the product interface set
Created in NX9.0.0
License requirements: None.
- Parameters
-
name user defined name to be set on the product interface object, if it is empty reset it to default name
| unsafe void NXOpen.Assemblies.ProductInterface.InterfaceObject.SetInterfaceUsageType | ( | NXOpen.Assemblies.ProductInterface.InterfaceObject.InterfaceUsageType | usageType | ) |
Sets the usage type on the product interface object
Created in NX12.0.0
License requirements: None.
- Parameters
-
usageType usage type to be set on the product interface object
| unsafe void NXOpen.Assemblies.ProductInterface.InterfaceObject.SetUserComments | ( | string | userComments | ) |
Sets the user comments on the input product interface object
Created in NX5.0.1
License requirements: None.
- Parameters
-
userComments user comments to be set on the product interface object
The documentation for this class was generated from the following file:
- dotnet_pool/Assemblies_ProductInterface_InterfaceObject.cs