EquipmentBuilder Class¶

class NXOpen.Diagramming.EquipmentBuilder¶

Bases: NXOpen.Builder

Represents a EquipmentBuilder.

To create a new instance of this class, use NXOpen.Diagramming.DiagrammingTestManager.CreateEquipmentBuilder()

New in version NX10.0.0.

Properties¶

Property	Description
Label	Returns the label of this equipment.
Node	Returns the node of this equipment.
OwningSheet	Returns the Owning Sheet of this sheet element.
Ports	Returns the list of the ports.
SymbolId	Returns the symbol ID of this equipment.
Tag	Returns the Tag for this object.

Methods¶

Method	Description
AddPort	Add a new `Diagramming.PortBuilder` builder.
Commit	Commits any edits that have been applied to the builder.
Destroy	Deletes the builder, and cleans up any objects created by the builder.
GetCommittedObjects	For builders that create more than one object, this method returns the objects that are created by commit.
GetObject	Returns the object currently being edited by this builder.
Initialize	Set the equipment owning sheet and the equipment symbol ID in reuse library.
ShowResults	Updates the model to reflect the result of an edit to the model for all builders that support showing results.
Validate	Validate whether the inputs to the component are sufficient for commit to be called.

Property Detail¶

Label¶

EquipmentBuilder.Label¶

Returns the label of this equipment.

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

Getter Method

Signature Label()

Returns:
Return type:	`NXOpen.Diagramming.CannedAnnotationBuilder`

New in version NX10.0.0.

License requirements: None.

Node¶

EquipmentBuilder.Node¶

Returns the node of this equipment.

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

Getter Method

Signature Node()

Returns:
Return type:	`NXOpen.Diagramming.NodeBuilder`

New in version NX10.0.0.

License requirements: None.

OwningSheet¶

EquipmentBuilder.OwningSheet¶

Returns the Owning Sheet of this sheet element.

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

Getter Method

Signature OwningSheet()

Returns:
Return type:	`NXOpen.Diagramming.Sheet`

New in version NX10.0.0.

License requirements: None.

Ports¶

EquipmentBuilder.Ports¶

Returns the list of the ports.

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

Getter Method

Signature Ports()

Returns:
Return type:	`NXOpen.Diagramming.PortBuilderList`

New in version NX10.0.0.

License requirements: None.

SymbolId¶

EquipmentBuilder.SymbolId¶

Returns the symbol ID of this equipment.

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

Getter Method

Signature SymbolId()

Returns:
Return type:	str

New in version NX10.0.0.

License requirements: None.

Method Detail¶

AddPort¶

EquipmentBuilder.AddPort¶

Add a new Diagramming.PortBuilder builder.

Signature AddPort(symbolId)

Parameters:	symbolId (str) –
Returns:
Return type:	`NXOpen.Diagramming.PortBuilder`

New in version NX10.0.0.

License requirements: None.

Initialize¶

EquipmentBuilder.Initialize¶

Set the equipment owning sheet and the equipment symbol ID in reuse library.

It must be called after the builder is created, and works only in creation mode.

Signature Initialize(owningSheet, sybmolId)

Parameters:	owningSheet (`NXOpen.Diagramming.Sheet`) – owning sheet of the equipment. sybmolId (str) – item id, as <@>DB/002649/A in ugmanager mode.

New in version NX10.0.0.

License requirements: None.

Validate¶

EquipmentBuilder.Validate¶

Validate whether the inputs to the component are sufficient for commit to be called.

If the component is not in a state to commit then an exception is thrown. For example, if the component requires you to set some property, this method will throw an exception if you haven’t set it. This method throws a not-yet-implemented NXException for some components.

Signature Validate()

Returns:	Was self validation successful
Return type:	bool

New in version NX3.0.1.

License requirements: None.