nxopen.geometricutilities

Interface SpinePlaneBuilderList

All Superinterfaces:

Remote, TaggedObject

public interface SpinePlaneBuilderList
extends TaggedObject

Represents a list of objects.
To create a new instance of this class, use Part.createObjectList()

Created in NX4.0.0

Method Summary

Modifier and Type	Method and Description
void	append(SpinePlaneBuilder object) Appends an object to the list License requirements: None.
void	append(SpinePlaneBuilder[] objects) Appends a set of objects to the list License requirements: None.
void	clear() Clears the entire list License requirements: None.
void	clear(ObjectList.DeleteOption deleteOption) Clears the entire list License requirements: None.
void	clearIndex(int deleteIdx) Deletes the item at the index specified.
void	erase(int index) Erases the object from the list, but does not delete the object.
void	erase(int index, ObjectList.DeleteOption deleteOption) Erases the object at the given position from the list.
void	erase(SpinePlaneBuilder obj) Erases the object from the list, but does not delete the object.
void	erase(SpinePlaneBuilder obj, ObjectList.DeleteOption deleteOption) Erases the object from the list.
int	findIndex(SpinePlaneBuilder obj) Finds the index where the input object appears.
SpinePlaneBuilder	findItem(int index) Returns the object at the input index.
SpinePlaneBuilder[]	getContents() Gets the contents of the entire list License requirements: None.
void	insert(int location, SpinePlaneBuilder object) Inserts an object at the specified location License requirements: None.
int	length() Returns the length of the list License requirements: None.
void	moveToBottom(int index) Move object at the specified location to the bottom of the list.
void	moveToTop(int index) Move object at the specified location to the top of the list.
void	setContents(SpinePlaneBuilder[] objects) Sets the contents of the entire list.
void	swap(int index1, int index2) Exchanges the position of two objects inside the list.
void	swap(SpinePlaneBuilder object1, SpinePlaneBuilder object2) Exchanges the position of two objects inside the list.

Methods inherited from interface nxopen.TaggedObject

printTestData, printTestData, tag, tagValue

Method Detail

append

void append(SpinePlaneBuilder[] objects)
     throws NXException,
            RemoteException

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

Created in NX4.0.0

Parameters:

objects - items to append

Throws:

NXException

RemoteException

append

void append(SpinePlaneBuilder object)
     throws NXException,
            RemoteException

Appends an object to the list
License requirements: None.

Created in NX5.0.0

Parameters:

object - item to append

Throws:

NXException

RemoteException

length

int length()
    throws NXException,
           RemoteException

Returns the length of the list
License requirements: None.

Created in NX5.0.0

Throws:

NXException

RemoteException

clearIndex

void clearIndex(int deleteIdx)
         throws NXException,
                RemoteException

Deletes the item at the index specified. The size of the list does not change, but the item at this index is set to NULL.
License requirements: None.

Created in NX4.0.0

Parameters:

deleteIdx - index of item to be deleted

Throws:

NXException

RemoteException

findIndex

int findIndex(SpinePlaneBuilder obj)
       throws NXException,
              RemoteException

Finds the index where the input object appears. If it does not appear, -1 is returned.
License requirements: None.

Created in NX4.0.0

Parameters:

obj - Object to find index for

Returns:

index of input object, -1 if not on list

Throws:

NXException

RemoteException

findItem

SpinePlaneBuilder findItem(int index)
                    throws NXException,
                           RemoteException

Returns the object at the input index. May be NULL.
License requirements: None.

Created in NX4.0.0

Parameters:

index - index of object to return

Returns:

object found at input index

Throws:

NXException

RemoteException

erase

void erase(int index)
    throws NXException,
           RemoteException

Erases the object from the list, but does not delete the object. The list is shifted so that there isn't a null where the object used to be.
License requirements: None.

Created in NX5.0.0

Parameters:

index - index of item to be removed from the list

Throws:

NXException

RemoteException

erase

void erase(int index,
           ObjectList.DeleteOption deleteOption)
    throws NXException,
           RemoteException

Erases the object at the given position from the list. The list is shifted so that there isn't a null where the object used to be.
License requirements: None.

Created in NX5.0.0

Parameters:

index - index of item to be removed from the list

deleteOption - whether to delete the object

Throws:

NXException

RemoteException

erase

void erase(SpinePlaneBuilder obj)
    throws NXException,
           RemoteException

Erases the object from the list, but does not delete the object. The list is shifted so that there isn't a null where the object used to exist.
License requirements: None.

Created in NX5.0.0

Parameters:

obj - object to be removed from the list

Throws:

NXException

RemoteException

erase

void erase(SpinePlaneBuilder obj,
           ObjectList.DeleteOption deleteOption)
    throws NXException,
           RemoteException

Erases the object from the list. The list is shifted so that there isn't a null where the object used to exist.
License requirements: None.

Created in NX5.0.0

Parameters:

obj - object to be removed from the list

deleteOption - whether to delete the object

Throws:

NXException

RemoteException

clear

void clear()
    throws NXException,
           RemoteException

Clears the entire list
License requirements: None.

Created in NX5.0.0

Throws:

NXException

RemoteException

clear

void clear(ObjectList.DeleteOption deleteOption)
    throws NXException,
           RemoteException

Clears the entire list
License requirements: None.

Created in NX5.0.0

Parameters:

deleteOption - whether to delete the objects when removing them

Throws:

NXException

RemoteException

getContents

SpinePlaneBuilder[] getContents()
                         throws NXException,
                                RemoteException

Gets the contents of the entire list
License requirements: None.

Created in NX5.0.0

Returns:

The list contents

Throws:

NXException

RemoteException

setContents

void setContents(SpinePlaneBuilder[] objects)
          throws NXException,
                 RemoteException

Sets the contents of the entire list. This overwrites the previous contents of this list, but does not delete any objects that were originally on the list.
License requirements: None.

Created in NX5.0.0

Parameters:

objects - The list contents

Throws:

NXException

RemoteException

swap

void swap(int index1,
          int index2)
   throws NXException,
          RemoteException

Exchanges the position of two objects inside the list. The first object is placed where the second used to be, and second object where the first used to be.
License requirements: None.

Created in NX5.0.0

Parameters:

index1 - location of the first item

index2 - location of the second item

Throws:

NXException

RemoteException

swap

void swap(SpinePlaneBuilder object1,
          SpinePlaneBuilder object2)
   throws NXException,
          RemoteException

Exchanges the position of two objects inside the list. The first object is placed where the second used to be, and second object where the first used to be.
License requirements: None.

Created in NX5.0.0

Parameters:

object1 - first item

object2 - second item

Throws:

NXException

RemoteException

insert

void insert(int location,
            SpinePlaneBuilder object)
     throws NXException,
            RemoteException

Inserts an object at the specified location
License requirements: None.

Created in NX5.0.0

Parameters:

location - location at which to insert the object

object - object to be inserted

Throws:

NXException

RemoteException

moveToTop

void moveToTop(int index)
        throws NXException,
               RemoteException

Move object at the specified location to the top of the list.
License requirements: None.

Created in NX10.0.0

Parameters:

index - location of the item

Throws:

NXException

RemoteException

moveToBottom

void moveToBottom(int index)
           throws NXException,
                  RemoteException

Move object at the specified location to the bottom of the list.
License requirements: None.

Created in NX10.0.0

Parameters:

index - location of the item

Throws:

NXException

RemoteException