NX Open C++ Reference Guide
Public Member Functions | List of all members
NXOpen::CAM::GeometrySetList Class Reference

Represents a list of objects. More...

Inheritance diagram for NXOpen::CAM::GeometrySetList:
NXOpen::TaggedObject

Public Member Functions

void Append (const std::vector< NXOpen::CAM::GeometrySet * > &objects)
 将一组对象的列表。
 
void Append (NXOpen::CAM::GeometrySet *object)
 追加一个对象列表. 
 
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)
 从列表中删除,但不删除对象 . 
 
void Erase (int index, NXOpen::ObjectList::DeleteOption deleteOption)
 删除对象在给定位置的列表. 
 
void Erase (NXOpen::CAM::GeometrySet *obj)
 Erases the object from the list, but does not delete the object.
 
void Erase (NXOpen::CAM::GeometrySet *obj, NXOpen::ObjectList::DeleteOption deleteOption)
 从列表中删除对象。  
 
int FindIndex (NXOpen::CAM::GeometrySet *obj)
 查找输入对象出现的索引. 
 
NXOpen::CAM::GeometrySetFindItem (int index)
 返回输入索引中的对象. 
 
std::vector
< NXOpen::CAM::GeometrySet * > 
GetContents ()
 得到全部列表. 
 
void Insert (int location, NXOpen::CAM::GeometrySet *object)
 在指定位置插入对象
Created in NX5.0.0.
 
int Length ()
 返回列表的长度
Created in NX5.0.0.
 
void SetContents (const std::vector< NXOpen::CAM::GeometrySet * > &objects)
 设置整个列表的内容
 
void Swap (int index1, int index2)
 在列表中交换两个对象的位置. 
 
void Swap (NXOpen::CAM::GeometrySet *object1, NXOpen::CAM::GeometrySet *object2)
 在列表中交换两个对象的位置. 
 
- Public Member Functions inherited from NXOpen::TaggedObject
tag_t GetTag () const
 
<b>Deprecated</b>:<br>

   Use Tag instead.

 
tag_t Tag () const
 Returns the tag of this object.
 

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

void NXOpen::CAM::GeometrySetList::Append ( const std::vector< NXOpen::CAM::GeometrySet * > &  objects)

Appends a set of objects to the list.


Created in NX4.0.0.

License requirements : None

Parameters
objectsitems to append
void NXOpen::CAM::GeometrySetList::Append ( NXOpen::CAM::GeometrySet object)

Appends an object to the list.


Created in NX5.0.0.

License requirements : None

Parameters
objectitem to append
void NXOpen::CAM::GeometrySetList::Clear ( )

Clears the entire list
Created in NX5.0.0.



License requirements : None

void NXOpen::CAM::GeometrySetList::Clear ( NXOpen::ObjectList::DeleteOption  deleteOption)

Clears the entire list
Created in NX5.0.0.



License requirements : None

Parameters
deleteOptionwhether to delete the objects when removing them
void NXOpen::CAM::GeometrySetList::ClearIndex ( int  deleteIdx)

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
void NXOpen::CAM::GeometrySetList::Erase ( int  index)

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
void NXOpen::CAM::GeometrySetList::Erase ( int  index,
NXOpen::ObjectList::DeleteOption  deleteOption 
)

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
void NXOpen::CAM::GeometrySetList::Erase ( NXOpen::CAM::GeometrySet obj)

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
void NXOpen::CAM::GeometrySetList::Erase ( NXOpen::CAM::GeometrySet obj,
NXOpen::ObjectList::DeleteOption  deleteOption 
)

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
int NXOpen::CAM::GeometrySetList::FindIndex ( NXOpen::CAM::GeometrySet obj)

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
NXOpen::CAM::GeometrySet* NXOpen::CAM::GeometrySetList::FindItem ( int  index)

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
std::vector<NXOpen::CAM::GeometrySet *> NXOpen::CAM::GeometrySetList::GetContents ( )

Gets the contents of the entire list.

Returns
The list contents
Created in NX5.0.0.

License requirements : None
void NXOpen::CAM::GeometrySetList::Insert ( int  location,
NXOpen::CAM::GeometrySet object 
)

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
int NXOpen::CAM::GeometrySetList::Length ( )

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



License requirements : None

void NXOpen::CAM::GeometrySetList::SetContents ( const std::vector< NXOpen::CAM::GeometrySet * > &  objects)

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::CAM::GeometrySetList::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
void NXOpen::CAM::GeometrySetList::Swap ( NXOpen::CAM::GeometrySet object1,
NXOpen::CAM::GeometrySet object2 
)

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 2013 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.