NX Open C++ Reference Guide
Public Member Functions
NXOpen::Routing::TerminalPort Class Reference

A Routing::TerminalPort models the pins on an electrical connector. More...

Inheritance diagram for NXOpen::Routing::TerminalPort:
NXOpen::Routing::Port NXOpen::Routing::IAxisPort NXOpen::SmartObject NXOpen::Routing::IRoutePosition NXOpen::Routing::IRoutePosition NXOpen::DisplayableObject NXOpen::Routing::ICharacteristic NXOpen::Routing::ICharacteristic NXOpen::NXObject NXOpen::IFitTo NXOpen::INXObject NXOpen::INXObject NXOpen::TaggedObject NXOpen::INXObject NXOpen::INXObject

List of all members.

Public Member Functions

virtual NXOpen::AxisAxis ()
 Returns the axis that defines the port
Created in NX5.0.0.
virtual NXOpen::ExpressionCutbackLengthObject ()
 Returns the cutback length object of a port, i.e.
virtual NXOpen::ExpressionEngagementObject ()
 Returns the engagement object of a port, i.e.
virtual NXOpen::ExpressionForwardExtensionObject ()
 Returns the forward extension object of a port, i.e.
NXOpen::Routing::MultiPortMultiPort ()
 Returns the parent Routing::MultiPort of the Routing::TerminalPort.
NXString PinIdentifier ()
 Returns the pin identifier (name) of the Routing::TerminalPort
Created in NX4.0.0.
virtual void SetAlignVector (const NXOpen::Vector3d &vector)
 Sets the align vector of Port
Created in NX4.0.0.
virtual void SetAxis (NXOpen::Axis *axis)
 Sets the axis that defines the port
Created in NX5.0.0.
virtual void SetCutbackLength (double cutbackLength)
 Sets the cutback length of a port, i.e.
virtual void SetCutbackLengthObject (NXOpen::Expression *cutbackLength)
 Sets the cutback length object of a port, i.e.
virtual void SetEngagement (double engagement)
 The engagment distance of a IAxisPort , i.e.
virtual void SetEngagementObject (NXOpen::Expression *engagement)
 Sets the engagement object of a port, i.e.
virtual void SetForwardExtension (double forwardExtension)
 Sets the forward extension value of a port, i.e.
virtual void SetForwardExtensionObject (NXOpen::Expression *forwardExtension)
 Sets the forward extension object of a port, i.e.
void SetPinIdentifier (const NXString &pinIdentifier)
 Sets the pin identifier (name) of the Routing::TerminalPort
Created in NX4.0.0.
virtual void SetRotationObject (NXOpen::DisplayableObject *rotationObject)
 Sets the object used to derive the rotation vector of Port
Created in NX4.0.0.
virtual void SetRotationVector (const NXOpen::Vector3d &vector)
 Sets the rotation vector of Port
Created in NX4.0.0.

Detailed Description

A Routing::TerminalPort models the pins on an electrical connector.

Routing::TerminalPort s are a Routing::MultiPort 's children.


Created in NX4.0.0.


Member Function Documentation

Returns the axis that defines the port
Created in NX5.0.0.



License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Implements NXOpen::Routing::IAxisPort.

Returns the cutback length object of a port, i.e.

an expression representing the length along the wire from the port where individual wires leave a bundle to attach to pins


Created in NX4.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Implements NXOpen::Routing::IAxisPort.

Returns the engagement object of a port, i.e.

an expression representing the distance behind the port that another fitting or stock may engage


Created in NX4.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Implements NXOpen::Routing::IAxisPort.

Returns the forward extension object of a port, i.e.

an expression representing the minimum length that a segment must remain straight coming out of a Port


Created in NX4.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Implements NXOpen::Routing::IAxisPort.

Returns the parent Routing::MultiPort of the Routing::TerminalPort.


Created in NX4.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Returns the pin identifier (name) of the Routing::TerminalPort
Created in NX4.0.0.



License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

virtual void NXOpen::Routing::TerminalPort::SetAlignVector ( const NXOpen::Vector3d vector) [virtual]

Sets the align vector of Port
Created in NX4.0.0.



License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Parameters:
vectorVector direction in absolute co-ordinate system

Implements NXOpen::Routing::IAxisPort.

virtual void NXOpen::Routing::TerminalPort::SetAxis ( NXOpen::Axis axis) [virtual]

Sets the axis that defines the port
Created in NX5.0.0.



License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Parameters:
axisaxis

Implements NXOpen::Routing::IAxisPort.

virtual void NXOpen::Routing::TerminalPort::SetCutbackLength ( double  cutbackLength) [virtual]

Sets the cutback length of a port, i.e.

the length along the wire from the port where individual wires leave a bundle to attach to pins


Created in NX4.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Parameters:
cutbackLengthCutback Length

Implements NXOpen::Routing::IAxisPort.

Sets the cutback length object of a port, i.e.

an expression representing the length along the wire from the port where individual wires leave a bundle to attach to pins


Created in NX4.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Parameters:
cutbackLengthCutback Length Expression

Implements NXOpen::Routing::IAxisPort.

virtual void NXOpen::Routing::TerminalPort::SetEngagement ( double  engagement) [virtual]

The engagment distance of a IAxisPort , i.e.

the distance behind the port that another fitting or stock may engage


Created in NX4.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Parameters:
engagementEngagement distance

Implements NXOpen::Routing::IAxisPort.

Sets the engagement object of a port, i.e.

an expression representing the distance behind the port that another fitting or stock may engage


Created in NX4.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Parameters:
engagementEngagement Expression

Implements NXOpen::Routing::IAxisPort.

virtual void NXOpen::Routing::TerminalPort::SetForwardExtension ( double  forwardExtension) [virtual]

Sets the forward extension value of a port, i.e.

the minimum length that a segment must remain straight coming out of a Port


Created in NX4.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Parameters:
forwardExtensionPort extension

Implements NXOpen::Routing::IAxisPort.

virtual void NXOpen::Routing::TerminalPort::SetForwardExtensionObject ( NXOpen::Expression forwardExtension) [virtual]

Sets the forward extension object of a port, i.e.

an expression representing the minimum length that a segment must remain straight coming out of a Port


Created in NX4.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Parameters:
forwardExtensionForward Extension Expression

Implements NXOpen::Routing::IAxisPort.

Sets the pin identifier (name) of the Routing::TerminalPort
Created in NX4.0.0.



License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Parameters:
pinIdentifierpin identifier

Sets the object used to derive the rotation vector of Port
Created in NX4.0.0.



License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Parameters:
rotationObjectObject used to derive the rotation vector

Implements NXOpen::Routing::IAxisPort.

virtual void NXOpen::Routing::TerminalPort::SetRotationVector ( const NXOpen::Vector3d vector) [virtual]

Sets the rotation vector of Port
Created in NX4.0.0.



License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Parameters:
vectorVector direction in absolute co-ordinate system

Implements NXOpen::Routing::IAxisPort.


The documentation for this class was generated from the following file:
Copyright 2011 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.