nxopen.annotations

Interface SelectBaseCustomSymbolList

All Superinterfaces:

IComponentBuilder, Remote, TaggedObject

public interface SelectBaseCustomSymbolList
extends TaggedObject, IComponentBuilder

Represents a list of objects on a selection list.
Created in NX5.0.0

Method Summary

Modifier and Type	Method and Description
boolean	add(BaseCustomSymbol object) Adds an object to the list License requirements: None.
boolean	add(BaseCustomSymbol[] objects) Adds a set of objects to the list License requirements: None.
boolean	add(BaseCustomSymbol selection, View view, Point3d point) Adds the object with the objects view and objects point License requirements: None.
boolean	add(SelectionMethod inputSelectionMethod) Adds the objects from a SelectionMethod to the list License requirements: None.
void	clear() Removes all items from the list.
boolean	contains(BaseCustomSymbol object) Returns whether the specified object is already in the list or not.
boolean	duplicatesAllowed() Returns whether duplicate objects are allowed in the selection list.
BaseCustomSymbol[]	getArray() Returns the list of objects in the selection list.
SelectObject[]	getSelectObjectArray() Returns the list of SelectObjects in the selection list.
boolean	remove(BaseCustomSymbol object) Remove specified object from list.
boolean	remove(BaseCustomSymbol object, View view) Remove specified object from list.
boolean	remove(InferSnapType.SnapType snapType, BaseCustomSymbol selection1, View view1, Point3d point1, BaseCustomSymbol selection2, View view2, Point3d point2) Remove specified object from list.
boolean	remove(SelectionMethod inputSelectionMethod) Removes the objects from a SelectionMethod from the list License requirements: None.
boolean	removeArray(BaseCustomSymbol[] objects) Remove specified objects from list.
void	setArray(BaseCustomSymbol[] objects) Sets the list of objects in the selection list.
boolean	setValueWithCaeSetObjectInfo(BaseCustomSymbol selection, CaeObjectType.CaeSubType caeSubType, int caeSubId) Deprecated. Deprecated in NX10.0.0. Use other versions of SelectObjectList.add(nxopen.TaggedObject) .
boolean	setValueWithSnap(InferSnapType.SnapType snapType, BaseCustomSymbol selection1, View view1, Point3d point1, BaseCustomSymbol selection2, View view2, Point3d point2) The object being selected with the objects view and objects point and snap information.
int	size() Returns the number of objects in the list.

Methods inherited from interface nxopen.TaggedObject

printTestData, printTestData, tag, tagValue

Methods inherited from interface nxopen.geometricutilities.IComponentBuilder

validate

Method Detail

add

boolean add(BaseCustomSymbol object)
     throws NXException,
            RemoteException

Adds an object to the list
License requirements: None.

Created in NX5.0.0

Parameters:

object - object to add

Returns:

True if succesully added to list; False if the object was already a member of the list and duplicates are not allowed

Throws:

NXException

RemoteException

add

boolean add(BaseCustomSymbol[] objects)
     throws NXException,
            RemoteException

Adds a set of objects to the list
License requirements: None.

Created in NX5.0.0

Parameters:

objects - objects to add

Returns:

True if succesully added all objects to the list; False if there was at least one object that was already a member of the list and duplicates are not allowed

Throws:

NXException

RemoteException

add

boolean add(SelectionMethod inputSelectionMethod)
     throws NXException,
            RemoteException

Adds the objects from a SelectionMethod to the list
License requirements: None.

Created in NX6.0.0

Parameters:

inputSelectionMethod - selection method containing objects to add

Returns:

True if succesully added all objects to the list; False if there was at least one object that was already a member of the list and duplicates are not allowed

Throws:

NXException

RemoteException

add

boolean add(BaseCustomSymbol selection,
            View view,
            Point3d point)
     throws NXException,
            RemoteException

Adds the object with the objects view and objects point
License requirements: None.

Created in NX5.0.0

Parameters:

selection - selected object

view - selected object view

point - selected object point

Returns:

True if succesully added to list; False if the object was already a member of the list and duplicates are not allowed

Throws:

NXException

RemoteException

remove

boolean remove(BaseCustomSymbol object)
        throws NXException,
               RemoteException

Remove specified object from list.
License requirements: None.

Created in NX5.0.0

Parameters:

object - Object to remove

Returns:

True if succesully removed from list; False if the object was not a member of the list

Throws:

NXException

RemoteException

remove

boolean remove(BaseCustomSymbol object,
               View view)
        throws NXException,
               RemoteException

Remove specified object from list.
License requirements: None.

Created in NX6.0.0

Parameters:

object - Object to remove

view - with this view

Returns:

True if succesully removed from list; False if the object / view was not a member of the list

Throws:

NXException

RemoteException

remove

boolean remove(InferSnapType.SnapType snapType,
               BaseCustomSymbol selection1,
               View view1,
               Point3d point1,
               BaseCustomSymbol selection2,
               View view2,
               Point3d point2)
        throws NXException,
               RemoteException

Remove specified object from list.
License requirements: None.

Created in NX6.0.0

Parameters:

snapType - snap point type

selection1 - first selected object

view1 - first selected object view

point1 - first selected object point

selection2 - second selected object

view2 - second selected object view

point2 - second selected object point

Returns:

True if succesully removed from list; False if the object was not a member of the list

Throws:

NXException

RemoteException

removeArray

boolean removeArray(BaseCustomSymbol[] objects)
             throws NXException,
                    RemoteException

Remove specified objects from list.
License requirements: None.

Created in NX5.0.0

Parameters:

objects - Objects to remove

Returns:

True if succesully removed from list; False if the object was not a member of the list

Throws:

NXException

RemoteException

remove

boolean remove(SelectionMethod inputSelectionMethod)
        throws NXException,
               RemoteException

Removes the objects from a SelectionMethod from the list
License requirements: None.

Created in NX6.0.0

Parameters:

inputSelectionMethod - selection method containing objects to add

Returns:

True if succesully removed all objects from the list; False if there was at least one object that was not a member of the list

Throws:

NXException

RemoteException

clear

void clear()
    throws NXException,
           RemoteException

Removes all items from the list.
License requirements: None.

Created in NX5.0.0

Throws:

NXException

RemoteException

contains

boolean contains(BaseCustomSymbol object)
          throws NXException,
                 RemoteException

Returns whether the specified object is already in the list or not.
License requirements: None.

Created in NX5.0.0

Parameters:

object - object to check

Returns:

true if object is in the list, false otherwise

Throws:

NXException

RemoteException

size

int size()
  throws NXException,
         RemoteException

Returns the number of objects in the list.
License requirements: None.

Created in NX5.0.0

Returns:

number of objects in the list

Throws:

NXException

RemoteException

duplicatesAllowed

boolean duplicatesAllowed()
                   throws NXException,
                          RemoteException

Returns whether duplicate objects are allowed in the selection list.
License requirements: None.

Created in NX5.0.0

Returns:

Whether duplicate objects are allowed

Throws:

NXException

RemoteException

setArray

void setArray(BaseCustomSymbol[] objects)
       throws NXException,
              RemoteException

Sets the list of objects in the selection list. This will clear any existing items in the list.
License requirements: None.

Created in NX5.0.0

Parameters:

objects - items to put in the list

Throws:

NXException

RemoteException

getArray

BaseCustomSymbol[] getArray()
                     throws NXException,
                            RemoteException

Returns the list of objects in the selection list.
License requirements: None.

Created in NX5.0.0

Returns:

items in list

Throws:

NXException

RemoteException

getSelectObjectArray

SelectObject[] getSelectObjectArray()
                             throws NXException,
                                    RemoteException

Returns the list of SelectObjects in the selection list.
License requirements: None.

Created in NX5.0.0

Returns:

items in list

Throws:

NXException

RemoteException

setValueWithSnap

boolean setValueWithSnap(InferSnapType.SnapType snapType,
                         BaseCustomSymbol selection1,
                         View view1,
                         Point3d point1,
                         BaseCustomSymbol selection2,
                         View view2,
                         Point3d point2)
                  throws NXException,
                         RemoteException

The object being selected with the objects view and objects point and snap information.
License requirements: None.

Created in NX5.0.0

Parameters:

snapType - snap point type

selection1 - first selected object

view1 - first selected object view

point1 - first selected object point

selection2 - second selected object

view2 - second selected object view

point2 - second selected object point

Returns:

True if succesully added all objects to the list; False if there was at least one object that was already a member of the list and duplicates are not allowed

Throws:

NXException

RemoteException

setValueWithCaeSetObjectInfo

boolean setValueWithCaeSetObjectInfo(BaseCustomSymbol selection,
                                     CaeObjectType.CaeSubType caeSubType,
                                     int caeSubId)
                              throws NXException,
                                     RemoteException

Deprecated. Deprecated in NX10.0.0. Use other versions of SelectObjectList.add(nxopen.TaggedObject) .

The object being selected with CAE set object information.
License requirements: None.

Created in NX5.0.0

Parameters:

selection - selected object

caeSubType - CAE set object sub type

caeSubId - CAE set object sub id

Returns:

True if succesully added all objects to the list; False if there was at least one object that was already a member of the list and duplicates are not allowed

Throws:

NXException

RemoteException