NXOpen .NET Reference Guide  1899
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties
Public Member Functions | List of all members
NXOpen.Routing.StockOffsetPort Class Reference

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

Inheritance diagram for NXOpen.Routing.StockOffsetPort:
NXOpen.Routing.Port NXOpen.SmartObject NXOpen.Routing.IRoutePosition NXOpen.DisplayableObject NXOpen.Routing.ICharacteristic NXOpen.NXObject NXOpen.IFitTo NXOpen.INXObject NXOpen.TaggedObject NXOpen.INXObject NXOpen.INXObject NXOpen.Utilities.NXRemotableObject IMessageSink

Public Member Functions

unsafe double GetMaxPathStockDiameter ()
 Returns the diameter of all the stock on the path at this NXOpen.Routing.StockOffsetPort . More...
 
unsafe NXOpen.Routing.Port GetOffsetPort ()
 Returns the NXOpen.Routing.StockOffsetPort in the work part that was created from the original port occurrence. More...
 
unsafe NXOpen.Routing.Port GetPortOccurrence ()
 Returns the original port occurrence from which the dumb port was extracted. More...
 
- Public Member Functions inherited from NXOpen.Routing.Port
unsafe NXOpen.Routing.FeaturePort AskFeature ()
 Ask NXOpen.Routing.FeaturePort object associated with NXOpen.Routing.Port . More...
 
unsafe NXOpen.Features.WaveRouting AskWaveFeature ()
 Ask NXOpen.Features.WaveRouting object associated with this NXOpen.Routing.Port . More...
 
unsafe
NXOpen.Routing.PortConnection 
Connect ()
 Finds another NXOpen.Routing.Port to connect this port to. More...
 
unsafe void DeleteCharacterstics (NXOpen.Routing.CharacteristicList values)
 Removes the input list of characteristics from this object. More...
 
unsafe void Disconnect ()
 Deletes any NXOpen.Routing.PortConnection objects that reference this port. More...
 
unsafe int FindPortIntegerCharacteristic (string name)
 Searches for an integer characteristics on the port, then on the ports component and prototype port if the port is an occurrence. More...
 
unsafe double FindPortRealCharacteristic (string name)
 Searches for a real characteristics on the port, then on the ports component and prototype port if the port is an occurrence. More...
 
unsafe string FindPortStringCharacteristic (string name)
 Searches for a string characteristics on the port, then on the ports component and prototype port if the port is an occurrence. More...
 
unsafe NXOpen.Vector3d GetAlignmentVector ()
 Retrieves the alignment vector of Port More...
 
unsafe
NXOpen.Routing.CharacteristicList 
GetCharacteristics ()
 Get all of the characteristics values on the this object. More...
 
unsafe double GetClockIncrement ()
 The clock angle increment value of NXOpen.Routing.Port More...
 
unsafe NXOpen.Assemblies.Component GetComponent ()
 If this port is an occurrence, returns the component part to which it belongs. More...
 
unsafe void GetConnectedPorts (out NXOpen.Routing.Port connectedPort1, out NXOpen.Routing.Port connectedPort2)
 If port is connected to another port, returns both connected ports. More...
 
unsafe NXOpen.Routing.ControlPoint GetControlPoint ()
 Returns the Routing.ControlPoint to which this port is constrained, if any. More...
 
unsafe double GetCutbackLength ()
 Returns the cutback length of a port, i. More...
 
unsafe
NXOpen.Routing.CharacteristicList 
GetDestinationCharacteristics ()
 Returns the destination characteristics from the input object. More...
 
unsafe double GetEngagement ()
 Returns the engagement distance of a port, i. More...
 
unsafe NXOpen.Point3d GetEngagementPosition ()
 Returns the position of the port taking into account the engagement distance. More...
 
unsafe
NXOpen.Routing.Port.FlowDirectionType 
GetFlowDirection ()
 Get the value of flow direction of NXOpen.Routing.Port More...
 
