NX Open C++ Reference Guide
Public Types | Public Member Functions
NXOpen::Routing::PathStockBuilder Class Reference

Assigns stocks to segments based of users critiera and the current default stock. More...

Inheritance diagram for NXOpen::Routing::PathStockBuilder:
NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

List of all members.

Public Types

enum  AssignMethod {
  AssignMethodNone, AssignMethodDefaultStock, AssignMethodFromStartObject, AssignMethodDiameterValue,
  AssignMethodRectangular, AssignMethodFlatOval, AssignMethodSpecifiedStock, AssignMethodFromParts
}
 Determines how to choose which stock to assign. More...
enum  AssignStockType { AssignStockTypeStock, AssignStockTypeOverstock, AssignStockTypeFiller, AssignStockTypeSpaceReservation }
 Determines the type of stock being assigned. More...

Public Member Functions

void AssignStock (const std::vector< NXOpen::Routing::ISegment * > &segments)
 Assigns stock using the method defined by this stock builder object.
NXOpen::Routing::PathStockBuilder::AssignMethod AssignStockMethod ()
 Returns the method to determine which stock to assign.
double DiameterValue ()
 Returns the diameter value to use for the Routing::PathStockBuilder::AssignMethodDiameterValue method of stock assignment.
NXOpen::ExpressionFlatOvalHeight ()
 Returns the height value to use for the Routing::PathStockBuilder::AssignMethodFlatOval method of stock assignment.
NXOpen::ExpressionFlatOvalRotation ()
 Returns the Width value to use for the Routing::PathStockBuilder::AssignMethodFlatOval method of stock assignment
Created in NX7.5.0.
NXOpen::ExpressionFlatOvalWidth ()
 Returns the Width value to use for the Routing::PathStockBuilder::AssignMethodFlatOval method of stock assignment
Created in NX7.5.0.
void GetFlatOvalDimensions (double *height, double *width)
 Get the FlatOval height and width value to use for the FlatOval space reservation assignment
Created in NX8.0.0.
std::vector
< NXOpen::Assemblies::Component * > 
GetParts ()
 Get the parts to use for the Routing::PathStockBuilder::AssignMethodFromParts method of stock assignment.
void GetRectangularDimensions (double *height, double *width)
 Get the rectangular height and width value to use for the rectangular space reservation assignment
Created in NX8.0.0.
NXOpen::Routing::CharacteristicListGetSpecifiedStock ()
 Returns the specified stock to use for the Routing::PathStockBuilder::AssignMethodSpecifiedStock method of stock assignment.
void GetSpecifiedStock (NXOpen::Routing::CharacteristicList **stockPart, NXOpen::Routing::CharacteristicList **appliedCharx)
 Returns the specified stock and applied characteristics to use for the Routing::PathStockBuilder::AssignMethodSpecifiedStock method of stock assignment.
NXOpen::ExpressionRectangularHeight ()
 Returns the height value to use for the Routing::PathStockBuilder::AssignMethodRectangular method of stock assignment.
NXOpen::ExpressionRectangularRotation ()
 Returns the Width value to use for the Routing::PathStockBuilder::AssignMethodRectangular method of stock assignment
Created in NX7.5.0.
NXOpen::ExpressionRectangularWidth ()
 Returns the Width value to use for the Routing::PathStockBuilder::AssignMethodRectangular method of stock assignment
Created in NX7.5.0.
void SetAssignStockMethod (NXOpen::Routing::PathStockBuilder::AssignMethod method)
 Sets the method to determine which stock to assign.
void SetDiameterValue (double val)
 Sets the diameter value to use for the Routing::PathStockBuilder::AssignMethodDiameterValue method of stock assignment.
void SetFlatOvalDimensions (double height, double width)
 Set the FlatOval height and width value for the FlatOval space reservation assignment
Created in NX8.0.0.
void SetParts (const std::vector< NXOpen::Assemblies::Component * > &parts)
 Set the parts to use for the Routing::PathStockBuilder::AssignMethodFromParts method of stock assignment
Created in NX7.5.0.
void SetRectangularDimensions (double height, double width)
 Set the rectangular height and width value for the rectangular space reservation assignment
Created in NX8.0.0.
void SetSelectedStock (NXOpen::Routing::Stock *stock)
 Set the selected stock
Created in NX8.0.0.
void SetSpecifiedStock (NXOpen::Routing::CharacteristicList *stockPart)
 Sets the specified stock to use for the Routing::PathStockBuilder::AssignMethodSpecifiedStock method of stock assignment.
void SetSpecifiedStock (NXOpen::Routing::CharacteristicList *stockPart, NXOpen::Routing::CharacteristicList *appliedCharx)
 Sets the specified stock and applied characteristics to use for the Routing::PathStockBuilder::AssignMethodSpecifiedStock method of stock assignment.
void SetStartObject (NXOpen::NXObject *startObject)
 Sets the start object to use for the Routing::PathStockBuilder::AssignMethodFromStartObject method of stock assignment.
void SetStockType (NXOpen::Routing::PathStockBuilder::AssignStockType stockType)
 Sets the type of stock being assigned.
void SettingsChanged ()
 Notify the builder that the Routing preferred stock has been modified.
NXOpen::NXObjectStartObject ()
 Returns the start object to use for the Routing::PathStockBuilder::AssignMethodFromStartObject method of stock assignment.
NXOpen::Routing::PathStockBuilder::AssignStockType StockType ()
 Returns the type of stock being assigned.
void UpdateExistingStock (NXOpen::Routing::Stock *existingStock)
 Updates an existing routing stock with settings stored in the builder.

Detailed Description

Assigns stocks to segments based of users critiera and the current default stock.


