|
NX Open C++ 参考指南 2406 v1.1
|
自定义管理器 更多...
#include <RoutingCommon_CustomManager.hxx>
自定义管理器
布线自定义管理器允许通过添加插件和设计规则,自定义布线系统设计器(RSD)应用程序。
要获取此类实例,请参考 NXOpen::Session
在NX1980.0.0版本创建。
| typedef NXOpen::Callback1<NXString, NXOpen::Assemblies::Component *> NXOpen::RoutingCommon::CustomManager::CablewayAreaNamePlugin |
定义Cableway区域名称插件的原型。 输入组件对象时,插件需返回该组件及其子组件在Cableway导出时使用的区域名称。
在NX1980.0.0版本创建。
许可要求:routing_cabling("线缆布线")
| typedef NXOpen::Callback1<NXString, NXOpen::Assemblies::Component *> NXOpen::RoutingCommon::CustomManager::CablewayDeviceIdentifierPlugin |
定义Cableway设备标识符插件的原型。 输入组件对象时,插件需返回该组件在XML文件中对应的设备标识符。 若组件无需导出到XML文件,返回NULL即可。
在NX1980.0.0版本创建。
许可要求:routing_cabling("线缆布线")
| typedef NXOpen::Callback1<void, NXString> NXOpen::RoutingCommon::CustomManager::CablewayPostExportPlugin |
定义Cableway导出后插件的原型。
在NX1980.0.0版本创建。
许可要求:routing_cabling("线缆布线")
| typedef NXOpen::Callback1<void, NXString> NXOpen::RoutingCommon::CustomManager::CablewayPreExportPlugin |
定义Cableway导出前插件的原型。
在NX1980.0.0版本创建。
许可要求:routing_cabling("线缆布线")
| typedef NXOpen::Callback3<NXString, NXString, NXOpen::Assemblies::Component *, NXOpen::NXObject *> NXOpen::RoutingCommon::CustomManager::CablewayUniqueNodeNamePlugin |
定义Cableway唯一节点名称插件的原型。 节点对象名称可能已设置唯一ID,插件需自行检查现有唯一ID并决定是否复用。 注意:插件需自行保证返回值的唯一性,布线模块不会对返回值的唯一性进行校验。
在NX1980.0.0版本创建。
许可要求:routing_cabling("线缆布线")
| typedef NXOpen::Callback3<NXString, NXString, NXOpen::Assemblies::Component *, NXOpen::NXObject *> NXOpen::RoutingCommon::CustomManager::CablewayUniqueSegmentNamePlugin |
定义Cableway唯一管段名称插件的原型。输入对象可为布线管段、曲线或吊架组件, 吊架组件以零长度管段形式存在,因此也需要唯一管段ID。 管段对象名称可能已设置唯一ID,插件需自行检查现有唯一ID并决定是否复用。 注意:插件需自行保证返回值的唯一性,布线模块不会对返回值的唯一性进行校验。
在NX1980.0.0版本创建。
许可要求:routing_cabling("线缆布线")
定义Cableway XML文件名插件的原型。
在NX1980.0.0版本创建。
许可要求:routing_cabling("线缆布线")
| typedef NXOpen::Callback1<void, NXOpen::Routing::ComponentNamePluginData *> NXOpen::RoutingCommon::CustomManager::ComponentNamePlugin |
定义布线模块创建新组件时使用的组件名称插件原型。 插件需填充 Routing::ComponentNamePluginData 对象的相关信息。
在NX1980.0.0版本创建。
许可要求:routing_base("基础布线")
| typedef NXOpen::Callback2<void, NXOpen::Routing::CustomManager::DesignRuleReason, std::vector<NXOpen::NXObject *> > NXOpen::RoutingCommon::CustomManager::DesignRule |
定义所有布线设计规则的原型。
在NX1980.0.0版本创建。
许可要求:routing_advanced("高级布线"), routing_base("基础布线")
| typedef NXOpen::Callback1<void, NXOpen::RoutingCommon::CustomManager::Application> NXOpen::RoutingCommon::CustomManager::RSDApplicationEnterPlugin |
定义进入布线系统设计器(RSD)应用程序时调用的插件原型。 插件会接收当前进入的应用类型,可选值为 NXOpen::RoutingCommon::CustomManager::Application::Electrical 或 NXOpen::RoutingCommon::CustomManager::Application::Mechanical。
在NX1980.0.0版本创建。
许可要求:routing_base("基础布线")
| typedef NXOpen::Callback1<void, NXOpen::RoutingCommon::CustomManager::Application> NXOpen::RoutingCommon::CustomManager::RSDApplicationExitPlugin |
定义退出布线系统设计器(RSD)应用程序时调用的插件原型。 插件会接收当前退出的应用类型,可选值为 NXOpen::RoutingCommon::CustomManager::Application::Electrical 或 NXOpen::RoutingCommon::CustomManager::Application::Mechanical。
在NX1980.0.0版本创建。
许可要求:routing_base("基础布线")
| typedef NXOpen::Callback2<void, std::vector<NXOpen::Assemblies::Component *>, NXOpen::Routing::AssemblyNamePluginData *> NXOpen::RoutingCommon::CustomManager::SpoolAssemblyNamePlugin |
定义管段装配名称插件的原型。 插件需自行保证管段装配名称的唯一性。
在NX2406.0.0版本创建。
许可要求:routing_base("基础布线")
| typedef NXOpen::Callback2<NXString, NXOpen::Part *, std::vector<NXOpen::Assemblies::Component *> > NXOpen::RoutingCommon::CustomManager::SpoolNamePlugin |
定义管段名称插件的原型。 插件需自行保证管段名称的唯一性。
在NX2312.0.0版本创建。
许可要求:routing_base("基础布线")
| int NXOpen::RoutingCommon::CustomManager::AddDesignRule | ( | NXOpen::Routing::CustomManager::DesignRuleReason | reason, |
| const char * | name, | ||
| const char * | description, | ||
| const NXOpen::RoutingCommon::CustomManager::DesignRule & | designRuleMethod ) |
添加指定触发原因的设计规则。 注意:可为同一原因注册多个设计规则。
| reason | 触发此设计规则的原因。 |
| name | 设计规则的描述性名称。 |
| description | 设计规则检查内容的详细说明。 |
| designRuleMethod | 要调用的方法。 |
| int NXOpen::RoutingCommon::CustomManager::AddDesignRule | ( | NXOpen::Routing::CustomManager::DesignRuleReason | reason, |
| const NXString & | name, | ||
| const NXString & | description, | ||
| const NXOpen::RoutingCommon::CustomManager::DesignRule & | designRuleMethod ) |
添加指定触发原因的设计规则。 注意:可为同一原因注册多个设计规则。
| reason | 触发此设计规则的原因。 |
| name | 设计规则的描述性名称。 |
| description | 设计规则检查内容的详细说明。 |
| designRuleMethod | 要调用的方法。 |
| NXOpen::Routing::DesignRuleViolation * NXOpen::RoutingCommon::CustomManager::CreateViolationForReason | ( | const char * | designRuleName, |
| NXOpen::Routing::CustomManager::DesignRuleReason | reason, | ||
| const char * | shortDescription, | ||
| const char * | longDescription, | ||
| const std::vector< NXOpen::NXObject * > & | objects ) |
为指定原因创建新的设计规则违规项。
| designRuleName | 要创建违规项的设计规则。 |
| reason | 触发违规项的原因。 |
| shortDescription | 违规项的简短描述,显示在设计规则违规对话框中。 |
| longDescription | 违规项的详细描述,点击设计规则违规对话框的"完整违规文本"按钮显示。 |
| objects | 违规对象。 |
| NXOpen::Routing::DesignRuleViolation * NXOpen::RoutingCommon::CustomManager::CreateViolationForReason | ( | const NXString & | designRuleName, |
| NXOpen::Routing::CustomManager::DesignRuleReason | reason, | ||
| const NXString & | shortDescription, | ||
| const NXString & | longDescription, | ||
| const std::vector< NXOpen::NXObject * > & | objects ) |
为指定原因创建新的设计规则违规项。
| designRuleName | 要创建违规项的设计规则。 |
| reason | 触发违规项的原因。 |
| shortDescription | 违规项的简短描述,显示在设计规则违规对话框中。 |
| longDescription | 违规项的详细描述,点击设计规则违规对话框的"完整违规文本"按钮显示。 |
| objects | 违规对象。 |
| void NXOpen::RoutingCommon::CustomManager::DeleteViolationsOfRuleOnObject | ( | const char * | designRuleName, |
| NXOpen::NXObject * | nxObject ) |
查找并删除指定对象上关联的、对应指定设计规则的违规记录。 适用于对象不再违反该规则的场景。 删除违规记录后此方法会调用更新。
版本:NX1980.0.0
许可要求:routing_advanced("管路设计高级"), routing_base("管路设计基础")
| designRuleName | 要删除违规记录对应的设计规则名称 |
| nxObject | 要删除违规记录的对象 |
| void NXOpen::RoutingCommon::CustomManager::DeleteViolationsOfRuleOnObject | ( | const NXString & | designRuleName, |
| NXOpen::NXObject * | nxObject ) |
查找并删除指定对象上关联的、对应指定设计规则的违规记录。 适用于对象不再违反该规则的场景。 删除违规记录后此方法会调用更新。
版本:NX1980.0.0
许可要求:routing_advanced("管路设计高级"), routing_base("管路设计基础")
| designRuleName | 要删除违规记录对应的设计规则名称 |
| nxObject | 要删除违规记录的对象 |
| void NXOpen::RoutingCommon::CustomManager::DeleteViolationsOnObjectForReason | ( | NXOpen::Routing::CustomManager::DesignRuleReason | reason, |
| NXOpen::NXObject * | nxObject ) |
查找并删除指定对象上关联的、对应指定原因的设计规则违规记录。 适用于对象不再违反该规则的场景。 删除违规记录后此方法会调用更新。
版本:NX1980.0.0
许可要求:routing_advanced("管路设计高级"), routing_base("管路设计基础")
| reason | 要删除违规记录对应的原因 |
| nxObject | 要删除违规记录的对象 |
| void NXOpen::RoutingCommon::CustomManager::GetDesignRulesRegisteredForReason | ( | NXOpen::Routing::CustomManager::DesignRuleReason | reason, |
| std::vector< int > & | registeredDesignRuleIds ) |
返回为指定原因注册的所有设计规则(如果有)。
版本:NX1980.0.0。
许可要求:routing_advanced("管路设计高级版"), routing_base("管路设计基础版")
| reason | 要获取设计规则列表的对应原因。 |
| registeredDesignRuleIds | 为此原因注册的设计规则标识符(如果有)。 |
| std::vector< NXOpen::Routing::DesignRuleViolation * > NXOpen::RoutingCommon::CustomManager::GetViolationsForReason | ( | NXOpen::Routing::CustomManager::DesignRuleReason | reason | ) |
返回指定原因下记录的所有违规项。
| reason | 要获取违规项列表的对应原因。 |
| std::vector< NXOpen::Routing::DesignRuleViolation * > NXOpen::RoutingCommon::CustomManager::GetViolationsOfRule | ( | const char * | designRuleName | ) |
返回指定设计规则下记录的所有违规项。
| designRuleName | 要获取违规项列表的设计规则。 |
| std::vector< NXOpen::Routing::DesignRuleViolation * > NXOpen::RoutingCommon::CustomManager::GetViolationsOfRule | ( | const NXString & | designRuleName | ) |
返回指定设计规则下记录的所有违规项。
| designRuleName | 要获取违规项列表的设计规则。 |
| void NXOpen::RoutingCommon::CustomManager::RemoveAllDesignRules | ( | ) |
移除所有已注册的设计规则,应用视图文件中配置的规则除外。
版本:NX1980.0.0。
许可要求:routing_advanced("管路设计高级版"), routing_base("管路设计基础版")
| void NXOpen::RoutingCommon::CustomManager::RemoveAllDesignRulesForReason | ( | NXOpen::Routing::CustomManager::DesignRuleReason | reason | ) |
移除为指定原因注册的所有设计规则。
版本:NX1980.0.0。
许可要求:routing_advanced("管路设计高级版"), routing_base("管路设计基础版")
| reason | 要移除对应所有设计规则的原因。 |
| void NXOpen::RoutingCommon::CustomManager::RemoveAllPlugins | ( | ) |
移除所有已注册的插件。
版本:NX1980.0.0
许可要求:routing_base("管路设计基础")
| void NXOpen::RoutingCommon::CustomManager::RemoveCablewayAreaNamePlugin | ( | ) |
移除已注册的索道区域名称插件。
创建于NX1980.0.0.
许可证要求: routing_cabling ("Routing Cabling")
| void NXOpen::RoutingCommon::CustomManager::RemoveCablewayDeviceIdentifierPlugin | ( | ) |
移除已注册的索道设备识别插件。
创建于NX1980.0.0.
许可证要求: routing_cabling ("Routing Cabling")
| void NXOpen::RoutingCommon::CustomManager::RemoveCablewayPostExportPlugin | ( | ) |
移除已注册的索道后导出插件。
创建于NX1980.0.0.
许可证要求: routing_cabling ("Routing Cabling")
| void NXOpen::RoutingCommon::CustomManager::RemoveCablewayPreExportPlugin | ( | ) |
移除已注册的索道预导出插件。
创建于NX1980.0.0.
许可证要求: routing_cabling ("Routing Cabling")
| void NXOpen::RoutingCommon::CustomManager::RemoveCablewayUniqueNodeNamePlugin | ( | ) |
移除已注册的电缆槽节点唯一名称插件。
版本:NX1980.0.0
许可要求:routing_cabling("电缆布线设计")
| void NXOpen::RoutingCommon::CustomManager::RemoveCablewayUniqueSegmentNamePlugin | ( | ) |
移除已注册的索道分段唯一名称插件。
创建于NX1980.0.0.
许可证要求: routing_cabling ("Routing Cabling")
| void NXOpen::RoutingCommon::CustomManager::RemoveCablewayXmlFileNamePlugin | ( | ) |
移除已注册的电缆槽XML文件名插件。
版本:NX1980.0.0
许可要求:routing_cabling("电缆布线设计")
| void NXOpen::RoutingCommon::CustomManager::RemoveDesignRule | ( | int | designRuleMethodId | ) |
移除已注册的设计规则。
版本:NX1980.0.0。
许可要求:routing_advanced("管路设计高级版"), routing_base("管路设计基础版")
| designRuleMethodId | 要移除的设计规则的标识符。 |
| void NXOpen::RoutingCommon::CustomManager::RemoveRSDApplicationEnterPlugin | ( | ) |
移除已注册的应用进入插件。
版本:NX1980.0.0
许可要求:routing_base("管路设计基础")
| void NXOpen::RoutingCommon::CustomManager::RemoveRSDApplicationExitPlugin | ( | ) |
移除已注册的应用退出插件。
版本:NX1980.0.0
许可要求:routing_base("管路设计基础")
| void NXOpen::RoutingCommon::CustomManager::RemoveSpoolAssemblyNamePlugin | ( | ) |
移除已注册的管段装配名称插件。
创建于NX2406.0.0。
许可证要求: routing_base ("Routing Basic")
| void NXOpen::RoutingCommon::CustomManager::RemoveSpoolNamePlugin | ( | ) |
移除已注册的线轴名称插件。
创建于NX2312.0.0.
许可证要求: routing_base ("Routing Basic")
| void NXOpen::RoutingCommon::CustomManager::RemoveWiringComponentNamePlugin | ( | ) |
移除已注册的布线部件名称插件,但保留应用视图文件中配置的插件。
创建于NX1980.0.0.
许可证要求: routing_base ("Routing Basic")
| void NXOpen::RoutingCommon::CustomManager::SetCablewayAreaNamePlugin | ( | const NXOpen::RoutingCommon::CustomManager::CablewayAreaNamePlugin & | cablewayAreaNamePlugin | ) |
设置Routing将调用的插件,用于确定区域名称。
创建于NX1980.0.0.
许可证要求: routing_cabling ("Routing Cabling")
| cablewayAreaNamePlugin | 希望Routing调用的方法,用于确定区域名称。 |
| void NXOpen::RoutingCommon::CustomManager::SetCablewayDeviceIdentifierPlugin | ( | const NXOpen::RoutingCommon::CustomManager::CablewayDeviceIdentifierPlugin & | cablewayDeviceIdentifierPlugin | ) |
设置在索道导出期间Routing将调用的插件,用于判断设备部件是否应包含在索道导出中。
创建于NX1980.0.0.
许可证要求: routing_cabling ("Routing Cabling")
| cablewayDeviceIdentifierPlugin | 希望Routing调用的方法,用于判断设备部件是否应包含在索道导出中。 |
| void NXOpen::RoutingCommon::CustomManager::SetCablewayPostExportPlugin | ( | const NXOpen::RoutingCommon::CustomManager::CablewayPostExportPlugin & | cablewayPostExportPlugin | ) |
设置Routing在索道导出完成后将调用的插件。
创建于NX1980.0.0.
许可证要求: routing_cabling ("Routing Cabling")
| cablewayPostExportPlugin | 希望Routing在导出索道XML文件后调用的方法。 |
| void NXOpen::RoutingCommon::CustomManager::SetCablewayPreExportPlugin | ( | const NXOpen::RoutingCommon::CustomManager::CablewayPreExportPlugin & | cablewayPreExportPlugin | ) |
设置Routing在索道预导出后将调用的插件。
创建于NX1980.0.0.
许可证要求: routing_cabling ("Routing Cabling")
| cablewayPreExportPlugin | 希望Routing在导出索道XML文件前调用的方法。 |
| void NXOpen::RoutingCommon::CustomManager::SetCablewayUniqueNodeNamePlugin | ( | const NXOpen::RoutingCommon::CustomManager::CablewayUniqueNodeNamePlugin & | uniqueNodeNamePlugin | ) |
设置电缆槽导出时管路模块将调用的插件,用于为代表指定Routing::ControlPoint的XML节点获取新的唯一名称。 注意:确保名称唯一是此插件的责任,管路模块不会检查返回值是否唯一。 若已注册过插件则会抛出错误。
版本:NX1980.0.0
许可要求:routing_cabling("电缆布线设计")
| uniqueNodeNamePlugin | 希望管路模块调用的、用于获取XML节点新唯一名称的方法 |
| void NXOpen::RoutingCommon::CustomManager::SetCablewayUniqueSegmentNamePlugin | ( | const NXOpen::RoutingCommon::CustomManager::CablewayUniqueSegmentNamePlugin & | uniqueSegmentNamePlugin | ) |
设置在索道导出期间Routing将调用的插件,用于为XML文件中代表指定Routing::ISegment的分段获取新的唯一名称。 注意:确保名称唯一性是该插件的责任,Routing不会检查返回值是否唯一。 若已注册过插件,调用此方法将抛出错误。
创建于NX1980.0.0.
许可证要求: routing_cabling ("Routing Cabling")
| uniqueSegmentNamePlugin | 希望Routing调用的方法,用于获取此XML分段的新唯一名称。 |
| void NXOpen::RoutingCommon::CustomManager::SetCablewayXmlFileNamePlugin | ( | const NXOpen::RoutingCommon::CustomManager::CablewayXmlFileNamePlugin & | xmlFileNamePlugin | ) |
设置电缆槽导出前管路模块将调用的插件,用于获取电缆槽XML文件的名称。 若已注册过插件则会抛出错误。
版本:NX1980.0.0
许可要求:routing_cabling("电缆布线设计")
| xmlFileNamePlugin | 希望管路模块调用的、用于获取XML文件名的方法 |
| void NXOpen::RoutingCommon::CustomManager::SetRSDApplicationEnterPlugin | ( | const NXOpen::RoutingCommon::CustomManager::RSDApplicationEnterPlugin & | applicationEnterPlugin | ) |
设置进入管路系统设计器(RSD)应用时管路模块将调用的插件。 若已注册过插件则会抛出错误。
版本:NX1980.0.0
许可要求:routing_base("管路设计基础")
| applicationEnterPlugin | 进入应用时希望管路模块调用的方法 |
| void NXOpen::RoutingCommon::CustomManager::SetRSDApplicationExitPlugin | ( | const NXOpen::RoutingCommon::CustomManager::RSDApplicationExitPlugin & | applicationExitPlugin | ) |
设置退出管路系统设计器(RSD)应用时管路模块将调用的插件。 若已注册过插件则会抛出错误。
版本:NX1980.0.0
许可要求:routing_base("管路设计基础")
| applicationExitPlugin | 退出应用时希望管路模块调用的方法 |
| void NXOpen::RoutingCommon::CustomManager::SetSpoolAssemblyNamePlugin | ( | const NXOpen::RoutingCommon::CustomManager::SpoolAssemblyNamePlugin & | assemblyNamePlugin | ) |
设置管段装配名称插件。 若已注册插件,将抛出错误。
创建于NX2406.0.0。
许可证要求: routing_base ("Routing Basic")
| assemblyNamePlugin | 希望Routing调用以获取管段装配名称的方法。 |
| void NXOpen::RoutingCommon::CustomManager::SetSpoolNamePlugin | ( | const NXOpen::RoutingCommon::CustomManager::SpoolNamePlugin & | spoolNamePlugin | ) |
设置线轴名称插件。 若已注册过插件,调用此方法将抛出错误。
创建于NX2312.0.0.
许可证要求: routing_base ("Routing Basic")
| spoolNamePlugin | 希望Routing调用的方法,用于获取线轴名称。 |
| void NXOpen::RoutingCommon::CustomManager::SetWiringComponentNamePlugin | ( | const NXOpen::RoutingCommon::CustomManager::ComponentNamePlugin & | wiringComponentNamePlugin | ) |
设置布线部件名称插件。 若已注册过插件,调用此方法将抛出错误。
创建于NX1980.0.0.
许可证要求: routing_base ("Routing Basic")
| wiringComponentNamePlugin | 希望Routing调用的方法,用于获取布线部件名称。 |
| tag_t NXOpen::RoutingCommon::CustomManager::Tag | ( | ) | const |
返回此对象的标识。