unsafe double GetForwardExtension ()
 Returns the forward extension value for a port i. More...
 
unsafe NXOpen.Expression GetForwardExtensionObject ()
 Returns the forward extension object for a port. More...
 
unsafe int GetIntegerCharacteristic (string name)
 Get the value of an integer characteristic associated with the input name. More...
 
unsafe NXOpen.NXObject GetOccurrence ()
 Returns the occurrence of the given port. More...
 
unsafe
NXOpen.Routing.PortConnection 
GetPortConnection ()
 If port is connected to another port, returns the Port Connection that links them. More...
 
unsafe NXOpen.Routing.Port.PortType GetPortType ()
 Get the type of Port More...
 
unsafe double GetRealCharacteristic (string name)
 Get the value of a real characteristic associated with the input name. More...
 
unsafe string GetReferenceCharacteristic (string name)
 Gets a reference characteristic from the port. More...
 
unsafe NXOpen.DisplayableObject GetRotationObject ()
 Retrieves the object used to derive the rotation vector of Port More...
 
unsafe NXOpen.Vector3d GetRotationVector ()
 Retrieves the rotation vector of Port More...
 
unsafe NXOpen.Routing.ISegment GetSegment ()
 Return the segment the port position and alignment are derived from Returns a null reference (Nothing in Visual Basic) if the port is not derived from segment More...
 
unsafe NXOpen.Routing.Stock GetStockOfPort ()
 For a Routing.StockPort , returns the Routing.Stock to which this port is attached, if any. More...
 
unsafe string GetStringCharacteristic (string name)
 Get the value of a string characteristic associated with the input name. More...
 
unsafe bool IsEngagementLocked (NXOpen.Routing.Port portToCheck)
 Checks to see if ports are engaged. More...
 
unsafe bool IsRotationLocked (NXOpen.Routing.Port portToCheck)
 Checks if ports have their rotation vectors locked. More...
 
unsafe
NXOpen.Positioning.Constraint[] 
LockEngagement (NXOpen.Routing.Port portToLock)
 Locks the port engagement using dcm3 constraints More...
 
unsafe
NXOpen.Positioning.Constraint[] 
LockRotation (NXOpen.Routing.Port portToLock)
 Locks the port rotation vector using dcm3 constraints More...
 
unsafe void ReorderFeature ()
 Reorders the NXOpen.Routing.FeaturePort object associated with NXOpen.Routing.Port after all of the features on which the port feature depends. More...
 
