NX Open C++ 参考指南 2406 v1.1
载入中...
搜索中...
未找到
Public 成员函数 | 友元 | 所有成员列表
NXOpen::ScCollector类 参考

智能收集器 更多...

#include <ScCollector.hxx>

类 NXOpen::ScCollector 继承关系图:
NXOpen::DisplayableObject NXOpen::NXObject NXOpen::IFitTo NXOpen::TaggedObject NXOpen::INXObject NXOpen::INXObject

Public 成员函数

void AddEvaluationFilter (NXOpen::ScEvaluationFiltertype filterType)
void AddRules (const std::vector< NXOpen::SelectionIntentRule * > &rules)
std::vector< NXOpen::TaggedObject * > AskRulesAndCollectedEntities (std::vector< NXOpen::SelectionIntentRule * > &rules, std::vector< int > &ruleObjectArrayCount)
NXOpen::ScCollector * CopyCollector ()
void Destroy ()
NXOpen::ScCollectorAllowTypes GetAllowedWireframeType ()
NXOpen::Features::CustomRule * GetCustomRule ()
bool GetMultiComponent ()
bool GetNonFeatureMode ()
std::vector< NXOpen::TaggedObject * > GetObjects ()
std::vector< NXOpen::TaggedObject * > GetObjectsSortedById ()
void GetRules (std::vector< NXOpen::SelectionIntentRule * > &rules)
bool IsEvaluationFilterEnabled (NXOpen::ScEvaluationFiltertype filterType)
void RemoveEvaluationFilter (NXOpen::ScEvaluationFiltertype filterType)
void RemoveMissingParents ()
void RemoveRule (int ruleIndex)
void RemoveRules (const std::vector< NXOpen::SelectionIntentRule * > &rules)
void ReplaceRules (const std::vector< NXOpen::SelectionIntentRule * > &rules, bool createRulesWoUpdate)
void ReplaceRules (const std::vector< NXOpen::SelectionIntentRule * > &rules, const std::vector< NXOpen::DisplayableObject * > &negatedEntities, bool createRulesWoUpdate)
void SetAllowedWireframeType (NXOpen::ScCollectorAllowTypes allowedEntityTypes)
void SetAllowRefCurves (bool allowRefCurves)
void SetInterpart (bool interpart)
void SetMultiComponent ()
void SetNonFeatureMode ()
Public 成员函数 继承自 NXOpen::DisplayableObject
void Blank ()
int Color ()
void Highlight ()
bool IsBlanked ()
int Layer ()
NXOpen::DisplayableObject::ObjectFont LineFont ()
NXOpen::DisplayableObject::ObjectWidth LineWidth ()
NXOpen::Point3d NameLocation ()
void RedisplayObject ()
void RemoveViewDependency ()
void SetColor (int color)
void SetLayer (int layer)
void SetLineFont (NXOpen::DisplayableObject::ObjectFont font)
void SetLineWidth (NXOpen::DisplayableObject::ObjectWidth width)
void SetNameLocation (const NXOpen::Point3d &location)
void Unblank ()
void Unhighlight ()
Public 成员函数 继承自 NXOpen::NXObject
NXOpen::AttributeIterator * CreateAttributeIterator ()
NX_DEPRECATED("Deprecated in NX8.0.0. Use DeleteUserAttribute instead.") void DeleteAttributeByTypeAndTitle(NXOpen void DeleteAttributeByTypeAndTitle (NXOpen::NXObject::AttributeType type, const char *title)
NX_DEPRECATED("Deprecated in NX8.0.0. Use DeleteUserAttribute instead.") void DeleteAttributeByTypeAndTitle(NXOpen void DeleteAttributeByTypeAndTitle (NXOpen::NXObject::AttributeType type, const char *title, NXOpen::Update::Option option)
void DeleteUserAttribute (NXOpen::NXObject::AttributeType type, const char *title, bool deleteEntireArray, NXOpen::Update::Option option)
void DeleteUserAttribute (NXOpen::NXObject::AttributeType type, const NXString &title, bool deleteEntireArray, NXOpen::Update::Option option)
void DeleteUserAttributes (NXOpen::AttributeIterator *iterator, NXOpen::Update::Option option)
void DeleteUserAttributes (NXOpen::NXObject::AttributeType type, NXOpen::Update::Option option)
virtual NXOpen::INXObject * FindObject (const char *journalIdentifier)
virtual NXOpen::INXObject * FindObject (const NXString &journalIdentifier)
bool GetBooleanUserAttribute (const char *title, int index)
bool GetBooleanUserAttribute (const NXString &title, int index)
NXOpen::NXObject::ComputationalTime GetComputationalTimeUserAttribute (const char *title, int index)
NXOpen::NXObject::ComputationalTime GetComputationalTimeUserAttribute (const NXString &title, int index)
int GetIntegerAttribute (const char *title)
int GetIntegerUserAttribute (const char *title, int index)
int GetIntegerUserAttribute (const NXString &title, int index)
bool GetNextUserAttribute (NXOpen::AttributeIterator *iterator, NXOpen::NXObject::AttributeInformation *info)
NXString GetPdmReferenceAttributeValue (const char *attributeTitle)
 获取指定对象的PDM参考属性值。 用户需提供属性标题，将返回UI显示的属性值。
NXString GetPdmReferenceAttributeValue (const NXString &attributeTitle)
 获取指定对象的PDM参考属性值。 用户需提供属性标题，将返回UI显示的属性值。
double GetRealAttribute (const char *title)
double GetRealUserAttribute (const char *title, int index)
double GetRealUserAttribute (const NXString &title, int index)
NXString GetReferenceAttribute (const char *title)
NXString GetStringAttribute (const char *title)
NXString GetStringUserAttribute (const char *title, int index)
NXString GetStringUserAttribute (const NXString &title, int index)
NX_DEPRECATED("Deprecated in NX8.0.0. Use GetUserAttribute instead.") NXString GetTimeAttribute(NXOpen NXString GetTimeAttribute (NXOpen::NXObject::DateAndTimeFormat format, const char *title)
NXString GetTimeUserAttribute (const char *title, int index)
NXString GetTimeUserAttribute (const NXString &title, int index)
NX_DEPRECATED("Deprecated in NX11.0.0. Use GetUserAttribute instead.") std std::vector< NXOpen::NXObject::AttributeInformation > GetUserAttribute (const char *title, bool includeUnset, bool addStringValues, NXOpen::NXObject::AttributeType type)
NXOpen::NXObject::AttributeInformation GetUserAttribute (const char *title, NXOpen::NXObject::AttributeType type, int index)
NXOpen::NXObject::AttributeInformation GetUserAttribute (const NXString &title, NXOpen::NXObject::AttributeType type, int index)
NXString GetUserAttributeAsString (const char *title, NXOpen::NXObject::AttributeType type, int index)
NXString GetUserAttributeAsString (const NXString &title, NXOpen::NXObject::AttributeType type, int index)
int GetUserAttributeCount (NXOpen::AttributeIterator *iterator)
int GetUserAttributeCount (NXOpen::AttributeIterator *iterator, bool countArrayAsOneAttribute)
int GetUserAttributeCount (NXOpen::NXObject::AttributeType type)
int GetUserAttributeCount (NXOpen::NXObject::AttributeType type, bool includeUnset, bool countArrayAsOneAttribute)
bool GetUserAttributeLock (const char *title, NXOpen::NXObject::AttributeType type)
bool GetUserAttributeLock (const NXString &title, NXOpen::NXObject::AttributeType type)
std::vector< NXOpen::NXObject::AttributeInformation > GetUserAttributes ()
std::vector< NXOpen::NXObject::AttributeInformation > GetUserAttributes (bool includeUnset)
std::vector< NXOpen::NXObject::AttributeInformation > GetUserAttributes (NXOpen::AttributeIterator *iterator)
int GetUserAttributeSize (const char *title, NXOpen::NXObject::AttributeType type)
int GetUserAttributeSize (const NXString &title, NXOpen::NXObject::AttributeType type)
std::vector< NXOpen::NXObject * > GetUserAttributeSourceObjects ()
bool HasUserAttribute (const char *title, NXOpen::NXObject::AttributeType type, int index)
bool HasUserAttribute (const NXString &title, NXOpen::NXObject::AttributeType type, int index)
bool HasUserAttribute (NXOpen::AttributeIterator *iterator)
virtual bool IsOccurrence ()
virtual NXString JournalIdentifier ()
virtual NXString Name ()
 NX_DEPRECATED ("Deprecated in NX8.0.0. Use GetUserAttribute instead.") double GetRealAttribute(const NXString &title)
 NX_DEPRECATED ("Deprecated in NX8.0.0. Use GetUserAttribute instead.") int GetIntegerAttribute(const NXString &title)
 NX_DEPRECATED ("Deprecated in NX8.0.0. Use GetUserAttribute instead.") NXString GetReferenceAttribute(const NXString &title)
 NX_DEPRECATED ("Deprecated in NX8.0.0. Use GetUserAttribute instead.") NXString GetStringAttribute(const NXString &title)
 NX_DEPRECATED ("Deprecated in NX8.0.0. Use SetUserAttribute instead.") void SetAttribute(const NXString &title
 NX_DEPRECATED ("Deprecated in NX8.0.0. Use SetUserAttribute instead.") void SetAttribute(const NXString &title
 NX_DEPRECATED ("Deprecated in NX8.0.0. Use SetUserAttribute instead.") void SetAttribute(const NXString &title
 NX_DEPRECATED ("Deprecated in NX8.0.0. Use SetUserAttribute instead.") void SetAttribute(const NXString &title
 NX_DEPRECATED ("Deprecated in NX8.0.0. Use SetUserAttribute instead.") void SetAttribute(const NXString &title
 NX_DEPRECATED ("Deprecated in NX8.0.0. Use SetUserAttribute instead.") void SetAttribute(const NXString &title
 NX_DEPRECATED ("Deprecated in NX8.0.0. Use SetUserAttribute instead.") void SetAttribute(const NXString &title
 NX_DEPRECATED ("Deprecated in NX8.0.0. Use SetUserAttribute instead.") void SetAttribute(const NXString &title)
 NX_DEPRECATED ("Deprecated in NX8.0.0. Use SetUserAttribute instead.") void SetReferenceAttribute(const NXString &title
 NX_DEPRECATED ("Deprecated in NX8.0.0. Use SetUserAttribute instead.") void SetReferenceAttribute(const NXString &title
 NX_DEPRECATED ("Deprecated in NX8.0.0. Use SetUserAttribute instead.") void SetTimeAttribute(const NXString &title
 NX_DEPRECATED ("Deprecated in NX8.0.0. Use SetUserAttribute instead.") void SetTimeAttribute(const NXString &title
virtual NXOpen::Assemblies::Component * OwningComponent ()
virtual NXOpen::BasePart * OwningPart ()
virtual void Print ()
virtual NXOpen::INXObject * Prototype ()
void SetAttribute (const char *title)
void SetAttribute (const char *title, const char *value)
void SetAttribute (const char *title, const char *value, NXOpen::Update::Option option)
void SetAttribute (const char *title, double value)
void SetAttribute (const char *title, double value, NXOpen::Update::Option option)
void SetAttribute (const char *title, int value)
void SetAttribute (const char *title, int value, NXOpen::Update::Option option)
void SetAttribute (const char *title, NXOpen::Update::Option option)
void SetBooleanUserAttribute (const char *title, int index, bool value, NXOpen::Update::Option option)
void SetBooleanUserAttribute (const NXString &title, int index, bool value, NXOpen::Update::Option option)
virtual void SetName (const char *name)
virtual void SetName (const NXString &name)
void SetPdmReferenceAttribute (const char *attributeTitle, const char *attributeValue)
 设置对象的PDM参考属性值。 用户需提供属性标题和UI显示的别名值。若参考属性为数组类型，此操作将被忽略。 别名字符串会转换为内部值（如会话标识符），并将该内部值设置到指定对象上。
创建于NX12.0.0。

许可要求：无
void SetPdmReferenceAttribute (const NXString &attributeTitle, const NXString &attributeValue)
 设置对象的PDM参考属性值。 用户需提供属性标题和UI显示的别名值。若参考属性为数组类型，此操作将被忽略。 别名字符串会转换为内部值（如会话标识符），并将该内部值设置到指定对象上。
创建于NX12.0.0。

许可要求：无
void SetReferenceAttribute (const char *title, const char *value)
void SetReferenceAttribute (const char *title, const char *value, NXOpen::Update::Option option)
void SetTimeAttribute (const char *title, const char *value)
void SetTimeAttribute (const char *title, const char *value, NXOpen::Update::Option option)
void SetTimeUserAttribute (const char *title, int index, const char *value, NXOpen::Update::Option option)
void SetTimeUserAttribute (const char *title, int index, const NXOpen::NXObject::ComputationalTime &value, NXOpen::Update::Option option)
void SetTimeUserAttribute (const NXString &title, int index, const NXOpen::NXObject::ComputationalTime &value, NXOpen::Update::Option option)
void SetTimeUserAttribute (const NXString &title, int index, const NXString &value, NXOpen::Update::Option option)
void SetUserAttribute (const char *title, int index, const char *value, NXOpen::Update::Option option)
void SetUserAttribute (const char *title, int index, double value, NXOpen::Update::Option option)
void SetUserAttribute (const char *title, int index, int value, NXOpen::Update::Option option)
void SetUserAttribute (const char *title, int index, NXOpen::Update::Option option)
void SetUserAttribute (const NXOpen::NXObject::AttributeInformation &info, NXOpen::Update::Option option)
void SetUserAttribute (const NXString &title, int index, const NXString &value, NXOpen::Update::Option option)
void SetUserAttribute (const NXString &title, int index, double value, NXOpen::Update::Option option)
void SetUserAttribute (const NXString &title, int index, int value, NXOpen::Update::Option option)
void SetUserAttribute (const NXString &title, int index, NXOpen::Update::Option option)
void SetUserAttributeLock (const char *title, NXOpen::NXObject::AttributeType type, bool lock)
void SetUserAttributeLock (const NXString &title, NXOpen::NXObject::AttributeType type, bool lock)
Public 成员函数 继承自 NXOpen::TaggedObject
tag_t Tag () const

友元

class _ScCollectorBuilder

额外继承的成员函数

Public 类型 继承自 NXOpen::DisplayableObject
enum  ObjectFont {
  ObjectFontSolid = 1 , ObjectFontDashed , ObjectFontPhantom , ObjectFontCenterline ,
  ObjectFontDotted , ObjectFontLongDashed , ObjectFontDottedDashed , ObjectFontEight = 11 ,
  ObjectFontNine , ObjectFontTen , ObjectFontEleven
}
enum  ObjectWidth {
  ObjectWidthNormal , ObjectWidthThick , ObjectWidthThin , ObjectWidthOne = 5 ,
  ObjectWidthTwo , ObjectWidthThree , ObjectWidthFour , ObjectWidthFive ,
  ObjectWidthSix , ObjectWidthSeven , ObjectWidthEight , ObjectWidthNine
}
Public 类型 继承自 NXOpen::NXObject
enum  AttributeType {
  AttributeTypeInvalid , AttributeTypeNull , AttributeTypeBoolean , AttributeTypeInteger ,
  AttributeTypeReal , AttributeTypeString , AttributeTypeTime , AttributeTypeReference ,
  AttributeTypeAny = 100
}
enum  DateAndTimeFormat { DateAndTimeFormatNumeric , DateAndTimeFormatTextual }
Public 属性 继承自 NXOpen::NXObject
NXOpen::Update::Option option
const NXString NXOpen::Update::Option option
double NXOpen::Update::Option option
int NXOpen::Update::Option option
const NXString & value
double value
int value

详细描述

智能收集器

表示一个收集器
ScCollector可收集面、体、边、曲线或这些实体的混合集合。 集合由选择意图规则定义。有关可用选择意图规则的更多详细信息，请参考ScRuleFactory 的文档。 ScRuleFactory .

要创建此类的新实例，请使用NXOpen::ScCollectorCollection::CreateCollector

NX4.0.0版本中创建。

成员函数说明

◆ AddEvaluationFilter()

void NXOpen::ScCollector::AddEvaluationFilter ( NXOpen::ScEvaluationFiltertype filterType)

为Sc收集器设置评估过滤器
版本：NX11.0.0
许可要求：无

参数
filterType枚举值

◆ AddRules()

void NXOpen::ScCollector::AddRules ( const std::vector< NXOpen::SelectionIntentRule * > & rules)

向收集器添加规则
版本：NX2312.0.0
许可要求：无

参数
rules要添加的选择意图规则

◆ AskRulesAndCollectedEntities()

std::vector< NXOpen::TaggedObject * > NXOpen::ScCollector::AskRulesAndCollectedEntities ( std::vector< NXOpen::SelectionIntentRule * > & rules,
std::vector< int > & ruleObjectArrayCount )

返回收集器的规则以及规则收集到的实体
版本：NX2312.0.0
许可要求：无

参数
rules选择意图规则
ruleObjectArrayCount规则对象数组数量

◆ CopyCollector()

NXOpen::ScCollector * NXOpen::ScCollector::CopyCollector ( )

复制选择集对象
版本：NX8.0.0

许可要求：无

◆ Destroy()

void NXOpen::ScCollector::Destroy ( )

销毁ScCollector对象
版本：NX5.0.0

许可要求：无

◆ GetAllowedWireframeType()

NXOpen::ScCollectorAllowTypes NXOpen::ScCollector::GetAllowedWireframeType ( )

获取曲线收集器允许的线框类型（曲线、点或两者都允许）

返回
允许的实体类型
版本：NX1847.0.0
许可要求：无

◆ GetCustomRule()

NXOpen::Features::CustomRule * NXOpen::ScCollector::GetCustomRule ( )

从收集器中获取自定义规则

返回

版本：NX1980.0.0
许可要求：无

◆ GetMultiComponent()

bool NXOpen::ScCollector::GetMultiComponent ( )

获取ScCollector上的多组件选择状态
多组件ScCollector可从多个组件中选择对象，即多个部件、同一部件的多个实例或两者皆有。

返回
ScCollector上设置的多组件选项状态
版本：NX9.0.0

许可要求：无

◆ GetNonFeatureMode()

bool NXOpen::ScCollector::GetNonFeatureMode ( )

获取ScCollector上的非特征模式状态
处于非特征模式的ScCollector不会引用选择对象所属部件的特征数据。

返回
ScCollector上设置的非特征模式状态
版本：NX9.0.0

许可要求：无

◆ GetObjects()

std::vector< NXOpen::TaggedObject * > NXOpen::ScCollector::GetObjects ( )

获取选择集的内容。

返回
选择集对象列表
版本：NX6.0.0

许可要求：无

◆ GetObjectsSortedById()

std::vector< NXOpen::TaggedObject * > NXOpen::ScCollector::GetObjectsSortedById ( )

获取收集器中已排序的内容。

返回

版本：NX11.0.0
许可要求：无

◆ GetRules()

void NXOpen::ScCollector::GetRules ( std::vector< NXOpen::SelectionIntentRule * > & rules)

获取选择集的规则
版本：NX6.0.0

许可要求：无

参数
rules选择意图规则

◆ IsEvaluationFilterEnabled()

bool NXOpen::ScCollector::IsEvaluationFilterEnabled ( NXOpen::ScEvaluationFiltertype filterType)

检查Sc收集器上是否存在指定评估过滤器
版本：NX11.0.0
许可要求：无

参数
filterType枚举值

◆ RemoveEvaluationFilter()

void NXOpen::ScCollector::RemoveEvaluationFilter ( NXOpen::ScEvaluationFiltertype filterType)

移除Sc收集器上的评估过滤器
版本：NX11.0.0
许可要求：无

参数
filterType枚举值

◆ RemoveMissingParents()

void NXOpen::ScCollector::RemoveMissingParents ( )

从收集器中删除缺失父对象的引用
版本：NX1847.0.0
许可要求：无

◆ RemoveRule()

void NXOpen::ScCollector::RemoveRule ( int ruleIndex)

删除选择集规则
版本：NX7.0.0

许可要求：无

参数
ruleIndex要删除的规则索引（从0开始）

◆ RemoveRules()

void NXOpen::ScCollector::RemoveRules ( const std::vector< NXOpen::SelectionIntentRule * > & rules)

删除选择集规则
版本：NX8.0.0

许可要求：无

参数
rules要删除的选择意图规则

◆ ReplaceRules() [1/2]

void NXOpen::ScCollector::ReplaceRules ( const std::vector< NXOpen::SelectionIntentRule * > & rules,
bool createRulesWoUpdate )

替换收集器规则。
NX4.0.0版本中创建。

许可要求：gateway ("UG GATEWAY")

参数
rules选择意图规则。有关创建选择意图规则的信息，请参考 ScRuleFactory 的文档获取更多详细信息。
createRulesWoUpdate标识是否应在不更新的情况下创建规则

◆ ReplaceRules() [2/2]

void NXOpen::ScCollector::ReplaceRules ( const std::vector< NXOpen::SelectionIntentRule * > & rules,
const std::vector< NXOpen::DisplayableObject * > & negatedEntities,
bool createRulesWoUpdate )

替换收集器规则并指定排除实体。
NX5.0.0版本中创建。

许可要求：gateway ("UG GATEWAY")

参数
rules选择意图规则。有关创建选择意图规则的信息，请参考 ScRuleFactory 的文档获取更多详细信息。
negatedEntities需从收集器中排除的规则内实体。
createRulesWoUpdate标识是否应在不更新的情况下创建规则

◆ SetAllowedWireframeType()

void NXOpen::ScCollector::SetAllowedWireframeType ( NXOpen::ScCollectorAllowTypes allowedEntityTypes)

设置曲线收集器允许的线框类型（曲线、点或两者都允许）
版本：NX1847.0.0
许可要求：无

参数
allowedEntityTypes允许的实体类型

◆ SetAllowRefCurves()

void NXOpen::ScCollector::SetAllowRefCurves ( bool allowRefCurves)

设置Sc收集器是否允许参考曲线
版本：NX11.0.2
许可要求：无

参数
allowRefCurves设为true则允许Sc收集器包含参考曲线

◆ SetInterpart()

void NXOpen::ScCollector::SetInterpart ( bool interpart)

设置跨部件状态
此函数设置ScCollector的跨部件标志。在以下情况下设置该选项会报错： (1) ScCollector为空。 (2) ScCollector对象不属于SC_collector类。 (3) ScCollector为混合部件选项。 (4) ScCollector已设置多组件选项。

版本：NX6.0.0

许可要求：无

参数
interpart设为true将选择集设置为跨部件

◆ SetMultiComponent()

void NXOpen::ScCollector::SetMultiComponent ( )

将ScCollector设置为多组件选择模式
多组件ScCollector可从多个组件中选择对象，即多个部件、同一部件的多个实例或两者皆有。 仅当需要此类选择时使用此方法。 以下情况下设置该选项会报错： (1) ScCollector已设置跨部件选项。

版本：NX9.0.0

许可要求：无

◆ SetNonFeatureMode()

void NXOpen::ScCollector::SetNonFeatureMode ( )

将ScCollector设置为非特征模式
处于非特征模式的ScCollector不会引用选择对象所属部件的特征数据。 仅可对空的ScCollector设置该选项。 对非空ScCollector设置该选项时，以下情况会报错： (1) ScCollector正在引用特征数据，却将非特征模式设为true。 (2) ScCollector未引用特征数据，却将非特征模式设为false。

版本：NX9.0.0

许可要求：无