nxopen.pid

Interface PipeBuilder

All Superinterfaces:

Builder, IComponentBuilder, Remote, TaggedObject

public interface PipeBuilder
extends Builder

Represents a PipeBuilder.
To create a new instance of this class, use PidManager.createPipeBuilder(nxopen.Part, nxopen.pid.Pipe)

Created in NX11.0.1

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	PipeBuilder.EndTeeData This class holds the data returned from getEndTee()
static class	PipeBuilder.NewStartTeeConnectionData This class holds the data returned from getNewStartTeeConnection()
static class	PipeBuilder.StartData This class holds the data returned from getStart()
static class	PipeBuilder.StartTeeData This class holds the data returned from getStartTee()
static class	PipeBuilder.StartTeeLocationData This class holds the data returned from getStartTeeLocation()

Method Summary

Modifier and Type	Method and Description
String	elementId() Returns the current element ID of this pipe.
Point2d[]	getBendPoints() Get bending points for polyline to render the connection.
Connection	getConnection() Get the connection object of the connection builder.
PipeBuilder.StartData	getEnd() Gets the end port of this pipe.
Point2d	getEndLocation() Get the end location of this connection.
PipeBuilder.EndTeeData	getEndTee() Gets the end Tee.
PipeBuilder.StartTeeLocationData	getEndTeeLocation() Get the connection location for tee object at the end of the connection.
PipeBuilder.NewStartTeeConnectionData	getNewEndTeeConnection() Gets new connection after inserting the end Tee.
PipeBuilder.NewStartTeeConnectionData	getNewStartTeeConnection() Gets new connection after inserting the start Tee.
PipeBuilder.StartData	getStart() Gets the start port of this connection.
Point2d	getStartLocation() Get the start location of this connection.
PipeBuilder.StartTeeData	getStartTee() Gets the start Tee.
PipeBuilder.StartTeeLocationData	getStartTeeLocation() Get the connection location for tee object at the start of the connection.
String	id() Returns the id of the pipe.
Run	owningRun() Returns the owning run of the pipe.
Sheet	owningSheet() Returns the owning sheet of this pipe.
boolean	reverseEnd() Returns the reversed flag of this connection.
void	setBendPoints(Point2d[] points) Set bending points for polyline to render the connection.
void	setElementId(String elementId) License requirements: nx_pid_design_author ("NX P and ID Design Author") .
void	setEnd(Equipment equipment, String nodeSidId, String portId) Sets the end port of this pipe.
void	setEndLocation(Point2d endLocation) Set the end location of this connection.
void	setEndTeeLocation(Pipe pipe, String connectionId, int segementId, double percent) Set the connection location for tee object at the end of the connection.
void	setOwningRun(Run owningRun) License requirements: nx_pid_design_author ("NX P and ID Design Author") .
void	setOwningSheet(Sheet owningSheet) License requirements: nx_pid_design_author ("NX P and ID Design Author") .
void	setStart(Equipment equipment, String nodeSidId, String portId) Sets the start port of this connection.
void	setStartLocation(Point2d startLocation) Set the start location of this connection.
void	setStartTeeLocation(Pipe pipe, String connectionId, int segementId, double percent) Set the connection location for tee object at the start of the connection.
void	setStockPathId(String stockPathId) License requirements: nx_pid_design_author ("NX P and ID Design Author") .
String	stockPathId() Returns the stock path ID of the pipe.

Methods inherited from interface nxopen.Builder

commit, destroy, getCommittedObjects, getObject, showResults

Methods inherited from interface nxopen.TaggedObject

printTestData, printTestData, tag, tagValue

Methods inherited from interface nxopen.geometricutilities.IComponentBuilder

validate

Method Detail

id

String id()
   throws NXException,
          RemoteException

Returns the id of the pipe.
License requirements: nx_pid_design_reader ("NX P and ID Design Reader") OR nx_pid_design_author ("NX P and ID Design Author")

Created in NX11.0.1

Throws:

NXException

RemoteException

owningRun

Run owningRun()
       throws NXException,
              RemoteException

Returns the owning run of the pipe.
License requirements: nx_pid_design_reader ("NX P and ID Design Reader") OR nx_pid_design_author ("NX P and ID Design Author")

Created in NX11.0.1

Throws:

NXException

RemoteException

setOwningRun

void setOwningRun(Run owningRun)
           throws NXException,
                  RemoteException

License requirements: nx_pid_design_author ("NX P and ID Design Author")
.
Created in NX11.0.1

Parameters:

owningRun -

Throws:

NXException

RemoteException

