public interface StockCollection extends TaggedObjectCollection
Stock
objects. RouteManager
TaggedObjectCollection.Iterator
Modifier and Type | Method and Description |
---|---|
Stock[] |
add_stock_ret_stock(CharacteristicList stockPart,
CharacteristicList dataCharx,
ISegment[] segments,
String routeLevel)
Creates stock
Stock on the given segments. |
void |
addStock(CharacteristicList stockPart,
CharacteristicList dataCharx,
ISegment[] segments,
String routeLevel)
Creates stock on the given segments.
|
Stock[] |
addStock(CharacteristicList stockPart,
CharacteristicList dataCharx,
ISegment[] segments,
String routeLevel,
boolean isSpaceReservation)
Creates normal or space reservation stock on the given segments.
|
Stock[] |
addStock(CharacteristicList stockPart,
CharacteristicList dataCharx,
ISegment[] segments,
String routeLevel,
boolean isSpaceReservation,
String anchorName)
Creates normal or space reservation stock on the given segments.
|
void |
convertToStockAsComponents(boolean convertSpaceReservartion,
ComponentName nameType)
Converts a part file from Legacy Stock into Stock as Components.
|
void |
convertToStockAsComponents(ComponentName nameType)
Deprecated.
Deprecated in NX8.0.0. Use
Routing.StockCollection#convertToStockAsComponents instead.
|
Stock[] |
createStock(StockData stockData,
Anchor anchor,
CrossSection crossSection,
ISegment[] segments)
Creates a
Stock object. |
Stock |
getComponentStock(Component component)
Returns the
Stock that controls the given component. |
void |
removeAllFillerStocks(ISegment[] segments)
Removes all filler stocks from the input set of segments.
|
void |
removeStock(ISegment[] segments)
Removes all stocks (excluding flexed stocks) from the input set of segments.
|
void |
resetReferenceStock()
Resets the reference
Stock information to null. |
void |
setAttachedStockLength(Component partOcc)
|
void |
setReferenceStockFromObject(NXObject object)
|
void |
updateBundleStockForFiller(ISegment[] segments)
Update the bundle stock if the
Filler stock is created underneath it. |
_find_next, iterator
Stock[] createStock(StockData stockData, Anchor anchor, CrossSection crossSection, ISegment[] segments) throws NXException, RemoteException
stockData
- The StockData
that defines the stockanchor
- The Anchor
from the input
StockData
to use, null is allowed for
no anchor.crossSection
- The CrossSection
from the input
StockData
to use, null is not allowed.segments
- The array of ISegment
curves that
the stock must cover.Stock
objects.NXException
RemoteException
Stock getComponentStock(Component component) throws NXException, RemoteException
Stock
that controls the given component.
Only returns a Stock
if the input component is a component created
by a Stock as Components stock object.
component
- Stock
NXException
RemoteException
void convertToStockAsComponents(ComponentName nameType) throws NXException, RemoteException
Routing.StockCollection#convertToStockAsComponents
instead.
StockUse.LEGACY_STOCK
into StockUse.STOCK_AS_COMPONENT
stocks by creating components for each stock. After calling this routine, all new stocks in this part
will have components associated with them.
nameType
- Naming scheme to use for components. Calls
??? on
each new stock component if input is
Routing.ComponentName#PERMANENT
.
NXException
RemoteException
void convertToStockAsComponents(boolean convertSpaceReservartion, ComponentName nameType) throws NXException, RemoteException
StockUse.LEGACY_STOCK
into StockUse.STOCK_AS_COMPONENT
stocks by creating components for each stock. After calling this routine, all new stocks in this part will have components associated with them.
convertSpaceReservartion
- If true, convert Space Reservation as ComponentsnameType
- Naming scheme to use for components. Calls
??? on
each new stock component if input is
Routing.ComponentName#PERMANENT
.NXException
RemoteException
void addStock(CharacteristicList stockPart, CharacteristicList dataCharx, ISegment[] segments, String routeLevel) throws NXException, RemoteException
stockPart
- Characteristic list used to find the appropriate
StockData
for building the stock.
See Routing.StockDataCollection#createStockData
.dataCharx
- The list of optional and required characteristics to apply to the new stock.segments
- routeLevel
- Routing level. NXException
RemoteException
Stock[] add_stock_ret_stock(CharacteristicList stockPart, CharacteristicList dataCharx, ISegment[] segments, String routeLevel) throws NXException, RemoteException
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
stockPart
- Characteristic list used to find the appropriate
StockData
for building the stock.
See Routing.StockDataCollection#createStockData
.dataCharx
- The list of optional and required characteristics to apply to the new stock.segments
- routeLevel
- Routing level. NXException
RemoteException
Stock[] addStock(CharacteristicList stockPart, CharacteristicList dataCharx, ISegment[] segments, String routeLevel, boolean isSpaceReservation) throws NXException, RemoteException
stockPart
- Characteristic list used to find the appropriate
StockData
for building the stock.
See Routing.StockDataCollection#createStockData
.dataCharx
- The list of optional and required characteristics to apply to the new stock.segments
- routeLevel
- Routing level. isSpaceReservation
- TRUE to create Space Reservation stock, FALSE to create normal stockNXException
RemoteException
Stock[] addStock(CharacteristicList stockPart, CharacteristicList dataCharx, ISegment[] segments, String routeLevel, boolean isSpaceReservation, String anchorName) throws NXException, RemoteException
stockPart
- Characteristic list used to find the appropriate
StockData
for building the stock.
See Routing.StockDataCollection#createStockData
.dataCharx
- The list of optional and required characteristics to apply to the new stock.segments
- routeLevel
- Routing level. isSpaceReservation
- TRUE to create Space Reservation stock, FALSE to create normal stockanchorName
- Name of the anchor to use. NXException
RemoteException
void removeStock(ISegment[] segments) throws NXException, RemoteException
segments
- NXException
RemoteException
void removeAllFillerStocks(ISegment[] segments) throws NXException, RemoteException
segments
- NXException
RemoteException
void updateBundleStockForFiller(ISegment[] segments) throws NXException, RemoteException
Filler
stock is created underneath it.
segments
- NXException
RemoteException
void setAttachedStockLength(Component partOcc) throws NXException, RemoteException
Stock
to which a
Component
object is attached.
partOcc
- NXException
RemoteException
void setReferenceStockFromObject(NXObject object) throws NXException, RemoteException
Stock
information based
on the Stock
associated with this object.
object
- NXException
RemoteException
void resetReferenceStock() throws NXException, RemoteException
Stock
information to null. 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.
NXException
RemoteException
Copyright 2011 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.