NXOpen::Routing::Electrical::PathConnection Class Reference

Describes a connection that has a path. More...

Inheritance diagram for NXOpen::Routing::Electrical::PathConnection:

Additional Inherited Members
Public Types inherited from NXOpen::Routing::Electrical::Connection
enum	RouteLevel { RouteLevelNotRouted, RouteLevelPin, RouteLevelComponent, RouteLevelMixed }
	Routing level. More...
Public Member Functions inherited from NXOpen::Routing::Electrical::Connection
bool	AddIntermediateTerminal (NXOpen::Routing::LogicalTerminal *intermediateTerminal)
	Add an intermediate terminal to this connection.
void	AssignPath (NXOpen::Routing::Electrical::Connection::RouteLevel routeLevel, NXOpen::Routing::Path *path)
	Assigns the given path to this connection and routes the connection on the path using the given routing level.
void	AutomaticallyRoute (NXOpen::Routing::Electrical::Connection::RouteLevel routeLevel)
	Automatically routes this connection on the shortest path using the given routing level.
NXOpen::Routing::Electrical::ConnectorDevice *	FindFromConnector ()
	Get the From Connector for this connection.
NXOpen::Routing::Electrical::CableDevice *	FindNearestCableDevice ()
	Query this connection to find the nearest harness.
NXOpen::Routing::Electrical::HarnessDevice *	FindNearestHarnessDevice ()
	Query this connection to find the nearest harness.
NXOpen::Routing::SingleDevice *	FindNearestParentDevice ()
	Queries this connection for the nearest parent device.
std::vector < NXOpen::Routing::Path * >	FindPaths (NXOpen::Routing::Electrical::Connection::RouteLevel routeLevel)
	Returns all the possible paths this connection can use.
NXOpen::Routing::Electrical::ConnectorDevice *	FindToConnector ()
	Get the To Connector for this connection.
NXOpen::Routing::LogicalTerminal *	FromTerminal ()
	Returns the From terminal.
std::vector < NXOpen::Routing::LogicalTerminal * >	GetIntermediateTerminals ()
	Get the intermediate terminals associated with this connection.
NXString	GetRoutedLevel ()
	Gets the level used to route this connection.
NXOpen::Routing::Electrical::Connection::RouteLevel	GetRoutedLevelEnum ()
	Similar to Routing::Electrical::Connection::GetRoutedLevel , but returns the Routing::Electrical::Connection::RouteLevel enumeration instead of a string.
NXString	GetRoutingMethod ()
	Gets the method used to route this connection.
bool	IsRouted ()
	Is this connection routed?
double	MaximumPathLength ()
	Returns the maximum path length for this connection.
double	MinimumPathLength ()
	Returns the minimum path length for this connection.
NXString	PathLengthMultiplier ()
	Returns the path length multiplier.
NXString	PathLengthOffset ()
	Returns the path length offset.
bool	RemoveIntermediateTerminal (NXOpen::Routing::LogicalTerminal *intermediateTerminal)
	Remove an intermediate terminal from this connection.
void	ReplaceIntermediateTerminals (const std::vector< NXOpen::Routing::LogicalTerminal * > &intermediateTerminals)
	Replaces the intermediate terminals associated with this connection.
void	SetFromTerminal (NXOpen::Routing::LogicalTerminal *fromTerminal)
	Sets the From terminal.
void	SetMaximumPathLength (double pathLength)
	Sets the maximum path length for this connection.
void	SetMinimumPathLength (double pathLength)
	Sets the minimum path length for this connection.
void	SetPathLengthMultiplier (const NXString &pathLengthMultiplier)
	Sets the path length multiplier.
void	SetPathLengthMultiplier (const char *pathLengthMultiplier)
	Sets the path length multiplier.
void	SetPathLengthOffset (const NXString &pathLengthOffset)
	Sets the path length offset.
void	SetPathLengthOffset (const char *pathLengthOffset)
	Sets the path length offset.
void	SetToTerminal (NXOpen::Routing::LogicalTerminal *toTerminal)
	Sets the To terminal.
NXOpen::Routing::LogicalTerminal *	ToTerminal ()
	Returns the To terminal.
void	Unroute ()
	Unroutes this connection.

Detailed Description

Describes a connection that has a path.

        <br> 
       From and To terminals are not coincident and need a path definition to be routable.            
       See NX Open Routing help for detailed information on the Connection data model.
        <br> 
    <br> To create a new instance of this class, use @link Routing::Electrical::PathConnectionCollection::CreatePathConnection  Routing::Electrical::PathConnectionCollection::CreatePathConnection @endlink  <br> 

Created in NX4.0.2.

---

The documentation for this class was generated from the following file:

• Routing_Electrical_PathConnection.hxx