The Routing PortConnection object is used by Routing to position ports while placing parts. More...

Inheritance diagram for NXOpen.Routing.PortConnection:

Public Types
enum	OverriddenValidity { None, Valid, Invalid }
	Overridden port connection validity More...

Public Types inherited from NXOpen.NXObject
enum	AttributeType { Invalid, Null, Boolean, Integer, Real, String, Time, Reference, Any = 100 }
	Specifies attribute type. More...

enum	DateAndTimeFormat { Numeric, Textual }
	Specifies the format of the date and time attribute. More...

Public Member Functions
unsafe bool	ArePortsAligned ()
	Returns whether the ports in the port connection are aligned correctly. More...

unsafe void	ForceValid (string reason)
	Force the connection to be valid regardless of the port alignment or the overridden value. More...

unsafe double	GetEngagement ()
	Returns the engagement distance between the two ports connected by a Port Connection object. More...

unsafe NXOpen.Routing.PortConnection.OverriddenValidity	GetOverriddenValidity ()
	Returns the overridden validity value of the port connection. More...

unsafe string	GetOverrideReason ()
	Gets the reason why a port connection's validity was overridden. More...

unsafe void	GetPorts (out NXOpen.Routing.Port port1, out NXOpen.Routing.Port port2)
	Returns the two ports connected by a Port Connection object. More...

unsafe bool	IsForcedValid ()
	Returns whether the connection is forced to be valid. More...

unsafe bool	IsValid ()
	Returns whether the connection is valid. More...

unsafe void	OverrideValidity (NXOpen.Routing.PortConnection.OverriddenValidity overriddenValidity)
	Overrides the validity of the port connection. More...

unsafe void	RemoveForcedValidity ()
	Removes the forced validity setting on the connection. More...

unsafe void	SetEngagement (double engagement)
	Sets the engagement distance between the two ports connected by a Port Connection object. More...

unsafe void	SetOverrideReason (string reason)
	Sets the reason why a port connection's validity was overridden. More...

unsafe void	SetPorts (NXOpen.Routing.Port port1, NXOpen.Routing.Port port2)
	Sets the link between the two ports connected by the Port Connection object. More...

Public Member Functions inherited from NXOpen.NXObject
unsafe NXOpen.AttributeIterator	CreateAttributeIterator ()
	Create an attribute iterator More...

unsafe void	DeleteAllAttributesByType (NXOpen.NXObject.AttributeType type)
	Deletes all attributes of a specific type. More...

unsafe void	DeleteAllAttributesByType (NXOpen.NXObject.AttributeType type, NXOpen.Update.Option option)
	Deletes all attributes of a specific type with the option to update or not. More...

unsafe void	DeleteAttributeByTypeAndTitle (NXOpen.NXObject.AttributeType type, string title)
	Deletes an attribute by type and title. More...

unsafe void	DeleteAttributeByTypeAndTitle (NXOpen.NXObject.AttributeType type, string title, NXOpen.Update.Option option)
	Deletes an attribute by type and title with the option to update or not. More...

unsafe void	DeleteUserAttribute (NXOpen.NXObject.AttributeType type, string title, bool deleteEntireArray, NXOpen.Update.Option option)
	Deletes the first attribute encountered with the given Type, Title. More...

unsafe void	DeleteUserAttributes (NXOpen.AttributeIterator iterator, NXOpen.Update.Option option)
	Deletes the attributes on the object, if any, that satisfy the given iterator More...

unsafe void	DeleteUserAttributes (NXOpen.NXObject.AttributeType type, NXOpen.Update.Option option)
	Deletes the attributes encountered with the given Type with option to update or not. More...

unsafe NXOpen.INXObject	FindObject (string journalIdentifier)
	Finds the NXOpen.NXObject with the given identifier as recorded in a journal. More...

unsafe NXOpen.NXObject.AttributeInformation[]	GetAttributeTitlesByType (NXOpen.NXObject.AttributeType type)
	Gets all the attribute titles of a specific type. More...

unsafe bool	GetBooleanUserAttribute (string title, int index)
	Gets a boolean attribute by Title and array Index. More...

unsafe NXOpen.NXObject.ComputationalTime	GetComputationalTimeUserAttribute (string title, int index)
	Gets a time attribute by Title and array Index. More...

unsafe int	GetIntegerAttribute (string title)
	Gets an integer attribute by title. More...

unsafe int	GetIntegerUserAttribute (string title, int index)
	Gets an integer attribute by Title and array Index. More...

