NX Open C++ Reference Guide
|
Represents a collection of expressions groups. More...
Classes | |
class | iterator |
Iterator for accessing the contents of the collection. More... | |
Public Member Functions | |
NXOpen::ExpressionGroup * | Active () |
Returns the active expression group Created in NX10.0.0. More... | |
iterator | begin () |
Returns an iterator addressing the first element. More... | |
bool | CheckName (const NXString &name) |
Returns whether or not expression group name is valid. More... | |
bool | CheckName (const char *name) |
Returns whether or not expression group name is valid. More... | |
NXOpen::ExpressionGroup * | Create (const NXString &name) |
Creates an expression group. More... | |
NXOpen::ExpressionGroup * | Create (const char *name) |
Creates an expression group. More... | |
void | Delete (const std::vector< NXOpen::ExpressionGroup * > &expressionGroup) |
Deletes an array of one or more expression groups. More... | |
iterator | end () |
Returns an iterator addressing one past the last element. More... | |
void | ExportExpressionGroupsToFile (const std::vector< NXOpen::ExpressionGroup * > &expressionGroups, const NXString &fileName, NXOpen::ExpressionCollection::SortType sortType) |
Exports the expressions in an expression group to a text file, or, if 'file_name' is NULL, list the expressions in the listing window. More... | |
void | ExportExpressionGroupsToFile (const std::vector< NXOpen::ExpressionGroup * > &expressionGroups, const char *fileName, NXOpen::ExpressionCollection::SortType sortType) |
Exports the expressions in an expression group to a text file, or, if 'file_name' is NULL, list the expressions in the listing window. More... | |
NXOpen::ExpressionGroup * | FindObject (const NXString &journalIdentifier) |
Finds the NXOpen::ExpressionGroup with the given identifier as recorded in a journal. More... | |
NXOpen::ExpressionGroup * | FindObject (const char *journalIdentifier) |
Finds the NXOpen::ExpressionGroup with the given identifier as recorded in a journal. More... | |
std::vector < NXOpen::ExpressionGroup * > | GetAllExpressionGroupsInPart () |
Returns an array of all expression groups in a part . More... | |
NXOpen::ExpressionGroup * | GetDefault () |
Return the default expression group. More... | |
NXOpen::ExpressionGroup * | GetGroupOfExpression (NXOpen::Expression *expression) |
Returns expression group "owner" of an expression. More... | |
void | SetActive (NXOpen::ExpressionGroup *expressionGroup) |
Sets the active expression group Created in NX10.0.0. More... | |
void | SetAllGroupsVisible () |
Make all expression groups visible Created in NX10.0.0. More... | |
tag_t | Tag () const |
Returns the tag of this object. More... | |
Represents a collection of expressions groups.
To obtain an instance of this class, refer to NXOpen::BasePart
Created in NX10.0.0.
NXOpen::ExpressionGroup* NXOpen::ExpressionGroupCollection::Active | ( | ) |
Returns the active expression group
Created in NX10.0.0.
License requirements : None
iterator NXOpen::ExpressionGroupCollection::begin | ( | ) |
Returns an iterator addressing the first element.
bool NXOpen::ExpressionGroupCollection::CheckName | ( | const NXString & | name | ) |
Returns whether or not expression group name is valid.
name | the name of the expression group to check. |
bool NXOpen::ExpressionGroupCollection::CheckName | ( | const char * | name | ) |
Returns whether or not expression group name is valid.
name | the name of the expression group to check. |
NXOpen::ExpressionGroup* NXOpen::ExpressionGroupCollection::Create | ( | const NXString & | name | ) |
Creates an expression group.
name | the name for the expression group. |
NXOpen::ExpressionGroup* NXOpen::ExpressionGroupCollection::Create | ( | const char * | name | ) |
Creates an expression group.
name | the name for the expression group. |
void NXOpen::ExpressionGroupCollection::Delete | ( | const std::vector< NXOpen::ExpressionGroup * > & | expressionGroup | ) |
Deletes an array of one or more expression groups.
This method should be used when deleting an Expression group. DO NOT use the delete methods in Update.ja to delete expression groups
Created in NX10.0.0.
License requirements : None
expressionGroup | array of expression groups to delete |
iterator NXOpen::ExpressionGroupCollection::end | ( | ) |
Returns an iterator addressing one past the last element.
void NXOpen::ExpressionGroupCollection::ExportExpressionGroupsToFile | ( | const std::vector< NXOpen::ExpressionGroup * > & | expressionGroups, |
const NXString & | fileName, | ||
NXOpen::ExpressionCollection::SortType | sortType | ||
) |
Exports the expressions in an expression group to a text file, or, if 'file_name' is NULL, list the expressions in the listing window.
Throws an exception if there is any error.
NOTE: if the file already exists, an exception is thrown and the file is not overwritten.
Created in NX10.0.0.
License requirements : None
expressionGroups | expression groups |
fileName | File name specification to export expressions into. |
sortType | How to sort the exported expressions |
void NXOpen::ExpressionGroupCollection::ExportExpressionGroupsToFile | ( | const std::vector< NXOpen::ExpressionGroup * > & | expressionGroups, |
const char * | fileName, | ||
NXOpen::ExpressionCollection::SortType | sortType | ||
) |
Exports the expressions in an expression group to a text file, or, if 'file_name' is NULL, list the expressions in the listing window.
Throws an exception if there is any error.
NOTE: if the file already exists, an exception is thrown and the file is not overwritten.
Created in NX10.0.0.
License requirements : None
expressionGroups | expression groups |
fileName | File name specification to export expressions into. |
sortType | How to sort the exported expressions |
NXOpen::ExpressionGroup* NXOpen::ExpressionGroupCollection::FindObject | ( | const NXString & | journalIdentifier | ) |
Finds the NXOpen::ExpressionGroup with the given identifier as recorded in a journal.
An object may not return the same value as its JournalIdentifier in different versions of the software. However newer versions of the software should find the same object when FindObject is passed older versions of its journal identifier. In general, this method should not be used in handwritten code and exists to support record and playback of journals.
An exception will be thrown if no object can be found with the given journal identifier.
journalIdentifier | Identifier to be found |
NXOpen::ExpressionGroup* NXOpen::ExpressionGroupCollection::FindObject | ( | const char * | journalIdentifier | ) |
Finds the NXOpen::ExpressionGroup with the given identifier as recorded in a journal.
An object may not return the same value as its JournalIdentifier in different versions of the software. However newer versions of the software should find the same object when FindObject is passed older versions of its journal identifier. In general, this method should not be used in handwritten code and exists to support record and playback of journals.
An exception will be thrown if no object can be found with the given journal identifier.
journalIdentifier | Identifier to be found |
std::vector<NXOpen::ExpressionGroup *> NXOpen::ExpressionGroupCollection::GetAllExpressionGroupsInPart | ( | ) |
Returns an array of all expression groups in a part .
NXOpen::ExpressionGroup* NXOpen::ExpressionGroupCollection::GetDefault | ( | ) |
Return the default expression group.
NXOpen::ExpressionGroup* NXOpen::ExpressionGroupCollection::GetGroupOfExpression | ( | NXOpen::Expression * | expression | ) |
Returns expression group "owner" of an expression.
expression | the expression to query |
void NXOpen::ExpressionGroupCollection::SetActive | ( | NXOpen::ExpressionGroup * | expressionGroup | ) |
Sets the active expression group
Created in NX10.0.0.
License requirements : None
expressionGroup | the expression group to make active |
void NXOpen::ExpressionGroupCollection::SetAllGroupsVisible | ( | ) |
Make all expression groups visible
Created in NX10.0.0.
License requirements : None
tag_t NXOpen::ExpressionGroupCollection::Tag | ( | ) | const |
Returns the tag of this object.