unsafe void SetCharacteristic (string name, int 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. More...
 
unsafe void SetCharacteristic (string name, double value)
 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. More...
 
unsafe void SetCharacteristic (string name, string value)
 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. More...
 
unsafe void SetCharacteristic2 (string title, int value)
 Sets or creates an integer type attribute associated with the input title. More...
 
unsafe void SetCharacteristic2 (string title, double value)
 Sets or creates a double type attribute associated with the input title. More...
 
unsafe void SetCharacteristic2 (string title, string value)
 Sets or creates a string type type attribute associated with the input title. More...
 
unsafe void SetCharacteristics (NXOpen.Routing.CharacteristicList values)
 Set all of the characteristics values on this object. More...
 
unsafe void SetCharacteristics2 (NXOpen.Routing.CharacteristicList values)
 Sets all attributes associated with the titles from the input list, creating new attributes for the ones that don't exist already. More...
 
unsafe void SetClockIncrement (double increment)
 The clock angle increment value of NXOpen.Routing.Port More...
 
unsafe void SetFlowDirection (NXOpen.Routing.Port.FlowDirectionType flowDirection)
 Set the flow direction value of NXOpen.Routing.Port More...
 
unsafe void SetReferenceCharacteristic (string name, string value)
 Sets a reference characteristics on the port. More...
 
unsafe void UnlockEngagement (NXOpen.Routing.Port portToUnlock)
 Unlocks the port engagement More...
 
unsafe void UnlockRotation (NXOpen.Routing.Port portToUnlock)
 Unlocks the port rotation More...
 
- Public Member Functions inherited from NXOpen.SmartObject
unsafe void Evaluate ()
 Evaluate a smart object. More...
 
unsafe void ProtectFromDelete ()
 Protects the SmartObject from being deleted if any referencing objects are deleted. More...
 
unsafe void ReleaseDeleteProtection ()
 Removes delete protection from the SmartObject. More...
 
unsafe void RemoveParameters ()
 Removes the smart object parameters. More...
 
unsafe void ReplaceParameters (NXOpen.SmartObject otherSo)
 Edit a smart object by replacing its parameters using parameters of other smart object of the same class. More...
 
unsafe void SetVisibility (NXOpen.SmartObject.VisibilityOption visibility)
 Sets the visibility. More...
 
- Public Member Functions inherited from NXOpen.DisplayableObject
unsafe void Blank ()
 Blanks the object. More...
 
unsafe void Highlight ()
 Highlights the object. More...
 
unsafe void RedisplayObject ()
 Redisplays the object in all views. More...
 
unsafe void RemoveViewDependency ()
 Remove dependency on all views from an object. More...
 
unsafe void SetNameLocation (NXOpen.Point3d location)
 Sets the location of the object's name. More...
 
unsafe void Unblank ()
 Unblanks the object. More...
 
unsafe void Unhighlight ()
 Unhighlights the 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

- Public Types inherited from NXOpen.Routing.Port
enum  CreateRotationVector { No, Yes }
 Used by NXOpen.Routing.FittingPortCollection.CreateFromCsys and Routing.FixturePortCollection.CreateFromCsys to determine if the rotation vector on the port should be created. More...
 
enum  FlowDirectionType { RouteFlowEither, RouteFlowIn, RouteFlowOut, FlowNone }
 Allowed types for flow direction More...
 
enum  PortType {
  UnknownPort, FittingPort, FixturePort, MultiPort,
  TerminalPort, StockPort, StockOffsetPort
}
 Specifies the port type More...
 
- Protected Member Functions inherited from NXOpen.TaggedObject
new void initialize ()
 <exclude> More...
 
- Properties inherited from NXOpen.Routing.Port
unsafe bool AllowMultipleConnections [get, set]
 Returns or sets the Allow Multiple Connections property for a NXOpen.Routing.Port . More...
 
unsafe double BackwardExtension [get, set]
 Returns or sets the backward extension value for a port (i. More...
 
unsafe NXOpen.Expression BackwardExtensionObject [get, set]
 Returns or sets the backward extension object for a port. More...
 
unsafe NXOpen.Expression ClockIncrementObject [get, set]
 Returns or sets the clock angle increment expression of a NXOpen.Routing.Port , i. More...
 
unsafe NXOpen.Point Point [get, set]
 Returns or sets the NXOpen.Point that specifies the location of the NXOpen.Routing.IRoutePosition object. More...
 
unsafe NXOpen.Point3d Position [get, set]
 Returns or sets the current location of the object in ABS coordinates. More...
 

Detailed Description

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.

Created in NX7.5.4

Member Function Documentation

unsafe double NXOpen.Routing.StockOffsetPort.GetMaxPathStockDiameter ( )
inline

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.

Created in NX7.5.5

License requirements: routing_base ("Routing Basic")

Returns
unsafe NXOpen.Routing.Port NXOpen.Routing.StockOffsetPort.GetOffsetPort ( )
inline

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

Created in NX7.5.4

License requirements: routing_base ("Routing Basic")

Returns
unsafe NXOpen.Routing.Port NXOpen.Routing.StockOffsetPort.GetPortOccurrence ( )
inline

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

Returns a null reference (Nothing in Visual Basic) if the occurrence is not available because it is not loaded, or not in the current reference set, etc.

Created in NX7.5.4

License requirements: routing_base ("Routing Basic")

Returns

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