unsafe bool	GetNextUserAttribute (NXOpen.AttributeIterator iterator, out NXOpen.NXObject.AttributeInformation info)
	Gets the next attribute encountered on the object, if any, that satisfies the given iterator. More...

unsafe string	GetPdmReferenceAttributeValue (string attributeTitle)
	Gets the value of PDM Reference attribute for given object. More...

unsafe double	GetRealAttribute (string title)
	Gets a real attribute by title. More...

unsafe double	GetRealUserAttribute (string title, int index)
	Gets a real attribute by Title and array Index. More...

unsafe string	GetReferenceAttribute (string title)
	Gets the reference string (not the calculated value) of a string attribute that uses a reference string. More...

unsafe string	GetStringAttribute (string title)
	Gets a string attribute value by title. More...

unsafe string	GetStringUserAttribute (string title, int index)
	Gets a string attribute by Title and array Index. More...

unsafe string	GetTimeAttribute (NXOpen.NXObject.DateAndTimeFormat format, string title)
	Gets a time attribute by title. More...

unsafe string	GetTimeUserAttribute (string title, int index)
	Gets a time attribute by Title and array Index. More...

unsafe NXOpen.NXObject.AttributeInformation	GetUserAttribute (string title, NXOpen.NXObject.AttributeType type, int index)
	Gets the first attribute encountered on the object, if any, with a given Title, Type and array Index. More...

unsafe NXOpen.NXObject.AttributeInformation[]	GetUserAttribute (string title, bool includeUnset, bool addStringValues, NXOpen.NXObject.AttributeType type)
	Gets the first attribute (or attribute array) encountered on the object, if any, with a given Title and Type. More...

unsafe string	GetUserAttributeAsString (string title, NXOpen.NXObject.AttributeType type, int index)
	Gets the first attribute encountered on the object, if any, with a given title, type and array index. More...

unsafe int	GetUserAttributeCount (NXOpen.AttributeIterator iterator)
	Gets the count of set attributes on the object, if any, that satisfy the given iterator. More...

unsafe int	GetUserAttributeCount (NXOpen.AttributeIterator iterator, bool countArrayAsOneAttribute)
	Gets the count of set attributes on the object, if any, that satisfy the given iterator. More...

unsafe int	GetUserAttributeCount (NXOpen.NXObject.AttributeType type)
	Gets the count of set attributes on the object, if any, of the given type. More...

unsafe int	GetUserAttributeCount (NXOpen.NXObject.AttributeType type, bool includeUnset, bool countArrayAsOneAttribute)
	Gets the count of attributes on the object, if any, of the given type. More...

unsafe bool	GetUserAttributeLock (string title, NXOpen.NXObject.AttributeType type)
	Determine the lock of the given attribute. More...

unsafe NXOpen.NXObject.AttributeInformation[]	GetUserAttributes (NXOpen.AttributeIterator iterator)
	Gets all the attributes that have been set on the given object, if any, that satisfy the given iterator. More...

unsafe NXOpen.NXObject.AttributeInformation[]	GetUserAttributes ()
	Gets all the attributes that have been set on the given object. More...

unsafe NXOpen.NXObject.AttributeInformation[]	GetUserAttributes (bool includeUnset)
	Gets all the attributes of the given object. More...

unsafe NXOpen.NXObject.AttributeInformation[]	GetUserAttributes (bool includeUnset, bool addStringValues)
	Gets all the attributes of the given object. More...

unsafe string[]	GetUserAttributesAsStrings ()
	Gets all the attributes that have been set on the given object. More...

unsafe int	GetUserAttributeSize (string title, NXOpen.NXObject.AttributeType type)
	Gets the size of the first attribute encountered on the object, if any, with a given Title and Type. More...

unsafe NXOpen.NXObject[]	GetUserAttributeSourceObjects ()
	Returns an array of objects from which this object presents attributes. More...

unsafe bool	HasUserAttribute (NXOpen.AttributeIterator iterator)
	Determines if an attribute exists on the object, that satisfies the given iterator More...

unsafe bool	HasUserAttribute (string title, NXOpen.NXObject.AttributeType type, int index)
	Determines if an attribute with the given Title, Type and array Index is present on the object Unset attributes will not be detected by this function, as its purpose is to test for the actual presence of the attribute on the object. More...

unsafe void	Print ()
	Prints a representation of this object to the system log file. More...

unsafe void	SetAttribute (string title, int value)
	Creates or modifies an integer attribute. More...

unsafe void	SetAttribute (string title, int value, NXOpen.Update.Option option)
	Creates or modifies an integer attribute with the option to update or not. More...

