OverstockApplication Class¶
-
class
NXOpen.Routing.OverstockApplication¶ Bases:
NXOpen.NXObjectRepresents a collection of
NXOpen.Routing.OverstockApplicationobjects.New in version NX4.0.0.
Properties¶
| Property | Description |
|---|---|
| Definition | Returns the method used to define the overstock application. |
| EndPointOfOverstock | Returns the end point of overstock on the path. |
| IsOccurrence | Returns whether this object is an occurrence or not. |
| JournalIdentifier | Returns the identifier that would be recorded in a journal for this object. |
| MidPointOfOverstock | Returns the mid point of overstock on the path. |
| Name | Returns the custom name of the object. |
| OwningComponent | Returns the owning component, if this object is an occurrence. |
| OwningPart | Returns the owning part of this object |
| Prototype | Returns the prototype of this object if it is an occurrence. |
| StartOfPath | Returns the start control point of the path over which the overstock is applied. |
| StartPointOfOverstock | Returns the start point of overstock on the path. |
| Tag | Returns the Tag for this object. |
Methods¶
| Method | Description |
|---|---|
| CreateAttributeIterator | Create an attribute iterator |
| DeleteAllAttributesByType | Deletes all attributes of a specific type. |
| DeleteAttributeByTypeAndTitle | Deletes an attribute by type and title. |
| 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 |
| FindObject | Finds the NXOpen.NXObject with the given identifier as recorded in a journal. |
| GetAttributeTitlesByType | Gets all the attribute titles of a specific type. |
| GetBooleanUserAttribute | Gets a boolean attribute by Title and array Index. |
| GetComputationalTimeUserAttribute | Gets a time attribute by Title and array Index. |
| GetCoveredStocks | Gets the NXOpen.Routing.Stock and * NXOpen.Routing.OverstockApplication that this * NXOpen.Routing.OverstockApplication covers. |
| GetCrossSections | Gets the cross sections controlled by this object. |
| GetIntegerAttribute | Gets an integer attribute by title. |
| GetIntegerUserAttribute | Gets an integer attribute by Title and array Index. |
| GetNextUserAttribute | Gets the next attribute encountered on the object, if any, that satisfies the given iterator. |
| GetOverstocks | Returns NXOpen.Routing.Overstock objects covering this NXOpen.Routing.OverstockApplication. |
| GetPdmReferenceAttributeValue | Gets the value of PDM Reference attribute for given object. |
| GetRealAttribute | Gets a real attribute by title. |
| 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. |
| GetSegments | Returns the set of segments over which the overstock is applied. |
| GetStringAttribute | Gets a string attribute value by title. |
| 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 |
| Prints a representation of this object to the system log file. | |
| SetAttribute | Creates or modifies an integer attribute. |
| SetBooleanUserAttribute | Creates or modifies a boolean attribute with the option to update or not. |
| SetCoveredStocks | Sets the NXOpen.Routing.Stock and * NXOpen.Routing.OverstockApplication that this * NXOpen.Routing.OverstockApplication covers. |
| SetName | Sets the custom name of the object. |
| SetPdmReferenceAttribute | Sets the value of PDM Reference attribute on the object. |
| SetReferenceAttribute | Creates or modifies a string attribute which uses a reference string. |
| 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. |
Property Detail¶
Definition¶
-
OverstockApplication.Definition¶ Returns the method used to define the overstock application.
-------------------------------------Getter Method
Signature
DefinitionReturns: Return type: NXOpen.Routing.MethodNew in version NX4.0.0.
License requirements: routing_advanced (“Routing Advanced”) OR routing_harness (“Routing Harness”) OR routing_cabling (“Routing Cabling”) OR routing_pipetube (“Routing Piping and Tubing”) OR routing_hvac (“Routing HVAC”) OR routing_platform (“Routing Platform”) OR routing_pid (“Routing PID”)
EndPointOfOverstock¶
-
OverstockApplication.EndPointOfOverstock¶ Returns the end point of overstock on the path.
Used in the Point to Point definition method.
-------------------------------------Getter Method
Signature
EndPointOfOverstockReturns: the end point for the overstock Return type: NXOpen.PointNew in version NX4.0.0.
License requirements: routing_advanced (“Routing Advanced”) OR routing_harness (“Routing Harness”) OR routing_cabling (“Routing Cabling”) OR routing_pipetube (“Routing Piping and Tubing”) OR routing_hvac (“Routing HVAC”) OR routing_platform (“Routing Platform”) OR routing_pid (“Routing PID”)
IsOccurrence¶
-
OverstockApplication.IsOccurrence¶ Returns whether this object is an occurrence or not.
-------------------------------------Getter Method
Signature
IsOccurrenceReturns: This object is an occurrence Return type: bool New in version NX3.0.0.
License requirements: None.
JournalIdentifier¶
-
OverstockApplication.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
JournalIdentifierReturns: Return type: str New in version NX3.0.0.
License requirements: None.
MidPointOfOverstock¶
-
OverstockApplication.MidPointOfOverstock¶ Returns the mid point of overstock on the path.
Used in Point and Length definition method.
-------------------------------------Getter Method
Signature
MidPointOfOverstockReturns: the mid point of the overstock Return type: NXOpen.PointNew in version NX4.0.0.
License requirements: routing_advanced (“Routing Advanced”) OR routing_harness (“Routing Harness”) OR routing_cabling (“Routing Cabling”) OR routing_pipetube (“Routing Piping and Tubing”) OR routing_hvac (“Routing HVAC”) OR routing_platform (“Routing Platform”) OR routing_pid (“Routing PID”)
Name¶
-
OverstockApplication.Name¶ Returns the custom name of the object.
-------------------------------------Getter Method
Signature
NameReturns: Return type: str New in version NX3.0.0.
License requirements: None.
OwningComponent¶
-
OverstockApplication.OwningComponent¶ Returns the owning component, if this object is an occurrence.
-------------------------------------Getter Method
Signature
OwningComponentReturns: Return type: NXOpen.Assemblies.ComponentNew in version NX3.0.0.
License requirements: None.
OwningPart¶
-
OverstockApplication.OwningPart¶ Returns the owning part of this object
-------------------------------------Getter Method
Signature
OwningPartReturns: The owning part of this object or null if it does not have an owner Return type: NXOpen.BasePartNew in version NX3.0.0.
License requirements: None.
Prototype¶
-
OverstockApplication.Prototype¶ Returns the prototype of this object if it is an occurrence.
-------------------------------------Getter Method
Signature
PrototypeReturns: The prototype of this object or null if this object is not an occurrence Return type: NXOpen.INXObjectNew in version NX3.0.0.
License requirements: None.
StartOfPath¶
-
OverstockApplication.StartOfPath¶ Returns the start control point of the path over which the overstock is applied.
-------------------------------------Getter Method
Signature
StartOfPathReturns: the control point at the start of the set of contiguous set of segments. :rtype:
NXOpen.Routing.ControlPointNew in version NX4.0.0.
License requirements: routing_advanced (“Routing Advanced”) OR routing_harness (“Routing Harness”) OR routing_cabling (“Routing Cabling”) OR routing_pipetube (“Routing Piping and Tubing”) OR routing_hvac (“Routing HVAC”) OR routing_platform (“Routing Platform”) OR routing_pid (“Routing PID”)
StartPointOfOverstock¶
-
OverstockApplication.StartPointOfOverstock¶ Returns the start point of overstock on the path.
Used in Interval, Point to Point, and Point and Length definition methods.
-------------------------------------Getter Method
Signature
StartPointOfOverstockReturns: the start point for the overstock Return type: NXOpen.PointNew in version NX4.0.0.
License requirements: routing_advanced (“Routing Advanced”) OR routing_harness (“Routing Harness”) OR routing_cabling (“Routing Cabling”) OR routing_pipetube (“Routing Piping and Tubing”) OR routing_hvac (“Routing HVAC”) OR routing_platform (“Routing Platform”) OR routing_pid (“Routing PID”)
Method Detail¶
FindObject¶
-
OverstockApplication.FindObject¶ Finds the
NXOpen.NXObjectwith 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.INXObjectNew in version NX3.0.0.
License requirements: None.
GetCoveredStocks¶
-
OverstockApplication.GetCoveredStocks¶ Gets the
NXOpen.Routing.Stockand *NXOpen.Routing.OverstockApplicationthat this *NXOpen.Routing.OverstockApplicationcovers.Signature
GetCoveredStocks()Returns: Covered stocks. Return type: list of NXOpen.Routing.StockNew in version NX4.0.0.
License requirements: routing_advanced (“Routing Advanced”) OR routing_harness (“Routing Harness”) OR routing_cabling (“Routing Cabling”) OR routing_pipetube (“Routing Piping and Tubing”) OR routing_hvac (“Routing HVAC”) OR routing_platform (“Routing Platform”) OR routing_pid (“Routing PID”)
GetCrossSections¶
-
OverstockApplication.GetCrossSections¶ Gets the cross sections controlled by this object.
These * cross sections could be used for a custom bundling algorithm.
Signature
GetCrossSections()Returns: Cross sections. Return type: list of NXOpen.CurveNew in version NX4.0.0.
License requirements: routing_advanced (“Routing Advanced”) OR routing_harness (“Routing Harness”) OR routing_cabling (“Routing Cabling”) OR routing_pipetube (“Routing Piping and Tubing”) OR routing_hvac (“Routing HVAC”) OR routing_platform (“Routing Platform”) OR routing_pid (“Routing PID”)
GetOverstocks¶
-
OverstockApplication.GetOverstocks¶ Returns
NXOpen.Routing.Overstockobjects covering thisNXOpen.Routing.OverstockApplication.Signature
GetOverstocks()Returns: Return type: list of NXOpen.Routing.OverstockNew in version NX5.0.0.
License requirements: routing_advanced (“Routing Advanced”) OR routing_harness (“Routing Harness”) OR routing_cabling (“Routing Cabling”) OR routing_pipetube (“Routing Piping and Tubing”) OR routing_hvac (“Routing HVAC”) OR routing_platform (“Routing Platform”) OR routing_pid (“Routing PID”)
GetSegments¶
-
OverstockApplication.GetSegments¶ Returns the set of segments over which the overstock is applied.
Signature
GetSegments()Returns: the contiguous set of segments this overstock application is covering. :rtype: list of
NXOpen.Routing.ISegmentNew in version NX4.0.0.
License requirements: routing_advanced (“Routing Advanced”) OR routing_harness (“Routing Harness”) OR routing_cabling (“Routing Cabling”) OR routing_pipetube (“Routing Piping and Tubing”) OR routing_hvac (“Routing HVAC”) OR routing_platform (“Routing Platform”) OR routing_pid (“Routing PID”)
Print¶
-
OverstockApplication.Print¶ Prints a representation of this object to the system log file.
Signature
Print()New in version NX3.0.0.
License requirements: None.
SetCoveredStocks¶
-
OverstockApplication.SetCoveredStocks¶ Sets the
NXOpen.Routing.Stockand *NXOpen.Routing.OverstockApplicationthat this *NXOpen.Routing.OverstockApplicationcovers.Signature
SetCoveredStocks(coveredStocks)Parameters: coveredStocks (list of NXOpen.Routing.Stock) – Stocks to coverNew in version NX4.0.0.
License requirements: routing_advanced (“Routing Advanced”) OR routing_harness (“Routing Harness”) OR routing_cabling (“Routing Cabling”) OR routing_pipetube (“Routing Piping and Tubing”) OR routing_hvac (“Routing HVAC”) OR routing_platform (“Routing Platform”) OR routing_pid (“Routing PID”)
SetName¶
-
OverstockApplication.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.