InterfaceObject Class

class NXOpen.Assemblies.ProductInterface.InterfaceObject

Bases: NXOpen.NXObject

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()

New in version NX5.0.0.

Properties

Property Description
IsOccurrence Returns whether this object is an occurrence or not.
JournalIdentifier Returns the identifier that would be recorded in a journal for this object.
Name Returns the custom name of the object.
OwningComponent Returns the owning component, if this object is an occurrence.
OwningPart Returns the owning part of this object
Prototype Returns the prototype of this object if it is an occurrence.
Tag Returns the Tag for this object.

Methods

Method Description
BreakPIReferencingLinks Breaks referencing link of PI when usage type changes.
CheckProductInterfaceObject Check the invalid state of product interface object
CreateAttributeIterator Create an attribute iterator
DeleteAllAttributesByType Deletes all attributes of a specific type.
DeleteAttributeByTypeAndTitle Deletes an attribute by type and title.
DeleteUserAttribute Deletes the first attribute encountered with the given Type, Title.
DeleteUserAttributes Deletes the attributes on the object, if any, that satisfy the given iterator
FindObject Finds the NXOpen.NXObject with the given identifier as recorded in a journal.
FixInvalidProductInterfaceObject Fix the invalid state of product interface object
GetAttributeTitlesByType Gets all the attribute titles of a specific type.
GetBooleanUserAttribute Gets a boolean attribute by Title and array Index.
GetComputationalTimeUserAttribute Gets a time attribute by Title and array Index.
GetIntegerAttribute Gets an integer attribute by title.
GetIntegerUserAttribute Gets an integer attribute by Title and array Index.
GetInterfaceUsageType Returns the usage type of the product interface object
GetNextUserAttribute Gets the next attribute encountered on the object, if any, that satisfies the given iterator.
GetPdmReferenceAttributeValue Gets the value of PDM Reference attribute for given object.
GetProductInterfaceDefiningEntity Returns the underlying NX object referenced by the input product interface object
GetProductInterfaceObjectStatus Returns the status of the input product interface object
GetProductInterfaceObjectType Returns the type of the input product interface object
GetRealAttribute Gets a real attribute by title.
GetRealUserAttribute Gets a real attribute by Title and array Index.
GetReferenceAttribute Gets the reference string (not the calculated value) of a string attribute that uses a reference string.
GetRelatedExpressions Returns all expressions related to the product interface object
GetStringAttribute Gets a string attribute value by title.
GetStringUserAttribute Gets a string attribute by Title and array Index.
GetTimeAttribute Gets a time attribute by title.
GetTimeUserAttribute Gets a time attribute by Title and array Index.
GetUserAttribute Gets the first attribute encountered on the object, if any, with a given Title, Type and array Index.
GetUserAttributeAsString Gets the first attribute encountered on the object, if any, with a given title, type and array index.
GetUserAttributeCount Gets the count of set attributes on the object, if any, that satisfy the given iterator.
GetUserAttributeLock Determine the lock of the given attribute.
GetUserAttributeSize Gets the size of the first attribute encountered on the object, if any, with a given Title and Type.
GetUserAttributeSourceObjects Returns an array of objects from which this object presents attributes.
GetUserAttributes Gets all the attributes that have been set on the given object, if any, that satisfy the given iterator.
GetUserAttributesAsStrings Gets all the attributes that have been set on the given object.
GetUserComments Returns the user comments on the input product interface object
HasUserAttribute Determines if an attribute exists on the object, that satisfies the given iterator
InsertRelatedExpressions Relate expressions to the product interface
Print Prints a representation of this object to the system log file.
RemoveAllRelatedExpressions Removes all related expressions from the product interface object
RemoveProductInterfaceObject Removes an object from the product interface set; currently supported types are expressions and geometry
RemoveRelatedExpression Removes related expression from the product interface object
RenameProductInterfaceObject Renames an object from the product interface set
SetAttribute Creates or modifies an integer attribute.
SetBooleanUserAttribute Creates or modifies a boolean attribute with the option to update or not.
SetInterfaceUsageType Sets the usage type on the product interface object
SetName Sets the custom name of the object.
SetPdmReferenceAttribute Sets the value of PDM Reference attribute on the object.
SetReferenceAttribute Creates or modifies a string attribute which uses a reference string.
SetTimeAttribute Creates or modifies a time attribute.
SetTimeUserAttribute Creates or modifies a time attribute with the option to update or not.
SetUserAttribute Creates or modifies an attribute with the option to update or not.
SetUserAttributeLock Lock or unlock the given attribute.
SetUserComments Sets the user comments on the input product interface object

