public interface RoutingStock extends Remote
RoutingApplicationView
Modifier and Type | Interface and Description |
---|---|
static class |
RoutingStock.DefaultStockData
This class holds the data returned from
getDefaultStock() |
static class |
RoutingStock.SpaceReservationModeFlag
Describes the valid value for space reservation mode.
|
static class |
RoutingStock.StockModeFlag
Describes the valid value for stock mode.
|
Modifier and Type | Method and Description |
---|---|
String |
currentTile()
Returns the current routing level/tile
License requirements: routing_base ("Routing Basic") . |
StockStyle |
defaultStockStyle()
Returns the default stock style
License requirements: routing_base ("Routing Basic") . |
boolean |
deleteOverstock()
Returns the delete overstock flag during deletion of last stock covered by
the overstock
License requirements: routing_base ("Routing Basic") . |
RoutingStock.DefaultStockData |
getDefaultStock()
Returns the current default stock to assign when creating paths.
|
RoutingStock.DefaultStockData |
getPreferredFillerStock()
Returns the preferred for creating filler stock.
|
RoutingStock.DefaultStockData |
getPreferredOverstock()
Returns the preferred stock for creating overstock.
|
RoutingStock.DefaultStockData |
getPreferredSpaceReservation()
Returns the preferred stock for creating space reservation
License requirements: routing_base ("Routing Basic") . |
void |
setCurrentTile(String tile)
Sets the current routing level/tile
License requirements: routing_base ("Routing Basic") . |
void |
setDefaultStock(CharacteristicList stockPart,
CharacteristicList dataCharx)
Sets the current default stock to assign when creating paths.
|
void |
setDefaultStockStyle(StockStyle defaultStockStyle)
Sets the default stock style
License requirements: routing_base ("Routing Basic") . |
void |
setDeleteOverstock(boolean deleteOverstock)
Sets the delete overstock flag during deletion of last stock covered by
the overstock
License requirements: routing_base ("Routing Basic") . |
void |
setPreferredFillerStock(CharacteristicList stockPart,
CharacteristicList dataCharx)
Sets the preferred stock for creating filler stock
License requirements: routing_base ("Routing Basic") . |
void |
setPreferredOverstock(CharacteristicList stockPart,
CharacteristicList dataCharx)
Sets the preferred stock for creating overstock
License requirements: routing_base ("Routing Basic") . |
void |
setPreferredSpaceReservation(CharacteristicList stockPart,
CharacteristicList dataCharx)
Sets the preferred stock for creating space Reservation
License requirements: routing_base ("Routing Basic") . |
void |
setSpaceReservationMode(RoutingStock.SpaceReservationModeFlag spaceReservationMode)
Sets the space reservation creation mode
License requirements: routing_base ("Routing Basic") . |
void |
setSpaceReservationTranslucency(int spaceReservationTranslucency)
Sets the desired translucnecy of the newly created Space Reservation Stock
License requirements: routing_base ("Routing Basic") . |
void |
setStockAnchor(String anchorName)
Sets the
Anchor name associated with the stock preferences. |
void |
setStockFolder(String stockFolder)
Sets the default folder for stock components
License requirements: routing_base ("Routing Basic") . |
void |
setStockMode(RoutingStock.StockModeFlag stockMode)
Sets the stock creation mode
License requirements: routing_base ("Routing Basic") . |
RoutingStock.SpaceReservationModeFlag |
spaceReservationMode()
Returns the space reservation creation mode
License requirements: routing_base ("Routing Basic") . |
int |
spaceReservationTranslucency()
Returns the desired translucnecy of the newly created Space Reservation Stock
License requirements: routing_base ("Routing Basic") . |
String |
stockAnchor()
Returns the
Anchor name associated with the stock preferences. |
String |
stockFolder()
Returns the default folder for stock components
License requirements: routing_base ("Routing Basic") . |
RoutingStock.StockModeFlag |
stockMode()
Returns the stock creation mode
License requirements: routing_base ("Routing Basic") . |
StockStyle defaultStockStyle() throws NXException, RemoteException
NXException
RemoteException
void setDefaultStockStyle(StockStyle defaultStockStyle) throws NXException, RemoteException
defaultStockStyle
- NXException
RemoteException
String currentTile() throws NXException, RemoteException
NXException
RemoteException
void setCurrentTile(String tile) throws NXException, RemoteException
tile
- NXException
RemoteException
RoutingStock.StockModeFlag stockMode() throws NXException, RemoteException
NXException
RemoteException
void setStockMode(RoutingStock.StockModeFlag stockMode) throws NXException, RemoteException
stockMode
- NXException
RemoteException
String stockFolder() throws NXException, RemoteException
NXException
RemoteException
void setStockFolder(String stockFolder) throws NXException, RemoteException
stockFolder
- NXException
RemoteException
boolean deleteOverstock() throws NXException, RemoteException
NXException
RemoteException
void setDeleteOverstock(boolean deleteOverstock) throws NXException, RemoteException
deleteOverstock
- NXException
RemoteException
String stockAnchor() throws NXException, RemoteException
Anchor
name associated with the stock preferences.
NXException
RemoteException
void setStockAnchor(String anchorName) throws NXException, RemoteException
Anchor
name associated with the stock preferences.
anchorName
- NXException
RemoteException
void setDefaultStock(CharacteristicList stockPart, CharacteristicList dataCharx) 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.NXException
RemoteException
RoutingStock.DefaultStockData getDefaultStock() throws NXException, RemoteException
NXException
RemoteException
int spaceReservationTranslucency() throws NXException, RemoteException
NXException
RemoteException
void setSpaceReservationTranslucency(int spaceReservationTranslucency) throws NXException, RemoteException
spaceReservationTranslucency
- NXException
RemoteException
void setPreferredFillerStock(CharacteristicList stockPart, CharacteristicList dataCharx) 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.NXException
RemoteException
RoutingStock.DefaultStockData getPreferredFillerStock() throws NXException, RemoteException
NXException
RemoteException
void setPreferredSpaceReservation(CharacteristicList stockPart, CharacteristicList dataCharx) 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.NXException
RemoteException
RoutingStock.DefaultStockData getPreferredSpaceReservation() throws NXException, RemoteException
NXException
RemoteException
void setPreferredOverstock(CharacteristicList stockPart, CharacteristicList dataCharx) 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.NXException
RemoteException
RoutingStock.DefaultStockData getPreferredOverstock() throws NXException, RemoteException
NXException
RemoteException
RoutingStock.SpaceReservationModeFlag spaceReservationMode() throws NXException, RemoteException
NXException
RemoteException
void setSpaceReservationMode(RoutingStock.SpaceReservationModeFlag spaceReservationMode) throws NXException, RemoteException
spaceReservationMode
- NXException
RemoteException
Copyright 2011 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.