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 { OverriddenValidityNone, OverriddenValidityValid, OverriddenValidityInvalid }
	Overridden port connection validity. More...

Public Types inherited from NXOpen::NXObject
enum	AttributeType { AttributeTypeInvalid, AttributeTypeNull, AttributeTypeBoolean, AttributeTypeInteger, AttributeTypeReal, AttributeTypeString, AttributeTypeTime, AttributeTypeReference, AttributeTypeAny = 100 }
	Specifies attribute type. More...

enum	DateAndTimeFormat { DateAndTimeFormatNumeric, DateAndTimeFormatTextual }
	Specifies the format of the date and time attribute. More...

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

void	ForceValid (const NXString &reason)
	Force the connection to be valid regardless of the port alignment or the overridden value.

void	ForceValid (const char *reason)
	Force the connection to be valid regardless of the port alignment or the overridden value.

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

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

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

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

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

bool	IsValid ()
	Returns whether the connection is valid.

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

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

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

void	SetOverrideReason (const NXString &reason)
	Sets the reason why a port connection's validity was overridden.

void	SetOverrideReason (const char *reason)
	Sets the reason why a port connection's validity was overridden.

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

Public Member Functions inherited from NXOpen::NXObject
void	DeleteAllAttributesByType (NXOpen::NXObject::AttributeType type)
	Deletes all attributes of a specific type.

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

void	DeleteAttributeByTypeAndTitle (NXOpen::NXObject::AttributeType type, const NXString &title)
	Deletes an attribute by type and title.

void	DeleteAttributeByTypeAndTitle (NXOpen::NXObject::AttributeType type, const char *title)
	Deletes an attribute by type and title.

void	DeleteAttributeByTypeAndTitle (NXOpen::NXObject::AttributeType type, const NXString &title, NXOpen::Update::Option option)
	Deletes an attribute by type and title with the option to update or not.

void	DeleteAttributeByTypeAndTitle (NXOpen::NXObject::AttributeType type, const char *title, NXOpen::Update::Option option)
	Deletes an attribute by type and title with the option to update or not.

void	DeleteUserAttribute (NXOpen::NXObject::AttributeType type, const NXString &title, bool deleteEntireArray, NXOpen::Update::Option option)
	Deletes the first attribute encountered with the given Type, Title and Index.

void	DeleteUserAttribute (NXOpen::NXObject::AttributeType type, const char *title, bool deleteEntireArray, NXOpen::Update::Option option)
	Deletes the first attribute encountered with the given Type, Title and Index.

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

virtual NXOpen::INXObject *	FindObject (const NXString &journalIdentifier)
	Finds the NXObject with the given identifier as recorded in a journal.

NXOpen::INXObject *	FindObject (const char *journalIdentifier)
	Finds the NXObject with the given identifier as recorded in a journal.

std::vector < NXOpen::NXObject::AttributeInformation >	GetAttributeTitlesByType (NXOpen::NXObject::AttributeType type)
	Gets all the attribute titles of a specific type.

bool	GetBooleanUserAttribute (const NXString &title, int index)
	Gets a boolean attribute by Title and array Index.

bool	GetBooleanUserAttribute (const char *title, int index)
	Gets a boolean attribute by Title and array Index.

NXOpen::NXObject::ComputationalTime	GetComputationalTimeUserAttribute (const NXString &title, int index)
	Gets a time attribute by Title and array Index.

NXOpen::NXObject::ComputationalTime	GetComputationalTimeUserAttribute (const char *title, int index)
	Gets a time attribute by Title and array Index.

int	GetIntegerAttribute (const NXString &title)
	Gets an integer attribute by title.

int	GetIntegerAttribute (const char *title)
	Gets an integer attribute by title.

int	GetIntegerUserAttribute (const NXString &title, int index)
	Gets an integer attribute by Title and array Index.

int	GetIntegerUserAttribute (const char *title, int index)
	Gets an integer attribute by Title and array Index.

double	GetRealAttribute (const NXString &title)
	Gets a real attribute by title.