Enumerations

InterfaceObjectInterfaceUsageType Enumeration An enum representing product interface usage types
InterfaceObjectInvalidState Enumeration Invalid state of problematic product interface object

Property Detail

IsOccurrence

InterfaceObject.IsOccurrence

Returns whether this object is an occurrence or not.

-------------------------------------

Getter Method

Signature IsOccurrence

Returns:This object is an occurrence
Return type:bool

New in version NX3.0.0.

License requirements: None.

JournalIdentifier

InterfaceObject.JournalIdentifier

Returns the identifier that would be recorded in a journal for this object.

This may not be the same across different releases of the software.

-------------------------------------

Getter Method

Signature JournalIdentifier

Returns:
Return type:str

New in version NX3.0.0.

License requirements: None.

Name

InterfaceObject.Name

Returns the custom name of the object.

-------------------------------------

Getter Method

Signature Name

Returns:
Return type:str

New in version NX3.0.0.

License requirements: None.

OwningComponent

InterfaceObject.OwningComponent

Returns the owning component, if this object is an occurrence.

-------------------------------------

Getter Method

Signature OwningComponent

Returns:
Return type:NXOpen.Assemblies.Component

New in version NX3.0.0.

License requirements: None.

OwningPart

InterfaceObject.OwningPart

Returns the owning part of this object

-------------------------------------

Getter Method

Signature OwningPart

Returns:The owning part of this object or null if it does not have an owner
Return type:NXOpen.BasePart

New in version NX3.0.0.

License requirements: None.

Prototype

InterfaceObject.Prototype

Returns the prototype of this object if it is an occurrence.

-------------------------------------

Getter Method

Signature Prototype

Returns:The prototype of this object or null if this object is not an occurrence
Return type:NXOpen.INXObject

New in version NX3.0.0.

License requirements: None.

Method Detail

CheckProductInterfaceObject

InterfaceObject.CheckProductInterfaceObject

Check the invalid state of product interface object

Signature CheckProductInterfaceObject()

Returns:The state of product interface object
Return type:NXOpen.Assemblies.ProductInterface.InterfaceObjectInvalidState

New in version NX10.0.1.

License requirements: None.

FindObject

InterfaceObject.FindObject

Finds the NXOpen.NXObject with the given identifier as recorded in a journal.

An object may not return the same value as its JournalIdentifier in different versions of the software. However newer versions of the software should find the same object when FindObject is passed older versions of its journal identifier. In general, this method should not be used in handwritten code and exists to support record and playback of journals.

An exception will be thrown if no object can be found with the given journal identifier.

Signature FindObject(journalIdentifier)

Parameters:journalIdentifier (str) – Journal identifier of the object
Returns:
Return type:NXOpen.INXObject

New in version NX3.0.0.

License requirements: None.

FixInvalidProductInterfaceObject

InterfaceObject.FixInvalidProductInterfaceObject

Fix the invalid state of product interface object

Signature FixInvalidProductInterfaceObject()

Returns:if true the product interface has an issue and is fixed
Return type:bool

New in version NX10.0.1.

License requirements: None.

GetInterfaceUsageType

InterfaceObject.GetInterfaceUsageType

Returns the usage type of the product interface object

Signature GetInterfaceUsageType()

Returns:usage type of the product interface object
Return type:NXOpen.Assemblies.ProductInterface.InterfaceObjectInterfaceUsageType

