public interface BodyList extends TaggedObject
Part.createObjectList()
Modifier and Type | Method and Description |
---|---|
void |
append(Body object)
Appends an object to the list
License requirements: None. |
void |
append(Body[] objects)
Appends a set of objects to the list
License requirements: None. |
void |
clear()
Clears the entire list without deleting the objects.
|
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(Body obj)
Erases the object from the list, but does not delete the object.
|
void |
erase(Body obj,
ObjectList.DeleteOption deleteOption)
Erases the object from the list.
|
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.
|
int |
findIndex(Body obj)
Finds the index where the input object appears.
|
Body |
findItem(int index)
Returns the object at the input index.
|
Body[] |
getContents()
Gets the contents of the entire list
License requirements: None. |
void |
insert(int location,
Body 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(Body[] objects)
Sets the contents of the entire list.
|
void |
swap(Body object1,
Body object2)
Exchanges the position of two objects inside the list.
|
void |
swap(int index1,
int index2)
Exchanges the position of two objects inside the list.
|
printTestData, printTestData, tag, tagValue
void append(Body[] objects) throws NXException, RemoteException
objects
- items to appendNXException
RemoteException
void append(Body object) throws NXException, RemoteException
object
- item to appendNXException
RemoteException
int length() throws NXException, RemoteException
NXException
RemoteException
void clearIndex(int deleteIdx) throws NXException, RemoteException
deleteIdx
- index of item to be deletedNXException
RemoteException
int findIndex(Body obj) throws NXException, RemoteException
obj
- Object to find index forNXException
RemoteException
Body findItem(int index) throws NXException, RemoteException
index
- index of object to returnNXException
RemoteException
void erase(int index) throws NXException, RemoteException
index
- index of item to be removed from the listNXException
RemoteException
void erase(int index, ObjectList.DeleteOption deleteOption) throws NXException, RemoteException
index
- index of item to be removed from the listdeleteOption
- whether to delete the objectNXException
RemoteException
void erase(Body obj) throws NXException, RemoteException
obj
- object to be removed from the listNXException
RemoteException
void erase(Body obj, ObjectList.DeleteOption deleteOption) throws NXException, RemoteException
obj
- object to be removed from the listdeleteOption
- whether to delete the objectNXException
RemoteException
void clear() throws NXException, RemoteException
NXException
RemoteException
void clear(ObjectList.DeleteOption deleteOption) throws NXException, RemoteException
deleteOption
- whether to delete the objects when removing themNXException
RemoteException
Body[] getContents() throws NXException, RemoteException
NXException
RemoteException
void setContents(Body[] objects) throws NXException, RemoteException
objects
- The list contentsNXException
RemoteException
void swap(int index1, int index2) throws NXException, RemoteException
index1
- location of the first itemindex2
- location of the second itemNXException
RemoteException
void swap(Body object1, Body object2) throws NXException, RemoteException
object1
- first itemobject2
- second itemNXException
RemoteException
void insert(int location, Body object) throws NXException, RemoteException
location
- location at which to insert the objectobject
- object to be insertedNXException
RemoteException
void moveToTop(int index) throws NXException, RemoteException
index
- location of the itemNXException
RemoteException
void moveToBottom(int index) throws NXException, RemoteException
index
- location of the itemNXException
RemoteException
Copyright 2017 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.