double	GetRealAttribute (const char *title)
	Gets a real attribute by title.

double	GetRealUserAttribute (const NXString &title, int index)
	Gets a real attribute by Title and array Index.

double	GetRealUserAttribute (const char *title, int index)
	Gets a real attribute by Title and array Index.

NXString	GetReferenceAttribute (const NXString &title)
	Gets the reference string (not the calculated value) of a string attribute that uses a reference string.

NXString	GetReferenceAttribute (const char *title)
	Gets the reference string (not the calculated value) of a string attribute that uses a reference string.

NXString	GetStringAttribute (const NXString &title)
	Gets a string attribute value by title.

NXString	GetStringAttribute (const char *title)
	Gets a string attribute value by title.

NXString	GetStringUserAttribute (const NXString &title, int index)
	Gets a string attribute by Title and array Index.

NXString	GetStringUserAttribute (const char *title, int index)
	Gets a string attribute by Title and array Index.

NXString	GetTimeAttribute (NXOpen::NXObject::DateAndTimeFormat format, const NXString &title)
	Gets a time attribute by title.

NXString	GetTimeAttribute (NXOpen::NXObject::DateAndTimeFormat format, const char *title)
	Gets a time attribute by title.

NXString	GetTimeUserAttribute (const NXString &title, int index)
	Gets a time attribute by Title and array Index.

NXString	GetTimeUserAttribute (const char *title, int index)
	Gets a time attribute by Title and array Index.