To create a new instance of this class, use Routing::RouteManager::CreatePathStockBuilder

Created in NX5.0.0.


Member Enumeration Documentation

Determines how to choose which stock to assign.

Enumerator:
AssignMethodNone 

No Stock.

AssignMethodDefaultStock 

Default Stock.

AssignMethodFromStartObject 

Finds a stock based off of the default stock and the object selected by the user.

AssignMethodDiameterValue 

User specified diameter, creates round space reservation stock.

AssignMethodRectangular 

User specified values, creates rectangular space reservation stock.

AssignMethodFlatOval 

User specified values, creates flat_oval space reservation stock.

AssignMethodSpecifiedStock 

Stock selected from Specify Item dialog.

AssignMethodFromParts 

Find stocks from the part table of parts selected by the user.

Determines the type of stock being assigned.

Enumerator:
AssignStockTypeStock 

Default stock type.

AssignStockTypeOverstock 

Overstock stock type.

AssignStockTypeFiller 

Filler stock type.

AssignStockTypeSpaceReservation 

Space Reservation stock type.


Member Function Documentation

Assigns stock using the method defined by this stock builder object.


Created in NX5.0.0.

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

Parameters:
segmentssegments

Returns the method to determine which stock to assign.


Created in NX5.0.0.

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

Returns the diameter value to use for the Routing::PathStockBuilder::AssignMethodDiameterValue method of stock assignment.


Created in NX6.0.0.

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

Returns the height value to use for the Routing::PathStockBuilder::AssignMethodFlatOval method of stock assignment.


Created in NX7.5.0.

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

Returns the Width value to use for the Routing::PathStockBuilder::AssignMethodFlatOval method of stock assignment
Created in NX7.5.0.



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

Returns the Width value to use for the Routing::PathStockBuilder::AssignMethodFlatOval method of stock assignment
Created in NX7.5.0.



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

void NXOpen::Routing::PathStockBuilder::GetFlatOvalDimensions ( double *  height,
double *  width 
)

Get the FlatOval height and width value to use for the FlatOval space reservation assignment
Created in NX8.0.0.



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

Parameters:
heightheight
widthwidth

Get the parts to use for the Routing::PathStockBuilder::AssignMethodFromParts method of stock assignment.

Returns:
Part table parts to get stock characteristics.
Created in NX7.5.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")
void NXOpen::Routing::PathStockBuilder::GetRectangularDimensions ( double *  height,
double *  width 
)

Get the rectangular height and width value to use for the rectangular space reservation assignment
Created in NX8.0.0.



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

Parameters:
heightheight
widthwidth

Returns the specified stock to use for the Routing::PathStockBuilder::AssignMethodSpecifiedStock method of stock assignment.

Returns:
Characteristic list used to find the appropriate Routing::StockData for building the stock. See Routing::StockDataCollection::CreateStockData .
Created in NX6.0.0.

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

Returns the specified stock and applied characteristics to use for the Routing::PathStockBuilder::AssignMethodSpecifiedStock method of stock assignment.


Created in NX6.0.4.

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 .
appliedCharxApplied characteristics for the specified stock.

Returns the height value to use for the Routing::PathStockBuilder::AssignMethodRectangular method of stock assignment.


Created in NX7.5.0.

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

Returns the Width value to use for the Routing::PathStockBuilder::AssignMethodRectangular method of stock assignment
Created in NX7.5.0.



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

Returns the Width value to use for the Routing::PathStockBuilder::AssignMethodRectangular method of stock assignment
Created in NX7.5.0.



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

Sets the method to determine which stock to assign.


Created in NX5.0.0.

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

Parameters:
methodmethod

Sets the diameter value to use for the Routing::PathStockBuilder::AssignMethodDiameterValue method of stock assignment.


Created in NX6.0.0.

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

Parameters:
valval
void NXOpen::Routing::PathStockBuilder::SetFlatOvalDimensions ( double  height,
double  width 
)

Set the FlatOval height and width value for the FlatOval space reservation assignment
Created in NX8.0.0.



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

Parameters:
heightheight
widthwidth

Set the parts to use for the Routing::PathStockBuilder::AssignMethodFromParts method of stock assignment
Created in NX7.5.0.



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

Parameters:
partsPart table parts to get stock characteristics.
void NXOpen::Routing::PathStockBuilder::SetRectangularDimensions ( double  height,
double  width 
)

Set the rectangular height and width value for the rectangular space reservation assignment
Created in NX8.0.0.



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

Parameters:
heightheight
widthwidth

Set the selected stock
Created in NX8.0.0.



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

Parameters:
stockSelected Stock

Sets the specified stock to use for the Routing::PathStockBuilder::AssignMethodSpecifiedStock method of stock assignment.


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 .

Sets the specified stock and applied characteristics to use for the Routing::PathStockBuilder::AssignMethodSpecifiedStock method of stock assignment.


Created in NX6.0.4.

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 .
appliedCharxApplied characteristics for the specified stock.

Sets the start object to use for the Routing::PathStockBuilder::AssignMethodFromStartObject method of stock assignment.


Created in NX5.0.0.

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

Parameters:
startObjectstart object

Sets the type of stock being assigned.


Created in NX6.0.0.

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

Parameters:
stockTypestock type

Notify the builder that the Routing preferred stock has been modified.

This updates the builder so that it now uses the new preferred stock do determine which stock to assign.
Created in NX6.0.0.

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

Returns the start object to use for the Routing::PathStockBuilder::AssignMethodFromStartObject method of stock assignment.


Created in NX5.0.0.

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

Returns the type of stock being assigned.


Created in NX6.0.0.

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

Updates an existing routing stock with settings stored in the builder.


Created in NX6.0.0.

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

Parameters:
existingStockExisting Stock

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