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

Represents a collection of NXOpen.Routing.Stock objects. More...

Inheritance diagram for NXOpen.Routing.StockCollection:
NXOpen.TaggedObjectCollection NXOpen.Utilities.NXRemotableObject IEnumerable IMessageSink

Public Member Functions

unsafe void AddStock (NXOpen.Routing.CharacteristicList stockPart, NXOpen.Routing.CharacteristicList dataCharx, NXOpen.Routing.ISegment[] segments, string routeLevel)
 Creates stock on the given segments. More...
 
unsafe void AddStock (NXOpen.Routing.CharacteristicList stockPart, NXOpen.Routing.CharacteristicList dataCharx, NXOpen.Routing.ISegment[] segments, string routeLevel, out NXOpen.Routing.Stock[] stocks)
 Creates stock NXOpen.Routing.Stock on the given segments. More...
 
unsafe void AddStock (NXOpen.Routing.CharacteristicList stockPart, NXOpen.Routing.CharacteristicList dataCharx, NXOpen.Routing.ISegment[] segments, string routeLevel, bool isSpaceReservation, out NXOpen.Routing.Stock[] stocks)
 Creates normal or space reservation stock on the given segments. More...
 
unsafe void AddStock (NXOpen.Routing.CharacteristicList stockPart, NXOpen.Routing.CharacteristicList dataCharx, NXOpen.Routing.ISegment[] segments, string routeLevel, bool isSpaceReservation, string anchorName, out NXOpen.Routing.Stock[] stocks)
 Creates normal or space reservation stock on the given segments. More...
 
unsafe void ConvertToStockAsComponents (bool convertSpaceReservartion, NXOpen.Routing.ComponentName nameType)
 Converts a part file from Legacy Stock into Stock as Components. More...
 
unsafe NXOpen.Routing.Stock[] CreateStock (NXOpen.Routing.StockData stockData, NXOpen.Routing.Anchor anchor, NXOpen.Routing.CrossSection crossSection, NXOpen.Routing.ISegment[] segments)
 Creates a NXOpen.Routing.Stock object. More...
 
unsafe NXOpen.Routing.Stock GetComponentStock (NXOpen.Assemblies.Component component)
 Returns the NXOpen.Routing.Stock that controls the given component. More...
 
unsafe void RemoveAllFillerStocks (NXOpen.Routing.ISegment[] segments)
 Removes all filler stocks from the input set of segments. More...
 
unsafe void RemoveStock (NXOpen.Routing.ISegment[] segments)
 Removes all stocks (excluding flexed stocks) from the input set of segments. More...
 
unsafe void ResetReferenceStock ()
 Resets the reference NXOpen.Routing.Stock information to a null reference (Nothing in Visual Basic). More...
 
unsafe void SetAttachedStockLength (NXOpen.Assemblies.Component partOcc)
 Set the length of the NXOpen.Routing.Stock to which a NXOpen.Assemblies.Component object is attached. More...
 
unsafe void SetReferenceStockFromObject (NXOpen.NXObject @object)
 Sets the reference NXOpen.Routing.Stock information based on the NXOpen.Routing.Stock associated with this object. More...
 
NXOpen.Routing.Stock[] ToArray ()
 Returns an array of NXOpen.Routing.Stock objects. More...
 
unsafe void UpdateBundleStockForFiller (NXOpen.Routing.ISegment[] segments)
 Update the bundle stock if the NXOpen.Routing.Filler stock is created underneath it. More...
 
- Public Member Functions inherited from NXOpen.TaggedObjectCollection
IEnumerator GetEnumerator ()
 Returns an enumerator that iterates through a collection. 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...
 

Protected Member Functions

override int EnumerateMoveNext (ref Tag currentTag, byte[] state)
 Advances the enumerator to the next element of the collection. More...
 
- Protected Member Functions inherited from NXOpen.TaggedObjectCollection
new void initialize ()
 <exclude> More...
 
- Protected Member Functions inherited from NXOpen.Utilities.NXRemotableObject
void initialize ()
 <exclude> More...
 

Properties

Tag Tag [get]
 Returns the tag of this object. More...
 

Detailed Description

Represents a collection of NXOpen.Routing.Stock objects.

