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

Represents a OrderAspectsBuilder for changing the order of Navigator
To create a new instance of this class, use NXOpen::AME::AMEManager::CreateOrderAspectsBuilder

Created in NX11.0.0. More...

Inheritance diagram for NXOpen::AME::OrderAspectsBuilder:
NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Types

enum  OrderType {
  OrderTypeEngineeringObjects, OrderTypeTag, OrderTypeChannel, OrderTypeUpstreamObjects,
  OrderTypePage, OrderTypeFragment, OrderTypeDocumentStructureNode, OrderTypeConnectorNode,
  OrderTypeProduct3dmodelNode, OrderTypeProduct2dsymbolMultilineNode, OrderTypeProduct2dsymbolSinglelineNode, OrderTypeProductMemoryArea,
  OrderTypeProductComponentCore, OrderTypeProductComponent, OrderTypeProductTemplateLinkNode, OrderTypeEngineeringObjectsWithNoProduct
}
 possible choices for order of navigator objects More...
 
enum  SortType { SortTypeSortbyCreation, SortTypeSortbyName }
 possible choices for sorting of navigator objects in a set More...
 

Public Member Functions

std::vector
< NXOpen::AME::OrderAspectsBuilder::OrderType
GetOrder ()
 The order for the aspects. More...
 
void SetOrder (const std::vector< NXOpen::AME::OrderAspectsBuilder::OrderType > &order)
 The order for the aspects
Created in NX11.0.0. More...
 
void SetSortFunctionMode (NXOpen::AME::OrderAspectsBuilder::SortType sort)
 Sets
Created in NX11.0.0. More...
 
void SetSortLocationMode (NXOpen::AME::OrderAspectsBuilder::SortType sort)
 Sets
Created in NX11.0.0. More...
 
void SetSortProductMode (NXOpen::AME::OrderAspectsBuilder::SortType sort)
 Sets
Created in NX11.0.0. More...
 
NXOpen::AME::OrderAspectsBuilder::SortType SortFunctionMode ()
 Returns
Created in NX11.0.0. More...
 
NXOpen::AME::OrderAspectsBuilder::SortType SortLocationMode ()
 Returns
Created in NX11.0.0. More...
 
NXOpen::AME::OrderAspectsBuilder::SortType SortProductMode ()
 Returns
Created in NX11.0.0. 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

Represents a OrderAspectsBuilder for changing the order of Navigator
To create a new instance of this class, use NXOpen::AME::AMEManager::CreateOrderAspectsBuilder

Created in NX11.0.0.


Member Enumeration Documentation

possible choices for order of navigator objects

Enumerator
OrderTypeEngineeringObjects 

engineering objects

OrderTypeTag 

tag

OrderTypeChannel 

channel

OrderTypeUpstreamObjects 

upstream objects

OrderTypePage 

page

OrderTypeFragment 

fragment

OrderTypeDocumentStructureNode 

document structure node

OrderTypeConnectorNode 

connector node

OrderTypeProduct3dmodelNode 

product3dmodel node

OrderTypeProduct2dsymbolMultilineNode 

product2dsymbol multiline node

OrderTypeProduct2dsymbolSinglelineNode 

product2dsymbol singleline node

OrderTypeProductMemoryArea 

product memory area

OrderTypeProductComponentCore 

product component core

OrderTypeProductComponent 

product component

OrderTypeProductTemplateLinkNode 

product template link node

OrderTypeEngineeringObjectsWithNoProduct 

engineering objects with no product

possible choices for sorting of navigator objects in a set

Enumerator
SortTypeSortbyCreation 

sortby creation

SortTypeSortbyName 

sortby name

Member Function Documentation

std::vector<NXOpen::AME::OrderAspectsBuilder::OrderType> NXOpen::AME::OrderAspectsBuilder::GetOrder ( )

The order for the aspects.

Returns

Created in NX11.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")
void NXOpen::AME::OrderAspectsBuilder::SetOrder ( const std::vector< NXOpen::AME::OrderAspectsBuilder::OrderType > &  order)

The order for the aspects
Created in NX11.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
orderorder
void NXOpen::AME::OrderAspectsBuilder::SetSortFunctionMode ( NXOpen::AME::OrderAspectsBuilder::SortType  sort)

Sets
Created in NX11.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
sortsort
void NXOpen::AME::OrderAspectsBuilder::SetSortLocationMode ( NXOpen::AME::OrderAspectsBuilder::SortType  sort)

Sets
Created in NX11.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
sortsort
void NXOpen::AME::OrderAspectsBuilder::SetSortProductMode ( NXOpen::AME::OrderAspectsBuilder::SortType  sort)

Sets
Created in NX11.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
sortsort
NXOpen::AME::OrderAspectsBuilder::SortType NXOpen::AME::OrderAspectsBuilder::SortFunctionMode ( )

Returns
Created in NX11.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

NXOpen::AME::OrderAspectsBuilder::SortType NXOpen::AME::OrderAspectsBuilder::SortLocationMode ( )

Returns
Created in NX11.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

NXOpen::AME::OrderAspectsBuilder::SortType NXOpen::AME::OrderAspectsBuilder::SortProductMode ( )

Returns
Created in NX11.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")


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