NX Open C++ Reference Guide
Public Types | Public Member Functions | List of all members
NXOpen::Routing::StockBrowserBuilder Class Reference

Builder class for stock browser . More...

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

Public Types

enum  TypeFilter {
  TypeFilterAll, TypeFilterStock, TypeFilterOverStock, TypeFilterFillerStock,
  TypeFilterSpaceReservation, TypeFilterFittingOverstock
}
 Filter type. More...
 

Public Member Functions

void DeleteStocks (const std::vector< NXOpen::NXObject * > &objects)
 Deletes the given Routing::Stock or Routing::FittingOverstock
Created in NX6.0.0. More...
 
NXOpen::Routing::StockBrowserBuilder::TypeFilter FilterType ()
 Returns the stock type filter which defines the type of stock
Created in NX6.0.0. More...
 
void GetSortedList (std::vector< NXOpen::NXObject * > &objects)
 Get the filtered stock object list
Created in NX6.0.0. More...
 
NXString NameFilter ()
 Returns the stock name filter which defines filter to name stock
Created in NX6.0.0. More...
 
void SetFilterType (NXOpen::Routing::StockBrowserBuilder::TypeFilter stockTypeFilter)
 Sets the stock type filter which defines the type of stock
Created in NX6.0.0. More...
 
void SetNameFilter (const NXString &stockNameFilter)
 Sets the stock name filter which defines filter to name stock
Created in NX6.0.0. More...
 
void SetNameFilter (const char *stockNameFilter)
 Sets the stock name filter which defines filter to name stock
Created in NX6.0.0. More...
 
void SetSortedList (const std::vector< NXOpen::NXObject * > &objects)
 Set the filtered stock object list when filter type is changed. More...
 
- Public Member Functions inherited from NXOpen::Builder
NXOpen::NXObjectCommit ()
 Commits any edits that have been applied to the builder. More...
 
void Destroy ()
 Deletes the builder, and cleans up any objects created by the builder. More...
 
std::vector< NXOpen::NXObject * > GetCommittedObjects ()
 For builders that create more than one object, this method returns the objects that are created by commit. More...
 
NXOpen::NXObjectGetObject ()
 Returns the object currently being edited by this builder. More...
 
void ShowResults ()
 Updates the model to reflect the result of an edit to the model for all builders that support showing results. More...
 
virtual bool Validate ()
 Validate whether the inputs to the component are sufficient for commit to be called. More...
 
- Public Member Functions inherited from NXOpen::TaggedObject
tag_t Tag () const
 Returns the tag of this object. More...
 

Detailed Description

Builder class for stock browser .


To create a new instance of this class, use NXOpen::Routing::RouteManager::CreateStockBrowserBuilder
Default values.

Property Value

FilterType

All


Created in NX6.0.0.

Member Enumeration Documentation

Filter type.

Enumerator
TypeFilterAll 

All Stocks.

TypeFilterStock 

Stock.

TypeFilterOverStock 

Overstock.

TypeFilterFillerStock 

Filler Stock.

TypeFilterSpaceReservation 

Space Reservation.

TypeFilterFittingOverstock 

fitting overstock

Member Function Documentation

void NXOpen::Routing::StockBrowserBuilder::DeleteStocks ( const std::vector< NXOpen::NXObject * > &  objects)

Deletes the given Routing::Stock or Routing::FittingOverstock
Created in NX6.0.0.



License requirements : routing_base ("Routing Basic")

Parameters
objectsFiltered Routing Stocks
NXOpen::Routing::StockBrowserBuilder::TypeFilter NXOpen::Routing::StockBrowserBuilder::FilterType ( )

Returns the stock type filter which defines the type of stock
Created in NX6.0.0.



License requirements : routing_base ("Routing Basic")

void NXOpen::Routing::StockBrowserBuilder::GetSortedList ( std::vector< NXOpen::NXObject * > &  objects)

Get the filtered stock object list
Created in NX6.0.0.



License requirements : routing_base ("Routing Basic")

Parameters
objectsFiltered Routing Stocks
NXString NXOpen::Routing::StockBrowserBuilder::NameFilter ( )

Returns the stock name filter which defines filter to name stock
Created in NX6.0.0.



License requirements : routing_base ("Routing Basic")

void NXOpen::Routing::StockBrowserBuilder::SetFilterType ( NXOpen::Routing::StockBrowserBuilder::TypeFilter  stockTypeFilter)

Sets the stock type filter which defines the type of stock
Created in NX6.0.0.



License requirements : routing_base ("Routing Basic")

Parameters
stockTypeFilterstocktypefilter
void NXOpen::Routing::StockBrowserBuilder::SetNameFilter ( const NXString stockNameFilter)

Sets the stock name filter which defines filter to name stock
Created in NX6.0.0.



License requirements : routing_base ("Routing Basic")

Parameters
stockNameFilterstocknamefilter
void NXOpen::Routing::StockBrowserBuilder::SetNameFilter ( const char *  stockNameFilter)

Sets the stock name filter which defines filter to name stock
Created in NX6.0.0.



License requirements : routing_base ("Routing Basic")

Parameters
stockNameFilterstocknamefilter
void NXOpen::Routing::StockBrowserBuilder::SetSortedList ( const std::vector< NXOpen::NXObject * > &  objects)

Set the filtered stock object list when filter type is changed.


Created in NX6.0.0.

License requirements : routing_base ("Routing Basic")

Parameters
objectsFiltered Routing Stocks

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