To obtain an instance of this class, refer to NXOpen.Routing.RouteManager

Created in NX4.0.0

Member Function Documentation

unsafe void NXOpen.Routing.StockCollection.AddStock ( NXOpen.Routing.CharacteristicList  stockPart,
NXOpen.Routing.CharacteristicList  dataCharx,
NXOpen.Routing.ISegment[]  segments,
string  routeLevel 
)
inline

Creates stock on the given segments.

The segments do not need to be in order, and don't necessarily have to form a single path.

Created in NX5.0.0

License requirements: routing_base ("Routing Basic")

Parameters
stockPartCharacteristic list used to find the appropriate NXOpen.Routing.StockData for building the stock. See Routing.StockDataCollection.CreateStockData .
dataCharxThe list of optional and required characteristics to apply to the new stock.
segments
routeLevelRouting level.
unsafe void NXOpen.Routing.StockCollection.AddStock ( NXOpen.Routing.CharacteristicList  stockPart,
NXOpen.Routing.CharacteristicList  dataCharx,
NXOpen.Routing.ISegment[]  segments,
string  routeLevel,
out NXOpen.Routing.Stock[]  stocks 
)
inline

Creates stock NXOpen.Routing.Stock on the given segments.

The segments do not need to be in order, and don't necessarily have to form a single path. Returns created stock and number of stock

Created in NX5.0.0

License requirements: routing_base ("Routing Basic")

Parameters
stockPartCharacteristic list used to find the appropriate NXOpen.Routing.StockData for building the stock. See Routing.StockDataCollection.CreateStockData .
dataCharxThe list of optional and required characteristics to apply to the new stock.
segments
routeLevelRouting level.
stocksArray of stocks created
unsafe void NXOpen.Routing.StockCollection.AddStock ( NXOpen.Routing.CharacteristicList  stockPart,
NXOpen.Routing.CharacteristicList  dataCharx,
NXOpen.Routing.ISegment[]  segments,
string  routeLevel,
bool  isSpaceReservation,
out NXOpen.Routing.Stock[]  stocks 
)
inline

Creates normal or space reservation stock on the given segments.

The segments do not need to be in order, and don't necessarily have to form a single path.

Created in NX7.5.2

License requirements: routing_base ("Routing Basic")

Parameters
stockPartCharacteristic list used to find the appropriate NXOpen.Routing.StockData for building the stock. See Routing.StockDataCollection.CreateStockData .
dataCharxThe list of optional and required characteristics to apply to the new stock.
segments
routeLevelRouting level.
isSpaceReservationTRUE to create Space Reservation stock, FALSE to create normal stock
stocksArray of stocks created
unsafe void NXOpen.Routing.StockCollection.AddStock ( NXOpen.Routing.CharacteristicList  stockPart,
NXOpen.Routing.CharacteristicList  dataCharx,
NXOpen.Routing.ISegment[]  segments,
string  routeLevel,
bool  isSpaceReservation,
string  anchorName,
out NXOpen.Routing.Stock[]  stocks 
)
inline

Creates normal or space reservation stock on the given segments.

The segments do not need to be in order, and don't necessarily have to form a single path.

Created in NX7.5.2

License requirements: routing_base ("Routing Basic")

Parameters
stockPartCharacteristic list used to find the appropriate NXOpen.Routing.StockData for building the stock. See Routing.StockDataCollection.CreateStockData .
dataCharxThe list of optional and required characteristics to apply to the new stock.
segments
routeLevelRouting level.
isSpaceReservationTRUE to create Space Reservation stock, FALSE to create normal stock
anchorNameName of the anchor to use.
stocksArray of stocks created
unsafe void NXOpen.Routing.StockCollection.ConvertToStockAsComponents ( bool  convertSpaceReservartion,
NXOpen.Routing.ComponentName  nameType 
)
inline

Converts a part file from Legacy Stock into Stock as Components.

Converts all stocks whose use is NXOpen.Routing.StockUse.LegacyStock into NXOpen.Routing.StockUse.StockAsComponent stocks by creating components for each stock. After calling this routine, all new stocks in this part will have components associated with them.

Created in NX7.5.2

License requirements: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

