PortDataBuilder Class

class NXOpen.DiagrammingLibraryAuthor.PortDataBuilder

Bases: NXOpen.TaggedObject, NXOpen.GeometricUtilities.IComponentBuilder

Represents a PortDataBuilder.

New in version NX11.0.1.

Properties

Property	Description
NozzleBottom	Returns or sets the nozzle in the bottom edge.
NozzleLeft	Returns or sets the nozzle in the left edge.
NozzleRight	Returns or sets the nozzle in the right edge.
NozzleTop	Returns or sets the nozzle in the top edge
Tag	Returns the Tag for this object.

Methods

Method	Description
CreatePort	Creates a new port
DeletePort	Deletes the port which is new created
GetConnectionDirection	Gets the connection direction
GetPointLocation	Gets the port location
GetPortObjects	Gets the port objects which have user attributes of the port.
SetConnectionDirection	Sets the connection direction
SetPointLocation	Sets the port location
Validate	Validate whether the inputs to the component are sufficient for commit to be called.

Property Detail

NozzleBottom

PortDataBuilder.NozzleBottom

Returns or sets the nozzle in the bottom edge.

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

Getter Method

Signature NozzleBottom

Returns: Return type:bool

New in version NX11.0.1.

License requirements: None.

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

Setter Method

Signature NozzleBottom

Parameters:nozzleBottom (bool) –

New in version NX11.0.1.

License requirements: None.

NozzleLeft

PortDataBuilder.NozzleLeft

Returns or sets the nozzle in the left edge.

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

Getter Method

Signature NozzleLeft

Returns: Return type:bool

New in version NX11.0.1.

License requirements: None.

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

Setter Method

Signature NozzleLeft

Parameters:nozzleLeft (bool) –

New in version NX11.0.1.

License requirements: None.

NozzleRight

PortDataBuilder.NozzleRight

Returns or sets the nozzle in the right edge.

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

Getter Method

Signature NozzleRight

Returns: Return type:bool

New in version NX11.0.1.

License requirements: None.

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

Setter Method

Signature NozzleRight

Parameters:nozzleRight (bool) –

New in version NX11.0.1.

License requirements: None.

NozzleTop

PortDataBuilder.NozzleTop

Returns or sets the nozzle in the top edge

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

Getter Method

Signature NozzleTop

Returns: Return type:bool

New in version NX11.0.1.

License requirements: None.

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

Setter Method

Signature NozzleTop

Parameters:nozzleTop (bool) –

New in version NX11.0.1.

License requirements: None.

Method Detail

CreatePort

PortDataBuilder.CreatePort

Creates a new port

Signature CreatePort()

Returns:the port object Return type:NXOpen.DiagrammingLibraryAuthor.AttributeHolder

New in version NX11.0.1.

License requirements: None.

DeletePort

PortDataBuilder.DeletePort

Deletes the port which is new created

Signature DeletePort(portObject)

Parameters:portObject (NXOpen.DiagrammingLibraryAuthor.AttributeHolder) – the port object, only accept the object which is got by NXOpen.DiagrammingLibraryAuthor.PortDataBuilder.CreatePort()

New in version NX11.0.1.

License requirements: None.

GetConnectionDirection

PortDataBuilder.GetConnectionDirection

Gets the connection direction

Signature GetConnectionDirection(portObject)

Parameters:portObject (NXOpen.DiagrammingLibraryAuthor.AttributeHolder) – the port object, only accept the object which is got by NXOpen.DiagrammingLibraryAuthor.PortDataBuilder.GetPortObjects() or NXOpen.DiagrammingLibraryAuthor.PortDataBuilder.CreatePort() Returns:the connection direction Return type:NXOpen.Point2d

New in version NX11.0.1.

License requirements: None.

GetPointLocation

PortDataBuilder.GetPointLocation

Gets the port location

Signature GetPointLocation(portObject)

Parameters:portObject (NXOpen.DiagrammingLibraryAuthor.AttributeHolder) – the port object, only accept the object which is got by NXOpen.DiagrammingLibraryAuthor.PortDataBuilder.GetPortObjects() or NXOpen.DiagrammingLibraryAuthor.PortDataBuilder.CreatePort() Returns:the port location Return type:NXOpen.Point2d

New in version NX11.0.1.

License requirements: None.

GetPortObjects

PortDataBuilder.GetPortObjects

Gets the port objects which have user attributes of the port.

Signature GetPortObjects()

Returns:the port objects Return type:list of NXOpen.DiagrammingLibraryAuthor.AttributeHolder

New in version NX11.0.1.

License requirements: None.

SetConnectionDirection

PortDataBuilder.SetConnectionDirection

Sets the connection direction

Signature SetConnectionDirection(portObject, connectionDirection)

Parameters:

• portObject (NXOpen.DiagrammingLibraryAuthor.AttributeHolder) – the port object, only accept the object which is got by NXOpen.DiagrammingLibraryAuthor.PortDataBuilder.GetPortObjects() or NXOpen.DiagrammingLibraryAuthor.PortDataBuilder.CreatePort()
• connectionDirection (NXOpen.Point2d) – the connection direction

New in version NX11.0.1.

License requirements: None.

SetPointLocation

PortDataBuilder.SetPointLocation

Sets the port location

Signature SetPointLocation(portObject, portLocation)

Parameters:

• portObject (NXOpen.DiagrammingLibraryAuthor.AttributeHolder) – the port object, only accept the object which is by NXOpen.DiagrammingLibraryAuthor.PortDataBuilder.GetPortObjects() or NXOpen.DiagrammingLibraryAuthor.PortDataBuilder.CreatePort()
• portLocation (NXOpen.Point2d) – the port location

New in version NX11.0.1.

License requirements: None.

Validate

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