unsafe void	SetAttribute (string title, double value)
	Creates or modifies a real attribute. More...

unsafe void	SetAttribute (string title, double value, NXOpen.Update.Option option)
	Creates or modifies a real attribute with the option to update or not. More...

unsafe void	SetAttribute (string title, string value)
	Creates or modifies a string attribute. More...

unsafe void	SetAttribute (string title, string value, NXOpen.Update.Option option)
	Creates or modifies a string attribute with the option to update or not. More...

unsafe void	SetAttribute (string title)
	Creates or modifies a null attribute which is an attribute with a title and no value. More...

unsafe void	SetAttribute (string title, NXOpen.Update.Option option)
	Creates or modifies a null attribute with the option to update or not. More...

unsafe void	SetBooleanUserAttribute (string title, int index, bool value, NXOpen.Update.Option option)
	Creates or modifies a boolean attribute with the option to update or not. More...

unsafe void	SetName (string name)
	Sets the custom name of the object. More...

unsafe void	SetPdmReferenceAttribute (string attributeTitle, string attributeValue)
	Sets the value of PDM Reference attribute on the object. More...

unsafe void	SetReferenceAttribute (string title, string value)
	Creates or modifies a string attribute which uses a reference string. More...

unsafe void	SetReferenceAttribute (string title, string value, NXOpen.Update.Option option)
	Creates or modifies a string attribute which uses a reference string, with the option to update or not. More...

unsafe void	SetTimeAttribute (string title, string value)
	Creates or modifies a time attribute. More...

unsafe void	SetTimeAttribute (string title, string value, NXOpen.Update.Option option)
	Creates or modifies a time attribute with the option to update or not. More...

unsafe void	SetTimeUserAttribute (string title, int index, string value, NXOpen.Update.Option option)
	Creates or modifies a time attribute with the option to update or not. More...

unsafe void	SetTimeUserAttribute (string title, int index, NXOpen.NXObject.ComputationalTime value, NXOpen.Update.Option option)
	Creates or modifies a time attribute with the option to update or not. More...

unsafe void	SetUserAttribute (NXOpen.NXObject.AttributeInformation info, NXOpen.Update.Option option)
	Creates or modifies an attribute with the option to update or not. More...

unsafe void	SetUserAttribute (string title, int index, int value, NXOpen.Update.Option option)
	Creates or modifies an integer attribute with the option to update or not. More...

unsafe void	SetUserAttribute (string title, int index, double value, NXOpen.Update.Option option)
	Creates or modifies a real attribute with the option to update or not. More...

unsafe void	SetUserAttribute (string title, int index, string value, NXOpen.Update.Option option)
	Creates or modifies a string attribute with the option to update or not. More...

unsafe void	SetUserAttribute (string title, int index, NXOpen.Update.Option option)
	Creates or modifies a null attribute with the option to update or not. More...

unsafe void	SetUserAttributeLock (string title, NXOpen.NXObject.AttributeType type, bool @lock)
	Lock or unlock the given attribute. More...

Public Member Functions inherited from NXOpen.TaggedObject
void	PrintTestData (String variableName)
	<exclude> More...

void	PrintTestData (String variableName, int lineNumber)
	<exclude> More...

override string	ToString ()
	Returns a String that represents the current Object. More...

Public Member Functions inherited from NXOpen.Utilities.NXRemotableObject
IMessageCtrl	AsyncProcessMessage (IMessage msg, IMessageSink replySink)
	Asynchronously processes the given message. More...

IMessage	SyncProcessMessage (IMessage msg)
	Synchronously processes the given message. More...

Additional Inherited Members
Protected Member Functions inherited from NXOpen.TaggedObject
new void	initialize ()
	<exclude> More...

Properties inherited from NXOpen.NXObject
unsafe bool	IsOccurrence `[get]`
	Returns whether this object is an occurrence or not. More...

unsafe string	JournalIdentifier `[get]`
	Returns the identifier that would be recorded in a journal for this object. More...

unsafe string	Name `[get]`
	Returns the custom name of the object. More...

unsafe NXOpen.Assemblies.Component	OwningComponent `[get]`
	Returns the owning component, if this object is an occurrence. More...

unsafe NXOpen.BasePart	OwningPart `[get]`
	Returns the owning part of this object More...

unsafe NXOpen.INXObject	Prototype `[get]`
	Returns the prototype of this object if it is an occurrence. More...

Detailed Description

The Routing PortConnection object is used by Routing to position ports while placing parts.

To create a new instance of this class, use NXOpen.Routing.PortConnectionCollection.CreatePortConnection

