PipeBuilder Class¶

class NXOpen.Diagramming.PipeBuilder¶

Bases: NXOpen.Builder

Represents a PipeBuilder.

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

New in version NX10.0.0.

Properties¶

Property	Description
Connection	Returns the connection of this pipe.
EndArrowType	Returns or sets the end arrow type.
FlowDirectionLocations	Returns the location of the flow direction symbol.
Label	Returns the label of this pipe.
OwningSheet	Returns the Owning Sheet of this sheet element.
StartArrowType	Returns or sets the start arrow type.
SymbolId	Returns the symbol ID of this pipe.
Tag	Returns the Tag for this object.

Methods¶

Method	Description
AddFlowDirection	Add a flow direction symbol to the connetion.
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.
GetConnectionRenderingProperties	Get connection rendering properties.
GetObject	Returns the object currently being edited by this builder.
Initialize	Set the connection owning sheet and the connection 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¶

Connection¶

PipeBuilder.Connection¶

Returns the connection of this pipe.

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

Getter Method

Signature Connection()

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

New in version NX10.0.0.

License requirements: None.

EndArrowType¶

PipeBuilder.EndArrowType¶

Returns or sets the end arrow type.

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

Getter Method

Signature EndArrowType()

Returns:
Return type:	str

New in version NX10.0.0.

License requirements: None.

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

Setter Method

Signature EndArrowType(endArrowType)

Parameters:	endArrowType (str) –

New in version NX10.0.0.

License requirements: None.

FlowDirectionLocations¶

PipeBuilder.FlowDirectionLocations¶

Returns the location of the flow direction symbol.

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

Getter Method

Signature FlowDirectionLocations()

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

New in version NX10.0.0.

License requirements: None.

Label¶

PipeBuilder.Label¶

Returns the label of this pipe.

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

Getter Method

Signature Label()

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

New in version NX10.0.0.

License requirements: None.

OwningSheet¶

PipeBuilder.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.

StartArrowType¶

PipeBuilder.StartArrowType¶

Returns or sets the start arrow type.

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

Getter Method

Signature StartArrowType()

Returns:
Return type:	str

New in version NX10.0.0.

License requirements: None.

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

Setter Method

Signature StartArrowType(startArrowType)

Parameters:	startArrowType (str) –

New in version NX10.0.0.

License requirements: None.

SymbolId¶

PipeBuilder.SymbolId¶

Returns the symbol ID of this pipe.

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

Getter Method

Signature SymbolId()

Returns:
Return type:	str

New in version NX10.0.0.

License requirements: None.

Method Detail¶

AddFlowDirection¶

PipeBuilder.AddFlowDirection¶

Add a flow direction symbol to the connetion.

Signature AddFlowDirection()

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

New in version NX10.0.0.

License requirements: None.

GetConnectionRenderingProperties¶

PipeBuilder.GetConnectionRenderingProperties¶

Get connection rendering properties.

Signature GetConnectionRenderingProperties()

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

New in version NX10.0.0.

License requirements: None.

Initialize¶

PipeBuilder.Initialize¶

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

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

Signature Initialize(owningSheet, symbolId)

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

New in version NX10.0.0.

License requirements: None.

Validate¶

PipeBuilder.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.