NXOpen .NET Reference Guide
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties
Public Types | Public Member Functions | Properties | List of all members
NXOpen.Preferences.RoutingStock Class Reference

The Preferences for Routing Stock objects. More...

Inheritance diagram for NXOpen.Preferences.RoutingStock:
NXOpen.Utilities.NXRemotableObject IMessageSink

Public Types

enum  SpaceReservationModeFlag { LegacySpaceReservation, SpaceReservationAsComponent }
 Describes the valid value for space reservation mode. More...
 
enum  StockModeFlag { LegacyStock, StockAsComponent }
 Describes the valid value for stock mode. More...
 

Public Member Functions

unsafe void GetDefaultStock (out NXOpen.Routing.CharacteristicList stockPart, out NXOpen.Routing.CharacteristicList dataCharx)
 Returns the current default stock to assign when creating paths. More...
 
unsafe void GetPreferredFillerStock (out NXOpen.Routing.CharacteristicList stockPart, out NXOpen.Routing.CharacteristicList dataCharx)
 Returns the preferred for creating filler stock. More...
 
unsafe void GetPreferredOverstock (out NXOpen.Routing.CharacteristicList stockPart, out NXOpen.Routing.CharacteristicList dataCharx)
 Returns the preferred stock for creating overstock. More...
 
unsafe void GetPreferredSpaceReservation (out NXOpen.Routing.CharacteristicList stockPart, out NXOpen.Routing.CharacteristicList dataCharx)
 Returns the preferred stock for creating space reservation More...
 
unsafe void SetDefaultStock (NXOpen.Routing.CharacteristicList stockPart, NXOpen.Routing.CharacteristicList dataCharx)
 Sets the current default stock to assign when creating paths. More...
 
unsafe void SetPreferredFillerStock (NXOpen.Routing.CharacteristicList stockPart, NXOpen.Routing.CharacteristicList dataCharx)
 Sets the preferred stock for creating filler stock More...
 
unsafe void SetPreferredOverstock (NXOpen.Routing.CharacteristicList stockPart, NXOpen.Routing.CharacteristicList dataCharx)
 Sets the preferred stock for creating overstock More...
 
unsafe void SetPreferredSpaceReservation (NXOpen.Routing.CharacteristicList stockPart, NXOpen.Routing.CharacteristicList dataCharx)
 Sets the preferred stock for creating space Reservation 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...
 

Properties

unsafe string CurrentTile [get, set]
 Returns or sets the current routing level/tile More...
 
unsafe NXOpen.Routing.StockStyle DefaultStockStyle [get, set]
 Returns or sets the default stock style More...
 
unsafe bool DeleteOverstock [get, set]
 Returns or sets the delete overstock flag during deletion of last stock covered by the overstock More...
 
unsafe
NXOpen.Preferences.RoutingStock.SpaceReservationModeFlag 
SpaceReservationMode [get, set]
 Returns or sets the space reservation creation mode More...
 
unsafe int SpaceReservationTranslucency [get, set]
 Returns or sets the desired translucnecy of the newly created Space Reservation Stock More...
 
unsafe string StockAnchor [get, set]
 Returns or sets the NXOpen.Routing.Anchor name associated with the stock preferences. More...
 
unsafe string StockFolder [get, set]
 Returns or sets the default folder for stock components More...
 
unsafe
NXOpen.Preferences.RoutingStock.StockModeFlag 
StockMode [get, set]
 Returns or sets the stock creation mode More...
 
Tag Tag [get]
 Returns the tag of this object. More...
 
- Properties inherited from NXOpen.Utilities.NXRemotableObject
IMessageSink NextSink [get]
 Gets the next message sink in the sink chain. More...
 

Additional Inherited Members

- Protected Member Functions inherited from NXOpen.Utilities.NXRemotableObject
void initialize ()
 <exclude> More...
 

Detailed Description

The Preferences for Routing Stock objects.

These correspond to the values represented on the Preferences->Routing dialog, Stock property page.

To obtain an instance of this class, refer to NXOpen.Preferences.RoutingApplicationView

Created in NX4.0.0

Member Enumeration Documentation

Describes the valid value for space reservation mode.

Enumerator
LegacySpaceReservation 

solid body in the work part, no component

SpaceReservationAsComponent 

component created with solid body in the component

Describes the valid value for stock mode.

Enumerator
LegacyStock 

solid body in the work part, no component

StockAsComponent 

component created with solid body in the component

Member Function Documentation

unsafe void NXOpen.Preferences.RoutingStock.GetDefaultStock ( out NXOpen.Routing.CharacteristicList  stockPart,
out NXOpen.Routing.CharacteristicList  dataCharx 
)
inline