Created in NX4.0.0

Member Enumeration Documentation

enum NXOpen.Routing.PortConnection.OverriddenValidity

Overridden port connection validity

Enumerator
None	The port connection validity has not been overridden
Valid	The port connection validity has been overridden to be valid
Invalid	The port connection validity has been overridden to be invalid

Member Function Documentation

unsafe bool NXOpen.Routing.PortConnection.ArePortsAligned ( )

inline

Returns whether the ports in the port connection are aligned correctly.

Both direction and rotation are evaluated.

Created in NX8.0.0

License requirements: routing_base ("Routing Basic")

Returns: validity of the current connection.

unsafe void NXOpen.Routing.PortConnection.ForceValid ( string reason )

inline

Force the connection to be valid regardless of the port alignment or the overridden value.

The user's login name and the date and time are recorded automatically along with the given reason.

Created in NX8.0.0

License requirements: routing_base ("Routing Basic")

Parameters

reason The reason why this connection was forced to be valid.

unsafe double NXOpen.Routing.PortConnection.GetEngagement ( )

inline

Returns the engagement distance between the two ports connected by a Port Connection object.

Created in NX4.0.0

License requirements: routing_base ("Routing Basic")

Returns: engagement distance between the ports connected by the Port Connection object

unsafe NXOpen.Routing.PortConnection.OverriddenValidity NXOpen.Routing.PortConnection.GetOverriddenValidity ( )

inline

Returns the overridden validity value of the port connection.

Created in NX8.0.0

License requirements: routing_base ("Routing Basic")

Returns: overridden validity value.

unsafe string NXOpen.Routing.PortConnection.GetOverrideReason ( )

inline

Gets the reason why a port connection's validity was overridden.

Created in NX8.0.0

License requirements: routing_base ("Routing Basic")

Returns: The reason why this connection's validity was overridden.

unsafe void NXOpen.Routing.PortConnection.GetPorts	(	out NXOpen.Routing.Port	port1,
		out NXOpen.Routing.Port	port2
	)

inline

Returns the two ports connected by a Port Connection object.

Created in NX4.0.0

License requirements: routing_base ("Routing Basic")

Parameters

port1	first Port connected by the Port Connection object
port2	second Port connected by the Port Connection object

unsafe bool NXOpen.Routing.PortConnection.IsForcedValid ( )

inline

Returns whether the connection is forced to be valid.

Created in NX8.0.0

License requirements: routing_base ("Routing Basic")

Returns: validity of the current connection.

unsafe bool NXOpen.Routing.PortConnection.IsValid ( )

inline

Returns whether the connection is valid.

Validity is initially determined by the alignment of the ports but can be overridden by OverrideValidity or ForceValid

Created in NX8.0.0

License requirements: routing_base ("Routing Basic")

Returns: validity of the current connection.

unsafe void NXOpen.Routing.PortConnection.OverrideValidity ( NXOpen.Routing.PortConnection.OverriddenValidity overriddenValidity )

inline

Overrides the validity of the port connection.

By default, the validity is determined by evaluating the alignment of the connected ports.

Created in NX8.0.0

License requirements: routing_base ("Routing Basic")

Parameters

overriddenValidity overridden validity value.

unsafe void NXOpen.Routing.PortConnection.RemoveForcedValidity ( )

inline

Removes the forced validity setting on the connection.

Validity will now be determined based on the alignment or on the overridden validity setting.

Created in NX8.0.0

License requirements: routing_base ("Routing Basic")

unsafe void NXOpen.Routing.PortConnection.SetEngagement ( double engagement )

inline

Sets the engagement distance between the two ports connected by a Port Connection object.

Created in NX4.0.0

License requirements: routing_base ("Routing Basic")

Parameters

engagement engagement distance to be set between the ports connected by the Port Connection object

unsafe void NXOpen.Routing.PortConnection.SetOverrideReason ( string reason )

inline

Sets the reason why a port connection's validity was overridden.

Created in NX8.0.0

License requirements: routing_base ("Routing Basic")

Parameters

reason The reason why this connection's validity was overridden.

unsafe void NXOpen.Routing.PortConnection.SetPorts	(	NXOpen.Routing.Port	port1,
		NXOpen.Routing.Port	port2
	)

inline

Sets the link between the two ports connected by the Port Connection object.

Created in NX4.0.0

License requirements: routing_base ("Routing Basic")

Parameters

port1	first port to be connected by the Port Connection object
port2	second port to be connected by the Port Connection object

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

Routing_PortConnection.cs

Public Types

Public Member Functions

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

Member Function Documentation