NX Open C++ Reference Guide
Public Types | Public Member Functions
NXOpen::Preferences::RoutingStock Class Reference

The Preferences for Routing Stock objects. More...

List of all members.

Public Types

enum  SpaceReservationModeFlag { SpaceReservationModeFlagLegacySpaceReservation, SpaceReservationModeFlagSpaceReservationAsComponent }
 Describes the valid value for space reservation mode. More...
enum  StockModeFlag { StockModeFlagLegacyStock, StockModeFlagStockAsComponent }
 Describes the valid value for stock mode. More...

Public Member Functions

NXString CurrentTile ()
 Returns the current routing level/tile
Created in NX4.0.0.
NXOpen::Routing::StockStyle DefaultStockStyle ()
 Returns the default stock style
Created in NX4.0.0.
bool DeleteOverstock ()
 Returns the delete overstock flag during deletion of last stock covered by the overstock
Created in NX4.0.0.
void GetDefaultStock (NXOpen::Routing::CharacteristicList **stockPart, NXOpen::Routing::CharacteristicList **dataCharx)
 Returns the current default stock to assign when creating paths.
void GetPreferredFillerStock (NXOpen::Routing::CharacteristicList **stockPart, NXOpen::Routing::CharacteristicList **dataCharx)
 Returns the preferred for creating filler stock.
void GetPreferredOverstock (NXOpen::Routing::CharacteristicList **stockPart, NXOpen::Routing::CharacteristicList **dataCharx)
 Returns the preferred stock for creating overstock.
void GetPreferredSpaceReservation (NXOpen::Routing::CharacteristicList **stockPart, NXOpen::Routing::CharacteristicList **dataCharx)
 Returns the preferred stock for creating space reservation
Created in NX6.0.0.
void SetCurrentTile (const NXString &tile)
 Sets the current routing level/tile
Created in NX4.0.0.
void SetDefaultStock (NXOpen::Routing::CharacteristicList *stockPart, NXOpen::Routing::CharacteristicList *dataCharx)
 Sets the current default stock to assign when creating paths.
void SetDefaultStockStyle (NXOpen::Routing::StockStyle defaultStockStyle)
 Sets the default stock style
Created in NX4.0.0.
void SetDeleteOverstock (bool deleteOverstock)
 Sets the delete overstock flag during deletion of last stock covered by the overstock
Created in NX4.0.0.
void SetPreferredFillerStock (NXOpen::Routing::CharacteristicList *stockPart, NXOpen::Routing::CharacteristicList *dataCharx)
 Sets the preferred stock for creating filler stock
Created in NX6.0.0.
void SetPreferredOverstock (NXOpen::Routing::CharacteristicList *stockPart, NXOpen::Routing::CharacteristicList *dataCharx)
 Sets the preferred stock for creating overstock
Created in NX6.0.0.
void SetPreferredSpaceReservation (NXOpen::Routing::CharacteristicList *stockPart, NXOpen::Routing::CharacteristicList *dataCharx)
 Sets the preferred stock for creating space Reservation
Created in NX6.0.0.
void SetSpaceReservationMode (NXOpen::Preferences::RoutingStock::SpaceReservationModeFlag spaceReservationMode)
 Sets the space reservation creation mode
Created in NX7.5.2.
void SetSpaceReservationTranslucency (int spaceReservationTranslucency)
 Sets the desired translucnecy of the newly created Space Reservation Stock
Created in NX6.0.0.
void SetStockAnchor (const NXString &anchorName)
 Sets the Routing::Anchor name associated with the stock preferences.
void SetStockFolder (const NXString &stockFolder)
 Sets the default folder for stock components
Created in NX4.0.0.
void SetStockMode (NXOpen::Preferences::RoutingStock::StockModeFlag stockMode)
 Sets the stock creation mode
Created in NX4.0.0.
NXOpen::Preferences::RoutingStock::SpaceReservationModeFlag SpaceReservationMode ()
 Returns the space reservation creation mode
Created in NX7.5.2.
int SpaceReservationTranslucency ()
 Returns the desired translucnecy of the newly created Space Reservation Stock
Created in NX6.0.0.
NXString StockAnchor ()
 Returns the Routing::Anchor name associated with the stock preferences.
NXString StockFolder ()
 Returns the default folder for stock components
Created in NX4.0.0.
NXOpen::Preferences::RoutingStock::StockModeFlag StockMode ()
 Returns the stock creation mode
Created in NX4.0.0.
tag_t Tag () const
 Returns the tag of this object.

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 Preferences::RoutingApplicationView

