NX Open C++ Reference Guide
Public Member Functions | List of all members
NXOpen::Gateway::BaseExplicitOrderBuilder Class Reference

This is the NXOpen::Gateway::BaseExplicitOrderBuilder for the explicit order
This is an abstract class, and cannot be instantiated. More...

Inheritance diagram for NXOpen::Gateway::BaseExplicitOrderBuilder:
NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder NXOpen::Annotations::PMIExplicitOrderBuilder

Public Member Functions

void Clear ()
 Clears the current order and restores it to the default order
Created in NX9.0.0. More...
 
std::vector< NXStringDelete (std::vector< NXString > &selectedEntries, std::vector< NXString > &currentOrder, int numOfRemainingEntries)
 Deletes the saved order/orders that has/have been selected by the user from the list of saved orders. More...
 
std::vector< NXStringDownArrow (std::vector< NXString > &selectedEntries, std::vector< NXString > &currentOrder)
 Moves down the row/rows selected by the user in the lists. More...
 
std::vector< NXStringPaste (int pastePoint, std::vector< NXString > &selectedEntries, std::vector< NXString > &currentOrder)
 Pastes the rows that have been previously selected using the cut operation. More...
 
void Save (std::vector< NXString > &orderList, const NXString &saveName)
 Saves an explicit order defined by the user
Created in NX9.0.0. More...
 
void Save (std::vector< NXString > &orderList, const char *saveName)
 Saves an explicit order defined by the user
Created in NX9.0.0. More...
 
void SaveAsTextFile (const NXString &savedOrderName, const NXString &saveFileName, bool overwriteFile)
 Saves the selected saved order in the form of a text file
Created in NX9.0.0. More...
 
void SaveAsTextFile (const char *savedOrderName, const char *saveFileName, bool overwriteFile)
 Saves the selected saved order in the form of a text file
Created in NX9.0.0. More...
 
NXString SaveName ()
 Returns the save name
Created in NX9.0.0. More...
 
void SetSaveName (const NXString &saveName)
 Sets the save name
Created in NX9.0.0. More...
 
void SetSaveName (const char *saveName)
 Sets the save name
Created in NX9.0.0. More...
 
std::vector< NXStringUpArrow (std::vector< NXString > &selectedEntries, std::vector< NXString > &currentOrder)
 Moves up the row/rows selected by the user in the lists. 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

This is the NXOpen::Gateway::BaseExplicitOrderBuilder for the explicit order
This is an abstract class, and cannot be instantiated.



Created in NX9.0.0.

Member Function Documentation

void NXOpen::Gateway::BaseExplicitOrderBuilder::Clear ( )

Clears the current order and restores it to the default order
Created in NX9.0.0.



License requirements : None

std::vector<NXString> NXOpen::Gateway::BaseExplicitOrderBuilder::Delete ( std::vector< NXString > &  selectedEntries,
std::vector< NXString > &  currentOrder,
int  numOfRemainingEntries 
)

Deletes the saved order/orders that has/have been selected by the user from the list of saved orders.

Returns

Created in NX9.0.0.

License requirements : None
Parameters
selectedEntriesselectedentries
currentOrdercurrentorder
numOfRemainingEntriesnumofremainingentries
std::vector<NXString> NXOpen::Gateway::BaseExplicitOrderBuilder::DownArrow ( std::vector< NXString > &  selectedEntries,
std::vector< NXString > &  currentOrder 
)

Moves down the row/rows selected by the user in the lists.

Returns

Created in NX9.0.0.

License requirements : None
Parameters
selectedEntriesselectedentries
currentOrdercurrentorder
std::vector<NXString> NXOpen::Gateway::BaseExplicitOrderBuilder::Paste ( int  pastePoint,
std::vector< NXString > &  selectedEntries,
std::vector< NXString > &  currentOrder 
)

Pastes the rows that have been previously selected using the cut operation.

Returns

Created in NX9.0.0.

License requirements : None
Parameters
pastePointpastepoint
selectedEntriesselectedentries
currentOrdercurrentorder
void NXOpen::Gateway::BaseExplicitOrderBuilder::Save ( std::vector< NXString > &  orderList,
const NXString saveName 
)

Saves an explicit order defined by the user
Created in NX9.0.0.



License requirements : None

Parameters
orderListorderlist
saveNamesavename
void NXOpen::Gateway::BaseExplicitOrderBuilder::Save ( std::vector< NXString > &  orderList,
const char *  saveName 
)

Saves an explicit order defined by the user
Created in NX9.0.0.



License requirements : None

Parameters
orderListorderlist
saveNamesavename
void NXOpen::Gateway::BaseExplicitOrderBuilder::SaveAsTextFile ( const NXString savedOrderName,
const NXString saveFileName,
bool  overwriteFile 
)

Saves the selected saved order in the form of a text file
Created in NX9.0.0.



License requirements : None

Parameters
savedOrderNamesavedordername
saveFileNamesavefilename
overwriteFileoverwritefile
void NXOpen::Gateway::BaseExplicitOrderBuilder::SaveAsTextFile ( const char *  savedOrderName,
const char *  saveFileName,
bool  overwriteFile 
)

Saves the selected saved order in the form of a text file
Created in NX9.0.0.



License requirements : None

Parameters
savedOrderNamesavedordername
saveFileNamesavefilename
overwriteFileoverwritefile
NXString NXOpen::Gateway::BaseExplicitOrderBuilder::SaveName ( )

Returns the save name
Created in NX9.0.0.



License requirements : None

void NXOpen::Gateway::BaseExplicitOrderBuilder::SetSaveName ( const NXString saveName)

Sets the save name
Created in NX9.0.0.



License requirements : None

Parameters
saveNamesavename
void NXOpen::Gateway::BaseExplicitOrderBuilder::SetSaveName ( const char *  saveName)

Sets the save name
Created in NX9.0.0.



License requirements : None

Parameters
saveNamesavename
std::vector<NXString> NXOpen::Gateway::BaseExplicitOrderBuilder::UpArrow ( std::vector< NXString > &  selectedEntries,
std::vector< NXString > &  currentOrder 
)

Moves up the row/rows selected by the user in the lists.

Returns

Created in NX9.0.0.

License requirements : None
Parameters
selectedEntriesselectedentries
currentOrdercurrentorder

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