NX Open C++ Reference Guide
Public Member Functions
NXOpen::Die::DieLimitsBuilderList Class Reference

Represents a list of objects. More...

Inheritance diagram for NXOpen::Die::DieLimitsBuilderList:
NXOpen::TaggedObject

List of all members.

Public Member Functions

void Append (const std::vector< NXOpen::Die::DieLimitsBuilder * > &objects)
 Appends a set of objects to the list.
void Append (NXOpen::Die::DieLimitsBuilder *object)
 Appends an object to the list.
void Clear ()
 Clears the entire list
Created in NX5.0.0.
void Clear (NXOpen::ObjectList::DeleteOption deleteOption)
 Clears the entire list
Created in NX5.0.0.
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, NXOpen::ObjectList::DeleteOption deleteOption)
 Erases the object at the given position from the list.
void Erase (NXOpen::Die::DieLimitsBuilder *obj)
 Erases the object from the list, but does not delete the object.
void Erase (NXOpen::Die::DieLimitsBuilder *obj, NXOpen::ObjectList::DeleteOption deleteOption)
 Erases the object from the list.
int FindIndex (NXOpen::Die::DieLimitsBuilder *obj)
 Finds the index where the input object appears.
NXOpen::Die::DieLimitsBuilderFindItem (int index)
 Returns the object at the input index.
std::vector
< NXOpen::Die::DieLimitsBuilder * > 
GetContents ()
 Gets the contents of the entire list.
void Insert (int location, NXOpen::Die::DieLimitsBuilder *object)
 Inserts an object at the specified location
Created in NX5.0.0.
int Length ()
 Returns the length of the list
Created in NX5.0.0.
void SetContents (const std::vector< NXOpen::Die::DieLimitsBuilder * > &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 (NXOpen::Die::DieLimitsBuilder *object1, NXOpen::Die::DieLimitsBuilder *object2)
 Exchanges the position of two objects inside the list.

Detailed Description

Represents a list of objects.


To create a new instance of this class, use Part::CreateObjectList

Created in NX4.0.0.


Member Function Documentation

Appends a set of objects to the list.


Created in NX4.0.0.

License requirements : None

Parameters:
objectsitems to append

Appends an object to the list.


Created in NX5.0.0.

License requirements : None

Parameters:
objectitem to append

Clears the entire list
Created in NX5.0.0.



License requirements : None

Clears the entire list
Created in NX5.0.0.



License requirements : None

Parameters:
deleteOptionwhether to delete the objects when removing them

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.


Created in NX4.0.0.

License requirements : None

Parameters:
deleteIdxindex of item to be deleted

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.
Created in NX5.0.0.

License requirements : None

Parameters:
indexindex of item to be removed from the list

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.
Created in NX5.0.0.

License requirements : None

Parameters:
indexindex of item to be removed from the list
deleteOptionwhether to delete the object

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.
Created in NX5.0.0.

License requirements : None

Parameters:
objobject to be removed from the list

Erases the object from the list.

The list is shifted so that there isn't a null where the object used to exist.
Created in NX5.0.0.

License requirements : None

Parameters:
objobject to be removed from the list
deleteOptionwhether to delete the object

Finds the index where the input object appears.

If it does not appear, -1 is returned.

Returns:
index of input object, -1 if not on list
Created in NX4.0.0.

License requirements : None
Parameters:
objObject to find index for

Returns the object at the input index.

May be NULL.

Returns:
object found at input index
Created in NX4.0.0.

License requirements : None
Parameters:
indexindex of object to return

Gets the contents of the entire list.

Returns:
The list contents
Created in NX5.0.0.

License requirements : None

Inserts an object at the specified location
Created in NX5.0.0.



License requirements : None

Parameters:
locationlocation at which to insert the object
objectobject to be inserted

Returns the length of the list
Created in NX5.0.0.



License requirements : None

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.


Created in NX5.0.0.

License requirements : None

Parameters:
objectsThe list contents
void NXOpen::Die::DieLimitsBuilderList::Swap ( int  index1,
int  index2 
)

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.
Created in NX5.0.0.

License requirements : None

Parameters:
index1location of the first item
index2location of the second item

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.
Created in NX5.0.0.

License requirements : None

Parameters:
object1first item
object2second item

The documentation for this class was generated from the following file:
Copyright 2011 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.