Returns the current default stock to assign when creating paths.

Created in NX4.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.
unsafe void NXOpen.Preferences.RoutingStock.GetPreferredFillerStock ( out NXOpen.Routing.CharacteristicList  stockPart,
out NXOpen.Routing.CharacteristicList  dataCharx 
)
inline

Returns the preferred for creating filler stock.

Created in NX6.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.
unsafe void NXOpen.Preferences.RoutingStock.GetPreferredOverstock ( out NXOpen.Routing.CharacteristicList  stockPart,
out NXOpen.Routing.CharacteristicList  dataCharx 
)
inline

Returns the preferred stock for creating overstock.

Created in NX6.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.
unsafe void NXOpen.Preferences.RoutingStock.GetPreferredSpaceReservation ( out NXOpen.Routing.CharacteristicList  stockPart,
out NXOpen.Routing.CharacteristicList  dataCharx 
)
inline

Returns the preferred stock for creating space reservation

Created in NX6.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.
unsafe void NXOpen.Preferences.RoutingStock.SetDefaultStock ( NXOpen.Routing.CharacteristicList  stockPart,
NXOpen.Routing.CharacteristicList  dataCharx 
)
inline

Sets the current default stock to assign when creating paths.

Created in NX4.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.
unsafe void NXOpen.Preferences.RoutingStock.SetPreferredFillerStock ( NXOpen.Routing.CharacteristicList  stockPart,
NXOpen.Routing.CharacteristicList  dataCharx 
)
inline

Sets the preferred stock for creating filler stock

Created in NX6.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.
unsafe void NXOpen.Preferences.RoutingStock.SetPreferredOverstock ( NXOpen.Routing.CharacteristicList  stockPart,
NXOpen.Routing.CharacteristicList  dataCharx 
)
inline

Sets the preferred stock for creating overstock

Created in NX6.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.
unsafe void NXOpen.Preferences.RoutingStock.SetPreferredSpaceReservation ( NXOpen.Routing.CharacteristicList  stockPart,
NXOpen.Routing.CharacteristicList  dataCharx 
)
inline

Sets the preferred stock for creating space Reservation

Created in NX6.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.

Property Documentation

unsafe string NXOpen.Preferences.RoutingStock.CurrentTile
getset

Returns or sets the current routing level/tile

Created in NX4.0.0

License requirements to get this property: routing_base ("Routing Basic")

License requirements to set this property: routing_base ("Routing Basic")

unsafe NXOpen.Routing.StockStyle NXOpen.Preferences.RoutingStock.DefaultStockStyle
getset

Returns or sets the default stock style

Created in NX4.0.0

License requirements to get this property: routing_base ("Routing Basic")

License requirements to set this property: routing_base ("Routing Basic")

unsafe bool NXOpen.Preferences.RoutingStock.DeleteOverstock
getset

Returns or sets the delete overstock flag during deletion of last stock covered by the overstock

Created in NX4.0.0

License requirements to get this property: routing_base ("Routing Basic")

License requirements to set this property: routing_base ("Routing Basic")

unsafe NXOpen.Preferences.RoutingStock.SpaceReservationModeFlag NXOpen.Preferences.RoutingStock.SpaceReservationMode
getset

Returns or sets the space reservation creation mode

Created in NX7.5.2

License requirements to get this property: routing_base ("Routing Basic")

License requirements to set this property: routing_base ("Routing Basic")

unsafe int NXOpen.Preferences.RoutingStock.SpaceReservationTranslucency
getset

Returns or sets the desired translucnecy of the newly created Space Reservation Stock

Created in NX6.0.0

License requirements to get this property: routing_base ("Routing Basic")

License requirements to set this property: routing_base ("Routing Basic")

unsafe string NXOpen.Preferences.RoutingStock.StockAnchor
getset

Returns or sets the NXOpen.Routing.Anchor name associated with the stock preferences.

Created in NX5.0.0

License requirements to get this property: routing_base ("Routing Basic")

License requirements to set this property: routing_base ("Routing Basic")

unsafe string NXOpen.Preferences.RoutingStock.StockFolder
getset

Returns or sets the default folder for stock components

Created in NX4.0.0

License requirements to get this property: routing_base ("Routing Basic")

License requirements to set this property: routing_base ("Routing Basic")

unsafe NXOpen.Preferences.RoutingStock.StockModeFlag NXOpen.Preferences.RoutingStock.StockMode
getset

Returns or sets the stock creation mode

Created in NX4.0.0

License requirements to get this property: routing_base ("Routing Basic")

License requirements to set this property: routing_base ("Routing Basic")

Tag NXOpen.Preferences.RoutingStock.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.