New in version NX12.0.0.

License requirements: None.

GetProductInterfaceDefiningEntity

InterfaceObject.GetProductInterfaceDefiningEntity

Returns the underlying NX object referenced by the input product interface object

Signature GetProductInterfaceDefiningEntity()

Returns:nx item referenced by the product interface
Return type:NXOpen.NXObject

New in version NX5.0.1.

License requirements: None.

GetProductInterfaceObjectStatus

InterfaceObject.GetProductInterfaceObjectStatus

Returns the status of the input product interface object

Signature GetProductInterfaceObjectStatus()

Returns:status of the product interface object
Return type:str

New in version NX5.0.1.

License requirements: None.

GetProductInterfaceObjectType

InterfaceObject.GetProductInterfaceObjectType

Returns the type of the input product interface object

Signature GetProductInterfaceObjectType()

Returns:type of the product interface object
Return type:str

New in version NX5.0.1.

License requirements: None.

GetRelatedExpressions

InterfaceObject.GetRelatedExpressions

Returns all expressions related to the product interface object

Signature GetRelatedExpressions()

Returns:expressions related to the product interface
Return type:list of NXOpen.NXObject

New in version NX12.0.0.

License requirements: None.

GetUserComments

InterfaceObject.GetUserComments

Returns the user comments on the input product interface object

Signature GetUserComments()

Returns:user comments on the product interface object
Return type:str

New in version NX5.0.1.

License requirements: None.

InsertRelatedExpressions

InterfaceObject.InsertRelatedExpressions

Relate expressions to the product interface

Signature InsertRelatedExpressions(relatedExps)

Parameters:relatedExps (list of NXOpen.NXObject) – Expressions to relate to the product interface

New in version NX12.0.0.

License requirements: None.

Print

InterfaceObject.Print

Prints a representation of this object to the system log file.

Signature Print()

New in version NX3.0.0.

License requirements: None.

RemoveAllRelatedExpressions

InterfaceObject.RemoveAllRelatedExpressions

Removes all related expressions from the product interface object

Signature RemoveAllRelatedExpressions()

Returns:number of expressions removed
Return type:int

New in version NX12.0.0.

License requirements: None.

RemoveProductInterfaceObject

InterfaceObject.RemoveProductInterfaceObject

Removes an object from the product interface set; currently supported types are expressions and geometry

Signature RemoveProductInterfaceObject()

New in version NX9.0.0.

License requirements: None.

RemoveRelatedExpression

InterfaceObject.RemoveRelatedExpression

Removes related expression from the product interface object

Signature RemoveRelatedExpression(relatedExp)

Parameters:relatedExp (NXOpen.NXObject) – the expression to have a relation to product inerface

New in version NX12.0.0.

License requirements: None.

RenameProductInterfaceObject

InterfaceObject.RenameProductInterfaceObject

Renames an object from the product interface set

Signature RenameProductInterfaceObject(name)

Parameters:name (str) – user defined name to be set on the product interface object, if it is empty reset it to default name

New in version NX9.0.0.

License requirements: None.

SetInterfaceUsageType

InterfaceObject.SetInterfaceUsageType

Sets the usage type on the product interface object

Signature SetInterfaceUsageType(usageType)

Parameters:usageType (NXOpen.Assemblies.ProductInterface.InterfaceObjectInterfaceUsageType) – usage type to be set on the product interface object

New in version NX12.0.0.

License requirements: None.

SetName

InterfaceObject.SetName

Sets the custom name of the object.

NOTE: This method should not be used to edit a read-only object such as a Mirrored PMI object. If it is, the changes will be overridden when the part is updated.

Signature SetName(name)

Parameters:name (str) –

New in version NX3.0.0.

License requirements: None.

SetUserComments

InterfaceObject.SetUserComments

Sets the user comments on the input product interface object

Signature SetUserComments(userComments)

Parameters:userComments (str) – user comments to be set on the product interface object

New in version NX5.0.1.

License requirements: None.