stockPathId

String stockPathId()
            throws NXException,
                   RemoteException

Returns the stock path ID of the pipe.
License requirements: nx_pid_design_reader ("NX P and ID Design Reader") OR nx_pid_design_author ("NX P and ID Design Author")

Created in NX11.0.1

Throws:

NXException

RemoteException

setStockPathId

void setStockPathId(String stockPathId)
             throws NXException,
                    RemoteException

License requirements: nx_pid_design_author ("NX P and ID Design Author")
.
Created in NX11.0.1

Parameters:

stockPathId -

Throws:

NXException

RemoteException

owningSheet

Sheet owningSheet()
           throws NXException,
                  RemoteException

Returns the owning sheet of this pipe.
License requirements: nx_pid_design_reader ("NX P and ID Design Reader") OR nx_pid_design_author ("NX P and ID Design Author")

Created in NX11.0.1

Throws:

NXException

RemoteException

setOwningSheet

void setOwningSheet(Sheet owningSheet)
             throws NXException,
                    RemoteException

License requirements: nx_pid_design_author ("NX P and ID Design Author")
.
Created in NX11.0.1

Parameters:

owningSheet -

Throws:

NXException

RemoteException

getStartLocation

Point2d getStartLocation()
                  throws NXException,
                         RemoteException

Get the start location of this connection. This start location is applicable only when the ConnectionBuilder.start() is null.
License requirements: nx_pid_design_reader ("NX P and ID Design Reader") OR nx_pid_design_author ("NX P and ID Design Author")

Created in NX11.0.1

Throws:

NXException

RemoteException

setStartLocation

void setStartLocation(Point2d startLocation)
               throws NXException,
                      RemoteException

Set the start location of this connection. This start location is applicable only when the ConnectionBuilder.start() is null.
License requirements: nx_pid_design_author ("NX P and ID Design Author")

Created in NX11.0.1

Parameters:

startLocation -

Throws:

NXException

RemoteException

getEndLocation

Point2d getEndLocation()
                throws NXException,
                       RemoteException

Get the end location of this connection. This end location is applicable only when the ConnectionBuilder.end() port is null.
License requirements: nx_pid_design_reader ("NX P and ID Design Reader") OR nx_pid_design_author ("NX P and ID Design Author")

Created in NX11.0.1

Throws:

NXException

RemoteException

setEndLocation

void setEndLocation(Point2d endLocation)
             throws NXException,
                    RemoteException

Set the end location of this connection. This end location is applicable only when the ConnectionBuilder.end() port is null.
License requirements: nx_pid_design_author ("NX P and ID Design Author")

Created in NX11.0.1

Parameters:

endLocation -

Throws:

NXException

RemoteException

getStart

PipeBuilder.StartData getStart()
                        throws NXException,
                               RemoteException

Gets the start port of this connection.
License requirements: nx_pid_design_reader ("NX P and ID Design Reader") OR nx_pid_design_author ("NX P and ID Design Author")

Created in NX11.0.1

Throws:

NXException

RemoteException

setStart

void setStart(Equipment equipment,
              String nodeSidId,
              String portId)
       throws NXException,
              RemoteException

Sets the start port of this connection.
License requirements: nx_pid_design_author ("NX P and ID Design Author")

Created in NX11.0.1

Parameters:

equipment -

nodeSidId -

portId -

Throws:

NXException

RemoteException

getEnd

PipeBuilder.StartData getEnd()
                      throws NXException,
                             RemoteException

Gets the end port of this pipe.
License requirements: nx_pid_design_reader ("NX P and ID Design Reader") OR nx_pid_design_author ("NX P and ID Design Author")

Created in NX11.0.1

Throws:

NXException

RemoteException

setEnd

void setEnd(Equipment equipment,
            String nodeSidId,
            String portId)
     throws NXException,
            RemoteException

Sets the end port of this pipe.
License requirements: nx_pid_design_author ("NX P and ID Design Author")

Created in NX11.0.1

Parameters:

equipment -

nodeSidId -

portId -

Throws:

NXException

RemoteException

reverseEnd

boolean reverseEnd()
            throws NXException,
                   RemoteException

Returns the reversed flag of this connection.
License requirements: nx_pid_design_reader ("NX P and ID Design Reader") OR nx_pid_design_author ("NX P and ID Design Author")

Created in NX11.0.1

Throws:

NXException

RemoteException

getBendPoints

Point2d[] getBendPoints()
                 throws NXException,
                        RemoteException