Created in NX4.0.0.


Member Enumeration Documentation

Describes the valid value for space reservation mode.

Enumerator:
SpaceReservationModeFlagLegacySpaceReservation 

solid body in the work part, no component

SpaceReservationModeFlagSpaceReservationAsComponent 

component created with solid body in the component

Describes the valid value for stock mode.

Enumerator:
StockModeFlagLegacyStock 

solid body in the work part, no component

StockModeFlagStockAsComponent 

component created with solid body in the component


Member Function Documentation

Returns the current routing level/tile
Created in NX4.0.0.



License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Returns the default stock style
Created in NX4.0.0.



License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Returns the delete overstock flag during deletion of last stock covered by the overstock
Created in NX4.0.0.



License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Returns the current default stock to assign when creating paths.


Created in NX4.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Parameters:
stockPartCharacteristic list used to find the appropriate Routing::StockData for building the stock. See Routing::StockDataCollection::CreateStockData .
dataCharxThe list of optional and required characteristics to apply to the new stock.

Returns the preferred for creating filler stock.


Created in NX6.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Parameters:
stockPartCharacteristic list used to find the appropriate Routing::StockData for building the stock. See Routing::StockDataCollection::CreateStockData .
dataCharxThe list of optional and required characteristics to apply to the new stock.

Returns the preferred stock for creating overstock.


Created in NX6.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Parameters:
stockPartCharacteristic list used to find the appropriate Routing::StockData for building the stock. See Routing::StockDataCollection::CreateStockData .
dataCharxThe list of optional and required characteristics to apply to the new stock.

Returns the preferred stock for creating space reservation
Created in NX6.0.0.



License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Parameters:
stockPartCharacteristic list used to find the appropriate Routing::StockData for building the stock. See Routing::StockDataCollection::CreateStockData .
dataCharxThe list of optional and required characteristics to apply to the new stock.

Sets the current routing level/tile
Created in NX4.0.0.



License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Parameters:
tiletile

Sets the current default stock to assign when creating paths.


Created in NX4.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Parameters:
stockPartCharacteristic list used to find the appropriate Routing::StockData for building the stock. See Routing::StockDataCollection::CreateStockData .
dataCharxThe list of optional and required characteristics to apply to the new stock.

Sets the default stock style
Created in NX4.0.0.



License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Parameters:
defaultStockStyledefault stock style

Sets the delete overstock flag during deletion of last stock covered by the overstock
Created in NX4.0.0.



License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Parameters:
deleteOverstockdelete overstock

Sets the preferred stock for creating filler stock
Created in NX6.0.0.



License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Parameters:
stockPartCharacteristic list used to find the appropriate Routing::StockData for building the stock. See Routing::StockDataCollection::CreateStockData .
dataCharxThe list of optional and required characteristics to apply to the new stock.

Sets the preferred stock for creating overstock
Created in NX6.0.0.



License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Parameters:
stockPartCharacteristic list used to find the appropriate Routing::StockData for building the stock. See Routing::StockDataCollection::CreateStockData .
dataCharxThe list of optional and required characteristics to apply to the new stock.

Sets the preferred stock for creating space Reservation
Created in NX6.0.0.



License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Parameters:
stockPartCharacteristic list used to find the appropriate Routing::StockData for building the stock. See Routing::StockDataCollection::CreateStockData .
dataCharxThe list of optional and required characteristics to apply to the new stock.

Sets the space reservation creation mode
Created in NX7.5.2.



License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Parameters:
spaceReservationModespacereservationmode
void NXOpen::Preferences::RoutingStock::SetSpaceReservationTranslucency ( int  spaceReservationTranslucency)

Sets the desired translucnecy of the newly created Space Reservation Stock
Created in NX6.0.0.



License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Parameters:
spaceReservationTranslucencyspacereservationtranslucency

Sets the Routing::Anchor name associated with the stock preferences.


Created in NX5.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Parameters:
anchorNameanchor name

Sets the default folder for stock components
Created in NX4.0.0.



License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Parameters:
stockFolderstock folder

Sets the stock creation mode
Created in NX4.0.0.



License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Parameters:
stockModestock mode

Returns the space reservation creation mode
Created in NX7.5.2.



License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Returns the desired translucnecy of the newly created Space Reservation Stock
Created in NX6.0.0.



License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Returns the Routing::Anchor name associated with the stock preferences.


Created in NX5.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Returns the default folder for stock components
Created in NX4.0.0.



License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Returns the stock creation mode
Created in NX4.0.0.



License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Returns the tag of this object.


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