ConnectionBuilder Class¶
-
class
NXOpen.Diagramming.
ConnectionBuilder
¶ Bases:
NXOpen.Diagramming.SheetElementBuilder
Represents a ConnectionBuilder.
To create a new instance of this class, use
NXOpen.Diagramming.ConnectionCollection.CreateConnectionBuilder()
New in version NX10.0.0.
Properties¶
Property | Description |
---|---|
Discipline | Returns or sets the discipline of this connection. |
End | Returns or sets the end port of this connection. |
EndLocation | Returns the end location of this connection. |
Height | Returns or sets the height. |
HeightPolicy | Returns or sets the height policy. |
Internal | Returns the flag that indicates if the sheet element is internal. |
Label | Returns the label of this sheet element. |
LabelName | Returns or sets the label name of this sheet element. |
Location | Returns the location of the sheet element relative to another sheet element. |
LocationStyle | Returns or sets the location style. |
MirrorX | Returns or sets the sheet element to Mirror along the X axis. |
MirrorY | Returns or sets the sheet element to Mirror along the Y axis. |
Owner | Returns or sets the owning sheet element. |
OwningSheet | Returns the owning sheet. |
ResizeOption | Returns or sets the resize option of the sheet element |
ReverseEnd | Returns the reversed flag of this connection. |
Rotation | Returns or sets the rotation angle that is counter clockwise and relative to the owner. |
SourceElement | Returns the source element that records which sheet element it is a copy of. |
Start | Returns or sets the start port of this connection. |
StartLocation | Returns the start location of this connection. |
Tag | Returns the Tag for this object. |
UpToDate | Returns the flag that indicates if the sheet element is up to date. |
Visible | Returns the flag that indicates if the sheet element is visible. |
Width | Returns or sets the width. |
WidthPolicy | Returns or sets the width policy. |
NXOpen.Diagramming.SheetElementBuilder.X | Returns or sets the absolute x coordinate. |
NXOpen.Diagramming.SheetElementBuilder.Y | Returns or sets the absolute y coordinate. |
ZDepth | Returns or sets the Z depth. |
Methods¶
Method | Description |
---|---|
Commit | Commits any edits that have been applied to the builder. |
Destroy | Deletes the builder, and cleans up any objects created by the builder. |
GetAllowedTransformations | Get the allowed transformations of the sheet element. |
GetBendPoints | Get bending points for polyline to render the connection. |
GetCommittedObjects | For builders that create more than one object, this method returns the objects that are created by commit. |
GetMinNodeSize | Gets the minimum node size values |
GetObject | Returns the object currently being edited by this builder. |
SetBendPoints | Set bending points for polyline to render the connection. |
SetMinNodeSize | Sets the minimum node size values |
SetOwningSheet | Set the owning sheet when the sheet element is created. |
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¶
Discipline¶
-
ConnectionBuilder.
Discipline
¶ Returns or sets the discipline of this connection.
-------------------------------------
Getter Method
Signature
Discipline
Returns: Return type: str New in version NX10.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
Discipline
Parameters: discipline (str) – New in version NX10.0.0.
License requirements: None.
End¶
-
ConnectionBuilder.
End
¶ Returns or sets the end port of this connection.
-------------------------------------
Getter Method
Signature
End
Returns: Return type: NXOpen.Diagramming.Port
New in version NX10.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
End
Parameters: endPort ( NXOpen.Diagramming.Port
) –New in version NX10.0.0.
License requirements: None.
EndLocation¶
-
ConnectionBuilder.
EndLocation
¶ Returns the end location of this connection.
This end location is applicable only when the
Diagramming.ConnectionBuilder.End()
port is None.-------------------------------------
Getter Method
Signature
EndLocation
Returns: Return type: NXOpen.Diagramming.LocationBuilder
New in version NX10.0.0.
License requirements: None.
ReverseEnd¶
-
ConnectionBuilder.
ReverseEnd
¶ Returns the reversed flag of this connection.
-------------------------------------
Getter Method
Signature
ReverseEnd
Returns: Return type: bool New in version NX10.0.0.
License requirements: None.
Start¶
-
ConnectionBuilder.
Start
¶ Returns or sets the start port of this connection.
-------------------------------------
Getter Method
Signature
Start
Returns: Return type: NXOpen.Diagramming.Port
New in version NX10.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
Start
Parameters: startPort ( NXOpen.Diagramming.Port
) –New in version NX10.0.0.
License requirements: None.
StartLocation¶
-
ConnectionBuilder.
StartLocation
¶ Returns the start location of this connection.
This start location is applicable only when the
Diagramming.ConnectionBuilder.Start()
is None.-------------------------------------
Getter Method
Signature
StartLocation
Returns: Return type: NXOpen.Diagramming.LocationBuilder
New in version NX10.0.0.
License requirements: None.
Method Detail¶
GetBendPoints¶
-
ConnectionBuilder.
GetBendPoints
¶ Get bending points for polyline to render the connection.
Signature
GetBendPoints()
Returns: Return type: list of NXOpen.Point2d
New in version NX10.0.0.
License requirements: None.
SetBendPoints¶
-
ConnectionBuilder.
SetBendPoints
¶ Set bending points for polyline to render the connection.
Signature
SetBendPoints(points)
Parameters: points (list of NXOpen.Point2d
) –New in version NX10.0.0.
License requirements: None.
Validate¶
-
ConnectionBuilder.
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.