nxopen

Interface ExpressionGroupCollection

All Superinterfaces:

Remote, TaggedObjectCollection

public interface ExpressionGroupCollection
extends TaggedObjectCollection

Represents a collection of expressions groups.
To obtain an instance of this class, refer to BasePart

Created in NX10.0.0

Nested Class Summary

Nested classes/interfaces inherited from interface nxopen.TaggedObjectCollection

TaggedObjectCollection.Iterator

Method Summary

Modifier and Type	Method and Description
ExpressionGroup	active() Returns the active expression group License requirements: None.
boolean	checkName(String name) Returns whether or not expression group name is valid.
ExpressionGroup	create(String name) Creates an expression group License requirements: None.
void	delete(ExpressionGroup[] expressionGroup) Deletes an array of one or more expression groups.
void	exportExpressionGroupsToFile(ExpressionGroup[] expressionGroups, String fileName, 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.
ExpressionGroup	findObject(String journalIdentifier) Finds the ExpressionGroup with the given identifier as recorded in a journal.
ExpressionGroup[]	getAllExpressionGroupsInPart() Returns an array of all expression groups in a part .
ExpressionGroup	getDefault() Return the default expression group License requirements: None.
ExpressionGroup	getGroupOfExpression(Expression expression) Returns expression group "owner" of an expression.
void	rename(ExpressionGroup expressionGroup, String newName) Changes the name of the expression group.
void	setActive(ExpressionGroup expressionGroup) Sets the active expression group License requirements: None.
void	setAllGroupsVisible() Make all expression groups visible License requirements: None.

Methods inherited from interface nxopen.TaggedObjectCollection

_find_next, iterator

Method Detail

create

ExpressionGroup create(String name)
                throws NXException,
                       RemoteException

Creates an expression group
License requirements: None.

Created in NX10.0.0

Parameters:

name - the name for the expression group.

Returns:

the new expression group

Throws:

NXException

RemoteException

rename

void rename(ExpressionGroup expressionGroup,
            String newName)
     throws NXException,
            RemoteException

Changes the name of the expression group.
License requirements: None.

Created in NX11.0.0

Parameters:

expressionGroup - expression group to be renamed

newName - new name of the expression group

Throws:

NXException

RemoteException

findObject

ExpressionGroup findObject(String journalIdentifier)
                    throws NXException,
                           RemoteException

Finds the 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.
License requirements: None.

Created in NX10.0.0

Parameters:

journalIdentifier - Identifier to be found

Returns:

Expression found

Throws:

NXException

RemoteException

delete

void delete(ExpressionGroup[] expressionGroup)
     throws NXException,
            RemoteException

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
License requirements: None.

Created in NX10.0.0

Parameters:

expressionGroup - array of expression groups to delete

Throws:

NXException

RemoteException

getGroupOfExpression

ExpressionGroup getGroupOfExpression(Expression expression)
                              throws NXException,
                                     RemoteException

Returns expression group "owner" of an expression.
License requirements: None.

Created in NX10.0.0

Parameters:

expression - the expression to query

Returns:

expression group of expression

Throws:

NXException

RemoteException

setAllGroupsVisible

void setAllGroupsVisible()
                  throws NXException,
                         RemoteException

Make all expression groups visible
License requirements: None.

Created in NX10.0.0

Throws:

NXException

RemoteException

setActive

void setActive(ExpressionGroup expressionGroup)
        throws NXException,
               RemoteException

Sets the active expression group
License requirements: None.

Created in NX10.0.0

Parameters:

expressionGroup - the expression group to make active

Throws:

NXException

RemoteException

active

ExpressionGroup active()
                throws NXException,
                       RemoteException

Returns the active expression group
License requirements: None.

Created in NX10.0.0

Returns:

the active expression group

Throws:

NXException

RemoteException

getDefault

ExpressionGroup getDefault()
                    throws NXException,
                           RemoteException

Return the default expression group
License requirements: None.

Created in NX10.0.0

Returns:

the default expression group

Throws:

NXException

RemoteException

getAllExpressionGroupsInPart

ExpressionGroup[] getAllExpressionGroupsInPart()
                                        throws NXException,
                                               RemoteException

Returns an array of all expression groups in a part .
License requirements: None.

Created in NX10.0.0

Returns:

array of groupsexpression groups

Throws:

NXException

RemoteException

checkName

boolean checkName(String name)
           throws NXException,
                  RemoteException

Returns whether or not expression group name is valid.
License requirements: None.

Created in NX10.0.0

Parameters:

name - the name of the expression group to check.

Returns:

the status of the name check. True if name is okay

Throws:

NXException

RemoteException

exportExpressionGroupsToFile

void exportExpressionGroupsToFile(ExpressionGroup[] expressionGroups,
                                  String fileName,
                                  ExpressionCollection.SortType sortType)
                           throws NXException,
                                  RemoteException

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.

License requirements: None.

Created in NX10.0.0

Parameters:

expressionGroups -

fileName - File name specification to export expressions into.

sortType - How to sort the exported expressions

Throws:

NXException

RemoteException