Parameters
convertSpaceReservartionIf true, convert Space Reservation as Components
nameTypeNaming scheme to use for components. Calls ??? on each new stock component if input is Routing.ComponentName.Permanent .
unsafe NXOpen.Routing.Stock [] NXOpen.Routing.StockCollection.CreateStock ( NXOpen.Routing.StockData  stockData,
NXOpen.Routing.Anchor  anchor,
NXOpen.Routing.CrossSection  crossSection,
NXOpen.Routing.ISegment[]  segments 
)
inline

Creates a NXOpen.Routing.Stock object.

Created in NX4.0.0

License requirements: routing_base ("Routing Basic")

Parameters
stockDataThe NXOpen.Routing.StockData that defines the stock
anchorThe NXOpen.Routing.Anchor from the input NXOpen.Routing.StockData to use, a null reference (Nothing in Visual Basic) is allowed for no anchor.
crossSectionThe NXOpen.Routing.CrossSection from the input NXOpen.Routing.StockData to use, a null reference (Nothing in Visual Basic) is not allowed.
segmentsThe array of NXOpen.Routing.ISegment curves that the stock must cover.
Returns
The resulting array of newly created NXOpen.Routing.Stock objects.
override int NXOpen.Routing.StockCollection.EnumerateMoveNext ( ref Tag  currentTag,
byte[]  state 
)
inlineprotectedvirtual

Advances the enumerator to the next element of the collection.

Implements NXOpen.TaggedObjectCollection.

unsafe NXOpen.Routing.Stock NXOpen.Routing.StockCollection.GetComponentStock ( NXOpen.Assemblies.Component  component)
inline

Returns the NXOpen.Routing.Stock that controls the given component.

Only returns a NXOpen.Routing.Stock if the input component is a component created by a Stock as Components stock object.

Created in NX4.0.0

License requirements: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

Parameters
component
Returns
Returns a null reference (Nothing in Visual Basic) if the input component is not controlled by a NXOpen.Routing.Stock
unsafe void NXOpen.Routing.StockCollection.RemoveAllFillerStocks ( NXOpen.Routing.ISegment[]  segments)
inline

Removes all filler stocks from the input set of segments.

Created in NX5.0.4

License requirements: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

Parameters
segments
unsafe void NXOpen.Routing.StockCollection.RemoveStock ( NXOpen.Routing.ISegment[]  segments)
inline

Removes all stocks (excluding flexed stocks) from the input set of segments.

Created in NX5.0.0

License requirements: routing_base ("Routing Basic")

Parameters
segments
unsafe void NXOpen.Routing.StockCollection.ResetReferenceStock ( )
inline

Resets the reference NXOpen.Routing.Stock information to a null reference (Nothing in Visual Basic).

The information attributes are rotation, twist, negate, flip, port and anchor. They determine the default creation options for the new stock. This information is used during path creation.

Created in NX5.0.0

License requirements: routing_base ("Routing Basic")

unsafe void NXOpen.Routing.StockCollection.SetAttachedStockLength ( NXOpen.Assemblies.Component  partOcc)
inline

Set the length of the NXOpen.Routing.Stock to which a NXOpen.Assemblies.Component object is attached.

Created in NX5.0.0

License requirements: routing_base ("Routing Basic")

Parameters
partOcc
unsafe void NXOpen.Routing.StockCollection.SetReferenceStockFromObject ( NXOpen.NXObject object)
inline

Sets the reference NXOpen.Routing.Stock information based on the NXOpen.Routing.Stock associated with this object.

Created in NX5.0.0

License requirements: routing_base ("Routing Basic")

Parameters
object
NXOpen.Routing.Stock [] NXOpen.Routing.StockCollection.ToArray ( )
inline

Returns an array of NXOpen.Routing.Stock objects.

unsafe void NXOpen.Routing.StockCollection.UpdateBundleStockForFiller ( NXOpen.Routing.ISegment[]  segments)
inline

Update the bundle stock if the NXOpen.Routing.Filler stock is created underneath it.

Created in NX5.0.0

License requirements: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

Parameters
segments

Property Documentation

Tag NXOpen.Routing.StockCollection.Tag
get

Returns the tag of this object.


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