NX Open C++ 参考指南 2406 v1.1
载入中...
搜索中...
未找到
NXOpen::ScCollectorList类 参考

智能收集器列表 更多...

#include <ScCollectorList.hxx>

类 NXOpen::ScCollectorList 继承关系图:
NXOpen::TaggedObject

Public 成员函数

void Append (const std::vector< NXOpen::ScCollector * > &objects)
void Append (NXOpen::ScCollector *object)
void Clear ()
void Clear (NXOpen::ObjectList::DeleteOption deleteOption)
void ClearIndex (int deleteIdx)
void Erase (int index)
void Erase (int index, NXOpen::ObjectList::DeleteOption deleteOption)
void Erase (NXOpen::ScCollector *obj)
void Erase (NXOpen::ScCollector *obj, NXOpen::ObjectList::DeleteOption deleteOption)
int FindIndex (NXOpen::ScCollector *obj)
NXOpen::ScCollectorFindItem (int index)
std::vector< NXOpen::ScCollector * > GetContents ()
void Insert (int location, NXOpen::ScCollector *object)
int Length ()
void MoveToBottom (int index)
void MoveToTop (int index)
void SetContents (const std::vector< NXOpen::ScCollector * > &objects)
void Swap (int index1, int index2)
void Swap (NXOpen::ScCollector *object1, NXOpen::ScCollector *object2)
Public 成员函数 继承自 NXOpen::TaggedObject
tag_t Tag () const

友元

class _ScCollectorListBuilder

详细描述

智能收集器列表

表示对象列表。
要创建此类的新实例,请使用 NXOpen::Part::CreateObjectList

创建于NX4.0.0。

成员函数说明

◆ Append() [1/2]

void NXOpen::ScCollectorList::Append ( const std::vector< NXOpen::ScCollector * > & objects)

向列表中追加一组对象
创建于NX4.0.0。

许可证要求: 无

参数
objects要追加的项

◆ Append() [2/2]

void NXOpen::ScCollectorList::Append ( NXOpen::ScCollector * object)

向列表中追加一个对象
创建于NX5.0.0。

许可证要求: 无

参数
object要追加的项

◆ Clear() [1/2]

void NXOpen::ScCollectorList::Clear ( )

清空整个列表,但不删除对象。调用者需自行管理这些对象。 若在部件关闭时这些对象未被使用或删除(即内存泄漏),将触发错误。
版本始于NX5.0.0。

许可要求:无

◆ Clear() [2/2]

void NXOpen::ScCollectorList::Clear ( NXOpen::ObjectList::DeleteOption deleteOption)

清空整个列表
版本始于NX5.0.0。

许可要求:无

参数
deleteOption移除对象时是否删除它们

◆ ClearIndex()

void NXOpen::ScCollectorList::ClearIndex ( int deleteIdx)

删除指定索引位置的项。列表大小不会改变,但该索引位置的项会被设为NULL。
创建于NX4.0.0。

许可证要求: 无

参数
deleteIdx要删除的项的索引

◆ Erase() [1/4]

void NXOpen::ScCollectorList::Erase ( int index)

从列表中移除对象,但不删除该对象。 列表会自动移位,移除位置不会留下空值。
创建于NX5.0.0。

许可证要求: 无

参数
index要从列表中移除的项的索引

◆ Erase() [2/4]

void NXOpen::ScCollectorList::Erase ( int index,
NXOpen::ObjectList::DeleteOption deleteOption )

从列表中删除指定位置的对象。 列表会自动移位,填补原对象位置的空缺。
版本始于NX5.0.0。

许可要求:无

参数
index要从列表中移除的项的索引
deleteOption是否删除该对象

◆ Erase() [3/4]

void NXOpen::ScCollectorList::Erase ( NXOpen::ScCollector * obj)

从列表中移除对象,但不删除该对象。 列表会自动移位,填补原对象位置的空缺。
版本始于NX5.0.0。

许可要求:无

参数
obj要从列表中移除的对象

◆ Erase() [4/4]

void NXOpen::ScCollectorList::Erase ( NXOpen::ScCollector * obj,
NXOpen::ObjectList::DeleteOption deleteOption )

从列表中移除对象。 列表会自动移位,填补原对象位置的空缺。
版本始于NX5.0.0。

许可要求:无

参数
obj要从列表中移除的对象
deleteOption是否删除该对象

◆ FindIndex()

int NXOpen::ScCollectorList::FindIndex ( NXOpen::ScCollector * obj)

查找输入对象在列表中的索引。若对象不存在,则返回-1。

返回
输入对象的索引,若不在列表中则返回-1
创建于NX4.0.0。

许可证要求: 无
参数
obj要查找索引的对象

◆ FindItem()

NXOpen::ScCollector * NXOpen::ScCollectorList::FindItem ( int index)

返回指定索引位置的对象,可能为NULL。

返回
在指定索引位置找到的对象
创建于NX4.0.0。

许可证要求: 无
参数
index要返回的对象的索引

◆ GetContents()

std::vector< NXOpen::ScCollector * > NXOpen::ScCollectorList::GetContents ( )

获取整个列表的内容

返回
列表内容
版本始于NX5.0.0。

许可要求:无

◆ Insert()

void NXOpen::ScCollectorList::Insert ( int location,
NXOpen::ScCollector * object )

在指定位置插入对象
版本始于NX5.0.0。

许可要求:无

参数
location插入对象的位置
object要插入的对象

◆ Length()

int NXOpen::ScCollectorList::Length ( )

返回列表的长度
创建于NX5.0.0。

许可证要求: 无

◆ MoveToBottom()

void NXOpen::ScCollectorList::MoveToBottom ( int index)

将指定位置的对象移至列表底部。
版本始于NX10.0.0。

许可要求:无

参数
index项的位置

◆ MoveToTop()

void NXOpen::ScCollectorList::MoveToTop ( int index)

将指定位置的对象移至列表顶部。
版本始于NX10.0.0。

许可要求:无

参数
index项的位置

◆ SetContents()

void NXOpen::ScCollectorList::SetContents ( const std::vector< NXOpen::ScCollector * > & objects)

设置整个列表的内容。此操作会覆盖列表原有内容, 但不会删除原列表中的任何对象。
版本始于NX5.0.0。

许可要求:无

参数
objects列表内容

◆ Swap() [1/2]

void NXOpen::ScCollectorList::Swap ( int index1,
int index2 )

交换列表中两个对象的位置。 第一个对象移至第二个对象的原位置, 第二个对象移至第一个对象的原位置。
版本始于NX5.0.0。

许可要求:无

参数
index1第一个项的位置
index2第二个项的位置

◆ Swap() [2/2]

void NXOpen::ScCollectorList::Swap ( NXOpen::ScCollector * object1,
NXOpen::ScCollector * object2 )

交换列表中两个对象的位置。 第一个对象移至第二个对象的原位置, 第二个对象移至第一个对象的原位置。
版本始于NX5.0.0。

许可要求:无

参数
object1第一个项
object2第二个项