NXOpen::NXObject::AttributeInformation	GetUserAttribute (const NXString &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.

NXOpen::NXObject::AttributeInformation	GetUserAttribute (const char *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.

NXString	GetUserAttributeAsString (const NXString &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.

NXString	GetUserAttributeAsString (const char *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.

bool	GetUserAttributeLock (const NXString &title, NXOpen::NXObject::AttributeType type)
	Determine the lock of the given attribute.

bool	GetUserAttributeLock (const char *title, NXOpen::NXObject::AttributeType type)
	Determine the lock of the given attribute.

std::vector < NXOpen::NXObject::AttributeInformation >	GetUserAttributes ()
	Gets all the attributes that have been set on the given object.

std::vector < NXOpen::NXObject::AttributeInformation >	GetUserAttributes (bool includeUnset)
	Gets all the attributes that have been set on the given object.

std::vector < NXOpen::NXObject::AttributeInformation >	GetUserAttributes (bool includeUnset, bool addStringValues)
	Gets all the attributes that have been set on the given object.

std::vector< NXString >	GetUserAttributesAsStrings ()
	Gets all the attributes that have been set on the given object.

std::vector< NXOpen::NXObject * >	GetUserAttributeSourceObjects ()
	Returns an array of objects from which this object presents attributes.

bool	HasUserAttribute (const NXString &title, NXOpen::NXObject::AttributeType type, int index)
	Determines if an attribute with the given Title, Type and array Index is present on the object If the attribute is not an array, the Index is ignored (if this is known beforehand, we recommend setting the Index to -1 to save time).

bool	HasUserAttribute (const char *title, NXOpen::NXObject::AttributeType type, int index)
	Determines if an attribute with the given Title, Type and array Index is present on the object If the attribute is not an array, the Index is ignored (if this is known beforehand, we recommend setting the Index to -1 to save time).

virtual bool	IsOccurrence ()
	Returns whether this object is an occurrence or not.

virtual NXString	JournalIdentifier ()
	Returns the identifier that would be recorded in a journal for this object.

virtual NXString	Name ()
	Returns the custom name of the object.

virtual NXOpen::Assemblies::Component *	OwningComponent ()
	Returns the owning component, if this object is an occurrence.

virtual NXOpen::BasePart *	OwningPart ()
	Returns the owning part of this object Created in NX3.0.0.

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

virtual NXOpen::INXObject *	Prototype ()
	Returns the prototype of this object if it is an occurrence.

void	SetAttribute (const NXString &title, int value)
	Creates or modifies an integer attribute.

void	SetAttribute (const char *title, int value)
	Creates or modifies an integer attribute.

void	SetAttribute (const NXString &title, int value, NXOpen::Update::Option option)
	Creates or modifies an integer attribute with the option to update or not.

void	SetAttribute (const char *title, int value, NXOpen::Update::Option option)
	Creates or modifies an integer attribute with the option to update or not.

void	SetAttribute (const NXString &title, double value)
	Creates or modifies a real attribute.

void	SetAttribute (const char *title, double value)
	Creates or modifies a real attribute.

void	SetAttribute (const NXString &title, double value, NXOpen::Update::Option option)
	Creates or modifies a real attribute with the option to update or not.

void	SetAttribute (const char *title, double value, NXOpen::Update::Option option)
	Creates or modifies a real attribute with the option to update or not.

void	SetAttribute (const NXString &title, const NXString &value)
	Creates or modifies a string attribute.

void	SetAttribute (const char title, const char value)
	Creates or modifies a string attribute.

void	SetAttribute (const NXString &title, const NXString &value, NXOpen::Update::Option option)
	Creates or modifies a string attribute with the option to update or not.

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

void	SetAttribute (const NXString &title)
	Creates or modifies a null attribute which is an attribute with a title and no value.

void	SetAttribute (const char *title)
	Creates or modifies a null attribute which is an attribute with a title and no value.

void	SetAttribute (const NXString &title, NXOpen::Update::Option option)
	Creates or modifies a null attribute with the option to update or not.

void	SetAttribute (const char *title, NXOpen::Update::Option option)
	Creates or modifies a null attribute with the option to update or not.

void	SetBooleanUserAttribute (const NXString &title, int index, bool value, NXOpen::Update::Option option)
	Creates or modifies a boolean attribute with the option to update or not.

void	SetBooleanUserAttribute (const char *title, int index, bool value, NXOpen::Update::Option option)
	Creates or modifies a boolean attribute with the option to update or not.

virtual void	SetName (const NXString &name)
	Sets the custom name of the object.

void	SetName (const char *name)
	Sets the custom name of the object.

void	SetReferenceAttribute (const NXString &title, const NXString &value)
	Creates or modifies a string attribute which uses a reference string.

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

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

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

void	SetTimeAttribute (const NXString &title, const NXString &value)
	Creates or modifies a time attribute.

void	SetTimeAttribute (const char title, const char value)
	Creates or modifies a time attribute.

void	SetTimeAttribute (const NXString &title, const NXString &value, NXOpen::Update::Option option)
	Creates or modifies a time attribute with the option to update or not.

void	SetTimeAttribute (const char title, const char value, NXOpen::Update::Option option)
	Creates or modifies a time attribute with the option to update or not.

void	SetTimeUserAttribute (const NXString &title, int index, const NXString &value, NXOpen::Update::Option option)
	Creates or modifies a time attribute with the option to update or not.

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

void	SetTimeUserAttribute (const NXString &title, int index, const NXOpen::NXObject::ComputationalTime &value, NXOpen::Update::Option option)
	Creates or modifies a time attribute with the option to update or not.

void	SetTimeUserAttribute (const char *title, int index, const NXOpen::NXObject::ComputationalTime &value, NXOpen::Update::Option option)
	Creates or modifies a time attribute with the option to update or not.

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

void	SetUserAttribute (const NXString &title, int index, int value, NXOpen::Update::Option option)
	Creates or modifies an integer attribute with the option to update or not.

void	SetUserAttribute (const char *title, int index, int value, NXOpen::Update::Option option)
	Creates or modifies an integer attribute with the option to update or not.

void	SetUserAttribute (const NXString &title, int index, double value, NXOpen::Update::Option option)
	Creates or modifies a real attribute with the option to update or not.

void	SetUserAttribute (const char *title, int index, double value, NXOpen::Update::Option option)
	Creates or modifies a real attribute with the option to update or not.

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

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

void	SetUserAttribute (const NXString &title, int index, NXOpen::Update::Option option)
	Creates or modifies a null attribute with the option to update or not.

void	SetUserAttribute (const char *title, int index, NXOpen::Update::Option option)
	Creates or modifies a null attribute with the option to update or not.

void	SetUserAttributeLock (const NXString &title, NXOpen::NXObject::AttributeType type, bool lock)
	Lock or unlock the given attribute.

void	SetUserAttributeLock (const char *title, NXOpen::NXObject::AttributeType type, bool lock)
	Lock or unlock the given attribute.

Public Member Functions inherited from NXOpen::TaggedObject
tag_t	GetTag () const
	<b>Deprecated</b>:<br> Use Tag instead.

tag_t	Tag () const
	Returns the tag of this object.

Public Member Functions inherited from NXOpen::INXObject
NXOpen::INXObject *	FindObject (const char *journalIdentifier)
	Finds the NXObject with the given identifier as recorded in a journal.

void	SetName (const char *name)
	Sets the custom name of the object.

Detailed Description

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

 <br> To create a new instance of this class, use @link Routing::PortConnectionCollection::CreatePortConnection  Routing::PortConnectionCollection::CreatePortConnection @endlink  <br>

Created in NX4.0.0.

Member Enumeration Documentation

enum NXOpen::Routing::PortConnection::OverriddenValidity

Overridden port connection validity.

Enumerator:

OverriddenValidityNone	The port connection validity has not been overridden.
OverriddenValidityValid	The port connection validity has been overridden to be valid.
OverriddenValidityInvalid	The port connection validity has been overridden to be invalid.

Member Function Documentation

bool NXOpen::Routing::PortConnection::ArePortsAligned ( )

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

Both direction and rotation are evaluated.

Returns: validity of the current connection.
Created in NX8.0.0.

License requirements : routing_base ("Routing Basic")

void NXOpen::Routing::PortConnection::ForceValid ( const NXString & reason )

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.

void NXOpen::Routing::PortConnection::ForceValid ( const char * reason )

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.

double NXOpen::Routing::PortConnection::GetEngagement ( )

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

Returns: engagement distance between the ports connected by the Port Connection object
Created in NX4.0.0.

License requirements : routing_base ("Routing Basic")

NXOpen::Routing::PortConnection::OverriddenValidity NXOpen::Routing::PortConnection::GetOverriddenValidity ( )

Returns the overridden validity value of the port connection.

Returns: overridden validity value.
Created in NX8.0.0.

License requirements : routing_base ("Routing Basic")

NXString NXOpen::Routing::PortConnection::GetOverrideReason ( )

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

Returns: The reason why this connection's validity was overridden.
Created in NX8.0.0.

License requirements : routing_base ("Routing Basic")

void NXOpen::Routing::PortConnection::GetPorts	(	NXOpen::Routing::Port **	port1,
		NXOpen::Routing::Port **	port2
	)

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

bool NXOpen::Routing::PortConnection::IsForcedValid ( )

Returns whether the connection is forced to be valid.

Returns: validity of the current connection.
Created in NX8.0.0.

License requirements : routing_base ("Routing Basic")

bool NXOpen::Routing::PortConnection::IsValid ( )

Returns whether the connection is valid.

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

Returns: validity of the current connection.
Created in NX8.0.0.

License requirements : routing_base ("Routing Basic")

void NXOpen::Routing::PortConnection::OverrideValidity ( NXOpen::Routing::PortConnection::OverriddenValidity overriddenValidity )

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.

void NXOpen::Routing::PortConnection::RemoveForcedValidity ( )

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")

void NXOpen::Routing::PortConnection::SetEngagement ( double engagement )

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

void NXOpen::Routing::PortConnection::SetOverrideReason ( const NXString & reason )

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.

void NXOpen::Routing::PortConnection::SetOverrideReason ( const char * reason )

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.

void NXOpen::Routing::PortConnection::SetPorts	(	NXOpen::Routing::Port *	port1,
		NXOpen::Routing::Port *	port2
	)

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.hxx

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Member Function Documentation