StockOffsetPort Class

class NXOpen.Routing.StockOffsetPort

Bases: NXOpen.Routing.Port

NXOpen.Routing.StockOffsetPort class handles the relationship between a component part’s port occurrence and the dumb offset port in the work part.

The dumb port offsets based on expressions that use the stock diameter. Use NXOpen.Routing.StockOffsetPortCollection.CreateStockOffsetPort() to create an instance of this class.

New in version NX7.5.4.

Properties

Property	Description
AllowMultipleConnections	Returns or sets the Allow Multiple Connections property for a NXOpen.Routing.Port.
BackwardExtension	Returns or sets the backward extension value for a port (i.
BackwardExtensionObject	Returns or sets the backward extension object for a port.
ClockIncrementObject	Returns or sets the clock angle increment expression of a NXOpen.Routing.Port, i.
Color	Returns or sets the color of the object.
IsBlanked	Returns the blank status of this object.
IsOccurrence	Returns whether this object is an occurrence or not.
JournalIdentifier	Returns the identifier that would be recorded in a journal for this object.
Layer	Returns or sets the layer that the object is in.
LineFont	Returns or sets the line font of the object.
LineWidth	Returns or sets the line width of the object.
Name	Returns the custom name of the object.
NameLocation	Returns the location of the object’s name.
OwningComponent	Returns the owning component, if this object is an occurrence.
OwningPart	Returns the owning part of this object
Point	Returns or sets the NXOpen.Point that specifies the location of the NXOpen.Routing.IRoutePosition object.
Position	Returns or sets the current location of the object in ABS coordinates.
Prototype	Returns the prototype of this object if it is an occurrence.
Tag	Returns the Tag for this object.
Update	Returns the update option.
Visibility	Returns the visibility.

Methods

Method	Description
AskFeature	Ask NXOpen.Routing.FeaturePort object associated with NXOpen.Routing.Port.
AskWaveFeature	Ask NXOpen.Features.WaveRouting object associated with this NXOpen.Routing.Port.
Blank	Blanks the object.
Connect	Finds another NXOpen.Routing.Port to connect this port to.
CreateAttributeIterator	Create an attribute iterator
DeleteAllAttributesByType	Deletes all attributes of a specific type.
DeleteAttributeByTypeAndTitle	Deletes an attribute by type and title.
DeleteCharacterstics	Removes the input list of characteristics from this object.
DeleteUserAttribute	Deletes the first attribute encountered with the given Type, Title.
DeleteUserAttributes	Deletes the attributes on the object, if any, that satisfy the given iterator
Disconnect	Deletes any NXOpen.Routing.PortConnection objects that reference this port.
Evaluate	Evaluate a smart object.
FindObject	Finds the NXOpen.NXObject with the given identifier as recorded in a journal.
FindPortIntegerCharacteristic	Searches for an integer characteristics on the port, then on the ports component and prototype port if the port is an occurrence.
FindPortRealCharacteristic	Searches for a real characteristics on the port, then on the ports component and prototype port if the port is an occurrence.
FindPortStringCharacteristic	Searches for a string characteristics on the port, then on the ports component and prototype port if the port is an occurrence.
GetAlignmentVector	Retrieves the alignment vector of Port
GetAttributeTitlesByType	Gets all the attribute titles of a specific type.
GetBooleanUserAttribute	Gets a boolean attribute by Title and array Index.
GetCharacteristics	Get all of the characteristics values on the this object.
GetClockIncrement	The clock angle increment value of NXOpen.Routing.Port
GetComponent	If this port is an occurrence, returns the component part to which it belongs.
GetComputationalTimeUserAttribute	Gets a time attribute by Title and array Index.
GetConnectedPorts	If port is connected to another port, returns both connected ports.
GetControlPoint	Returns the Routing.ControlPoint to which this port is constrained, if any.
GetCutbackLength	Returns the cutback length of a port, i.
GetDestinationCharacteristics	Returns the destination characteristics from the input object.
GetEngagement	Returns the engagement distance of a port, i.
GetEngagementPosition	Returns the position of the port taking into account the engagement distance.
GetFlowDirection	Get the value of flow direction of NXOpen.Routing.Port
GetForwardExtension	Returns the forward extension value for a port i.
GetForwardExtensionObject	Returns the forward extension object for a port.
GetIntegerAttribute	Gets an integer attribute by title.
GetIntegerCharacteristic	Get the value of an integer characteristic associated with the input name.
GetIntegerUserAttribute	Gets an integer attribute by Title and array Index.
GetMaxPathStockDiameter	Returns the diameter of all the stock on the path at this NXOpen.Routing.StockOffsetPort.
GetNextUserAttribute	Gets the next attribute encountered on the object, if any, that satisfies the given iterator.
GetOccurrence	Returns the occurrence of the given port.
GetOffsetPort	Returns the NXOpen.Routing.StockOffsetPort in the work part that was created from the original port occurrence.
GetPdmReferenceAttributeValue	Gets the value of PDM Reference attribute for given object.
GetPortConnection	If port is connected to another port, returns the Port Connection that links them.
GetPortOccurrence	Returns the original port occurrence from which the dumb port was extracted.
GetPortType	Get the type of Port
GetRealAttribute	Gets a real attribute by title.
GetRealCharacteristic	Get the value of a real characteristic associated with the input name.
GetRealUserAttribute	Gets a real attribute by Title and array Index.
GetReferenceAttribute	Gets the reference string (not the calculated value) of a string attribute that uses a reference string.
GetReferenceCharacteristic	Gets a reference characteristic from the port.
GetRotationObject	Retrieves the object used to derive the rotation vector of Port
GetRotationVector	Retrieves the rotation vector of Port
GetSegment	Return the segment the port position and alignment are derived from Returns None if the port is not derived from segment
GetStockOfPort	For a Routing.StockPort, returns the Routing.Stock to which this port is attached, if any.
GetStringAttribute	Gets a string attribute value by title.
GetStringCharacteristic	Get the value of a string characteristic associated with the input name.
GetStringUserAttribute	Gets a string attribute by Title and array Index.
GetTimeAttribute	Gets a time attribute by title.
GetTimeUserAttribute	Gets a time attribute by Title and array Index.
GetUserAttribute	Gets the first attribute encountered on the object, if any, with a given Title, Type and array Index.
GetUserAttributeAsString	Gets the first attribute encountered on the object, if any, with a given title, type and array index.
GetUserAttributeCount	Gets the count of set attributes on the object, if any, that satisfy the given iterator.
GetUserAttributeLock	Determine the lock of the given attribute.
GetUserAttributeSize	Gets the size of the first attribute encountered on the object, if any, with a given Title and Type.
GetUserAttributeSourceObjects	Returns an array of objects from which this object presents attributes.
GetUserAttributes	Gets all the attributes that have been set on the given object, if any, that satisfy the given iterator.
GetUserAttributesAsStrings	Gets all the attributes that have been set on the given object.
HasUserAttribute	Determines if an attribute exists on the object, that satisfies the given iterator
Highlight	Highlights the object.
IsEngagementLocked	Checks to see if ports are engaged.
IsRotationLocked	Checks if ports have their rotation vectors locked.
LockEngagement	Locks the port engagement using dcm3 constraints
LockRotation	Locks the port rotation vector using dcm3 constraints
Print	Prints a representation of this object to the system log file.
ProtectFromDelete	Protects the SmartObject from being deleted if any referencing objects are deleted.
RedisplayObject	Redisplays the object in all views.
ReleaseDeleteProtection	Removes delete protection from the SmartObject.
RemoveParameters	Removes the smart object parameters.
RemoveViewDependency	Remove dependency on all views from an object.
ReorderFeature	Reorders the NXOpen.Routing.FeaturePort object associated with NXOpen.Routing.Port after all of the features on which the port feature depends.
ReplaceParameters	Edit a smart object by replacing its parameters using parameters of other smart object of the same class.
SetAttribute	Creates or modifies an integer attribute.
SetBooleanUserAttribute	Creates or modifies a boolean attribute with the option to update or not.
SetCharacteristic	Set the value of an integer characteristic associated with the input name, adds a new characteristic to the list if one doesn’t exist already.
SetCharacteristic2	Sets or creates an integer type attribute associated with the input title.
SetCharacteristics	Set all of the characteristics values on this object.
SetCharacteristics2	Sets all attributes associated with the titles from the input list, creating new attributes for the ones that don’t exist already.
SetClockIncrement	The clock angle increment value of NXOpen.Routing.Port
SetFlowDirection	Set the flow direction value of NXOpen.Routing.Port
SetName	Sets the custom name of the object.
SetNameLocation	Sets the location of the object’s name.
SetPdmReferenceAttribute	Sets the value of PDM Reference attribute on the object.
SetReferenceAttribute	Creates or modifies a string attribute which uses a reference string.
SetReferenceCharacteristic	Sets a reference characteristics on the port.
SetTimeAttribute	Creates or modifies a time attribute.
SetTimeUserAttribute	Creates or modifies a time attribute with the option to update or not.
SetUserAttribute	Creates or modifies an attribute with the option to update or not.
SetUserAttributeLock	Lock or unlock the given attribute.
SetVisibility	Sets the visibility.
Unblank	Unblanks the object.
Unhighlight	Unhighlights the object.
UnlockEngagement	Unlocks the port engagement
UnlockRotation	Unlocks the port rotation

Property Detail

IsOccurrence

StockOffsetPort.IsOccurrence

Returns whether this object is an occurrence or not.

-------------------------------------

Getter Method

Signature IsOccurrence

Returns:This object is an occurrence Return type:bool

New in version NX3.0.0.

License requirements: None.

JournalIdentifier

StockOffsetPort.JournalIdentifier

Returns the identifier that would be recorded in a journal for this object.

This may not be the same across different releases of the software.

-------------------------------------

Getter Method

Signature JournalIdentifier

Returns: Return type:str

New in version NX3.0.0.

License requirements: None.

Name

StockOffsetPort.Name

Returns the custom name of the object.

-------------------------------------

Getter Method

Signature Name

Returns: Return type:str

New in version NX3.0.0.

License requirements: None.

OwningComponent

StockOffsetPort.OwningComponent

Returns the owning component, if this object is an occurrence.

-------------------------------------

Getter Method

Signature OwningComponent

Returns: Return type:NXOpen.Assemblies.Component

New in version NX3.0.0.

License requirements: None.

OwningPart

StockOffsetPort.OwningPart

Returns the owning part of this object

-------------------------------------

Getter Method

Signature OwningPart

Returns:The owning part of this object or null if it does not have an owner Return type:NXOpen.BasePart

New in version NX3.0.0.

License requirements: None.

Point

StockOffsetPort.Point

Returns or sets the NXOpen.Point that specifies the location of the NXOpen.Routing.IRoutePosition object.

A NULL object indicates that this object is not associated to any point.

-------------------------------------

Getter Method

Signature Point

Returns:New location of object in ABS coordinates Return type:NXOpen.Point

New in version NX4.0.0.

License requirements: routing_base (“Routing Basic”)

-------------------------------------

Setter Method

Signature Point

Parameters:point (NXOpen.Point) – New location of object in ABS coordinates

New in version NX4.0.0.

License requirements: routing_base (“Routing Basic”)

Position

StockOffsetPort.Position

Returns or sets the current location of the object in ABS coordinates.

This value is overridden by the coordinates of the point associated with this object.

-------------------------------------

Getter Method

Signature Position

Returns:Location of object in ABS coordinates Return type:NXOpen.Point3d

New in version NX4.0.0.

License requirements: routing_base (“Routing Basic”)

-------------------------------------

Setter Method

Signature Position

Parameters:position (NXOpen.Point3d) – New location of object in ABS coordinates

New in version NX4.0.0.

License requirements: routing_base (“Routing Basic”)

Prototype

StockOffsetPort.Prototype

Returns the prototype of this object if it is an occurrence.

-------------------------------------

Getter Method

Signature Prototype

Returns:The prototype of this object or null if this object is not an occurrence Return type:NXOpen.INXObject

New in version NX3.0.0.

License requirements: None.

Method Detail

DeleteCharacterstics

StockOffsetPort.DeleteCharacterstics

Removes the input list of characteristics from this object.

Signature DeleteCharacterstics(values)

Parameters:values (NXOpen.Routing.CharacteristicList) –

New in version NX4.0.0.

License requirements: routing_base (“Routing Basic”)

FindObject

StockOffsetPort.FindObject

Finds the NXOpen.NXObject with the given identifier as recorded in a journal.

An object may not return the same value as its JournalIdentifier in different versions of the software. However newer versions of the software should find the same object when FindObject is passed older versions of its journal identifier. In general, this method should not be used in handwritten code and exists to support record and playback of journals.

An exception will be thrown if no object can be found with the given journal identifier.

Signature FindObject(journalIdentifier)

Parameters:journalIdentifier (str) – Journal identifier of the object Returns: Return type:NXOpen.INXObject

New in version NX3.0.0.

License requirements: None.

GetCharacteristics

StockOffsetPort.GetCharacteristics

Get all of the characteristics values on the this object.

Signature GetCharacteristics()

Returns: Return type:NXOpen.Routing.CharacteristicList

New in version NX4.0.0.

License requirements: routing_base (“Routing Basic”)

GetDestinationCharacteristics

StockOffsetPort.GetDestinationCharacteristics

Returns the destination characteristics from the input object.

Retrieves the description of which destination characteristics to read from the application view and then reads those destination characteristics from the object

• Ports: Reads characteristics from the port.
• RCPs: Attempts to find a port at the RCP, reads characteristics from

the port if it exists, otherwise reads from the stock associated with the rcp.

• Segments: Reads characteristics from the stock associated with the segment.
• Components: Reads characteristics directly from the component.
• Stock: Reads characteristics from the stock or from the stock’s data.

Signature GetDestinationCharacteristics()

Returns: Return type:NXOpen.Routing.CharacteristicList

New in version NX4.0.0.

License requirements: routing_base (“Routing Basic”)

GetIntegerCharacteristic

StockOffsetPort.GetIntegerCharacteristic

Get the value of an integer characteristic associated with the input name.

Signature GetIntegerCharacteristic(name)

Parameters:name (str) – Returns: Return type:int

New in version NX4.0.0.

License requirements: routing_base (“Routing Basic”)

GetMaxPathStockDiameter

StockOffsetPort.GetMaxPathStockDiameter

Returns the diameter of all the stock on the path at this NXOpen.Routing.StockOffsetPort.

NOTE: This value may change in the next update cycle.

Signature GetMaxPathStockDiameter()

Returns: Return type:float

New in version NX7.5.5.

License requirements: routing_base (“Routing Basic”)

GetOffsetPort

StockOffsetPort.GetOffsetPort

Returns the NXOpen.Routing.StockOffsetPort in the work part that was created from the original port occurrence.

Signature GetOffsetPort()

Returns: Return type:NXOpen.Routing.Port

New in version NX7.5.4.

License requirements: routing_base (“Routing Basic”)

GetPortOccurrence

StockOffsetPort.GetPortOccurrence

Returns the original port occurrence from which the dumb port was extracted.

Returns None if the occurrence is not available because it is not loaded, or not in the current reference set, etc.

Signature GetPortOccurrence()

Returns: Return type:NXOpen.Routing.Port

New in version NX7.5.4.

License requirements: routing_base (“Routing Basic”)

GetRealCharacteristic

StockOffsetPort.GetRealCharacteristic

Get the value of a real characteristic associated with the input name.

Signature GetRealCharacteristic(name)

Parameters:name (str) – Returns: Return type:float

New in version NX4.0.0.

License requirements: routing_base (“Routing Basic”)

GetStringCharacteristic

StockOffsetPort.GetStringCharacteristic

Get the value of a string characteristic associated with the input name.

Signature GetStringCharacteristic(name)

Parameters:name (str) – Returns: Return type:str

New in version NX4.0.0.

License requirements: routing_base (“Routing Basic”)

Print

StockOffsetPort.Print

Prints a representation of this object to the system log file.

Signature Print()

New in version NX3.0.0.

License requirements: None.

SetCharacteristic

StockOffsetPort.SetCharacteristic

Overloaded method SetCharacteristic

• SetCharacteristic(name, value)
• SetCharacteristic(name, value)
• SetCharacteristic(name, value)

-------------------------------------

Set the value of an integer characteristic associated with the input name, adds a new characteristic to the list if one doesn’t exist already. Converts the type of an existing characteristic with the same name to integer if it’s type is not integer.

Signature SetCharacteristic(name, value)

Parameters:

• name (str) –
• value (int) –

New in version NX4.0.0.

Deprecated since version NX11.0.0: Use NXOpen.Routing.ICharacteristic.SetCharacteristic2() instead.

License requirements: routing_base (“Routing Basic”)

-------------------------------------

Set the value of an real characteristic associated with the input name, adds a new characteristic to the list if one doesn’t exist already. Converts the type of an existing characteristic with the same name to real if it’s type is not real.

Signature SetCharacteristic(name, value)

Parameters:

• name (str) –
• value (float) –

New in version NX4.0.0.

Deprecated since version NX11.0.0: Use NXOpen.Routing.ICharacteristic.SetCharacteristic2() instead.

License requirements: routing_base (“Routing Basic”)

-------------------------------------

Set the value of an string characteristic associated with the input name, adds a new characteristic to the list if one doesn’t exist already. Converts the type of an existing characteristic with the same name to string if it’s type is not string.

Signature SetCharacteristic(name, value)

Parameters:

• name (str) –
• value (str) –

New in version NX4.0.0.

Deprecated since version NX11.0.0: Use NXOpen.Routing.ICharacteristic.SetCharacteristic2() instead.

License requirements: routing_base (“Routing Basic”)

-------------------------------------

SetCharacteristic2

StockOffsetPort.SetCharacteristic2

Overloaded method SetCharacteristic2

• SetCharacteristic2(title, value)
• SetCharacteristic2(title, value)
• SetCharacteristic2(title, value)

-------------------------------------

Sets or creates an integer type attribute associated with the input title. creating a new attribute if one doesn’t exist already.

If the method is called on a stock Assemblies.Component, the method will create or edit a part attribute on the stock part. For legacy parts where the attribute is on the stock component, the attribute will be moved to the stock part.

If the method is called on a non-stock Assemblies.Component, the method will create or edit an attribute on the corresponding instance. For legacy parts where the attribute is on the component, the attribute will be moved to the corresponding instance.

If the method is called on any non-component object, the method will access or create an attribute on the object itself.

Signature SetCharacteristic2(title, value)

Parameters:

• title (str) – Unique title for the Attribute or Characteristic
• value (int) – New Value to be set on the Attribute

New in version NX11.0.0.

License requirements: routing_base (“Routing Basic”)

-------------------------------------

Sets or creates a double type attribute associated with the input title. creating a new attribute if one doesn’t exist already.

If the method is called on a stock Assemblies.Component, the method will create or edit a part attribute on the stock part. For legacy parts where the attribute is on the stock component, the attribute will be moved to the stock part.

If the method is called on a non-stock Assemblies.Component, the method will create or edit an attribute on the corresponding instance. For legacy parts where the attribute is on the component, the attribute will be moved to the corresponding instance.

If the method is called on any non-component object, the method will access or create an attribute on the object itself.

Signature SetCharacteristic2(title, value)

Parameters:

• title (str) – Unique title for the Attribute or Characteristic
• value (float) – New Value to be set on the Attribute

New in version NX11.0.0.

License requirements: routing_base (“Routing Basic”)

-------------------------------------

Sets or creates a string type type attribute associated with the input title. creating a new attribute if one doesn’t exist already.

If the method is called on a stock Assemblies.Component, the method will create or edit a part attribute on the stock part. For legacy parts where the attribute is on the stock component, the attribute will be moved to the stock part.

If the method is called on a non-stock Assemblies.Component, the method will create or edit an attribute on the corresponding instance. For legacy parts where the attribute is on the component, the attribute will be moved to the corresponding instance.

If the method is called on any non-component object, the method will access or create an attribute on the object itself.

Signature SetCharacteristic2(title, value)

Parameters:

• title (str) – Unique title for the Attribute or Characteristic
• value (str) – New Value to be set on the Attribute

New in version NX11.0.0.

License requirements: routing_base (“Routing Basic”)

-------------------------------------

SetCharacteristics

StockOffsetPort.SetCharacteristics

Set all of the characteristics values on this object.

Signature SetCharacteristics(values)

Parameters:values (NXOpen.Routing.CharacteristicList) –

New in version NX4.0.0.

Deprecated since version NX11.0.0: Use NXOpen.Routing.ICharacteristic.SetCharacteristics2() instead.

License requirements: routing_base (“Routing Basic”)

SetCharacteristics2

StockOffsetPort.SetCharacteristics2

Sets all attributes associated with the titles from the input list, creating new attributes for the ones that don’t exist already.

If the method is called on a stock Assemblies.Component, the method will create or edit part attributes on the stock part. For legacy parts where the attributes are on the stock component, the attributes will be moved to the stock part.

If the method is called on a non-stock Assemblies.Component, the method will create or edit attributes on the corresponding instance. For legacy parts where the attribute is on the component, the attributes will be moved to the corresponding instance.

If the method is called on any non-component object, the method will access or create attributes on the object itself.

Signature SetCharacteristics2(values)

Parameters:values (NXOpen.Routing.CharacteristicList) – NXOpen.Routing.CharacteristicList having the titles, types and values of Attributes to be set

New in version NX11.0.0.

License requirements: routing_base (“Routing Basic”)

SetName

StockOffsetPort.SetName

Sets the custom name of the object.

NOTE: This method should not be used to edit a read-only object such as a Mirrored PMI object. If it is, the changes will be overridden when the part is updated.

Signature SetName(name)

Parameters:name (str) –

New in version NX3.0.0.

License requirements: None.