Get bending points for polyline to render the connection.
License requirements: nx_pid_design_reader ("NX P and ID Design Reader") OR nx_pid_design_author ("NX P and ID Design Author")

Created in NX11.0.1

Throws:

NXException

RemoteException

setBendPoints

void setBendPoints(Point2d[] points)
            throws NXException,
                   RemoteException

Set bending points for polyline to render the connection.
License requirements: nx_pid_design_author ("NX P and ID Design Author")

Created in NX11.0.1

Parameters:

points -

Throws:

NXException

RemoteException

getStartTeeLocation

PipeBuilder.StartTeeLocationData getStartTeeLocation()
                                              throws NXException,
                                                     RemoteException

Get the connection location for tee object at the start of the connection.
License requirements: nx_pid_design_reader ("NX P and ID Design Reader") OR nx_pid_design_author ("NX P and ID Design Author")

Created in NX11.0.1

Throws:

NXException

RemoteException

setStartTeeLocation

void setStartTeeLocation(Pipe pipe,
                         String connectionId,
                         int segementId,
                         double percent)
                  throws NXException,
                         RemoteException

Set the connection location for tee object at the start of the connection.
License requirements: nx_pid_design_author ("NX P and ID Design Author")

Created in NX11.0.1

Parameters:

pipe -

connectionId -

segementId -

percent -

Throws:

NXException

RemoteException

getEndTeeLocation

PipeBuilder.StartTeeLocationData getEndTeeLocation()
                                            throws NXException,
                                                   RemoteException

Get the connection location for tee object at the end of the connection.
License requirements: nx_pid_design_reader ("NX P and ID Design Reader") OR nx_pid_design_author ("NX P and ID Design Author")

Created in NX11.0.1

Throws:

NXException

RemoteException

setEndTeeLocation

void setEndTeeLocation(Pipe pipe,
                       String connectionId,
                       int segementId,
                       double percent)
                throws NXException,
                       RemoteException

Set the connection location for tee object at the end of the connection.
License requirements: nx_pid_design_author ("NX P and ID Design Author")

Created in NX11.0.1

Parameters:

pipe -

connectionId -

segementId -

percent -

Throws:

NXException

RemoteException

elementId

String elementId()
          throws NXException,
                 RemoteException

Returns the current element ID of this pipe. It works only in edit mode, it's optional and the first element ID stored in the pipe will be used as default.
License requirements: nx_pid_design_reader ("NX P and ID Design Reader") OR nx_pid_design_author ("NX P and ID Design Author")

Created in NX11.0.1

Throws:

NXException

RemoteException

setElementId

void setElementId(String elementId)
           throws NXException,
                  RemoteException

License requirements: nx_pid_design_author ("NX P and ID Design Author")
.
Created in NX11.0.1

Parameters:

elementId -

Throws:

NXException

RemoteException

getNewStartTeeConnection

PipeBuilder.NewStartTeeConnectionData getNewStartTeeConnection()
                                                        throws NXException,
                                                               RemoteException

Gets new connection after inserting the start Tee.
License requirements: nx_pid_design_reader ("NX P and ID Design Reader") OR nx_pid_design_author ("NX P and ID Design Author")

Created in NX11.0.1

Throws:

NXException

RemoteException

getNewEndTeeConnection

PipeBuilder.NewStartTeeConnectionData getNewEndTeeConnection()
                                                      throws NXException,
                                                             RemoteException

Gets new connection after inserting the end Tee.
License requirements: nx_pid_design_reader ("NX P and ID Design Reader") OR nx_pid_design_author ("NX P and ID Design Author")

Created in NX11.0.1

Throws:

NXException

RemoteException

getConnection

Connection getConnection()
                  throws NXException,
                         RemoteException

Get the connection object of the connection builder.
License requirements: nx_pid_design_reader ("NX P and ID Design Reader") OR nx_pid_design_author ("NX P and ID Design Author")

Created in NX12.0.0

Throws:

NXException

RemoteException

getStartTee

PipeBuilder.StartTeeData getStartTee()
                              throws NXException,
                                     RemoteException

Gets the start Tee.
License requirements: nx_pid_design_reader ("NX P and ID Design Reader") OR nx_pid_design_author ("NX P and ID Design Author")

Created in NX12.0.0

Throws:

NXException

RemoteException

getEndTee

PipeBuilder.EndTeeData getEndTee()
                          throws NXException,
                                 RemoteException

Gets the end Tee.
License requirements: nx_pid_design_reader ("NX P and ID Design Reader") OR nx_pid_design_author ("NX P and ID Design Author")

Created in NX12.0.0

Throws:

NXException

RemoteException