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

表示当前部件中所有参数库参数 对象的集合。
要获取此类的实例,请参考NXOpen::参数库参数库管理器

创建于NX1847.0.0版本。
更多...

#include <ParamLibParameterCollection.hxx>

类 NXOpen::ParamLibParameterCollection 继承关系图:
NXOpen::TaggedObjectCollection

class  iterator

Public 成员函数

iterator begin ()
NXOpen::ParamLibParameterCopyParameterFromLibrary (const char *libraryName, const char *libraryReference)
NXOpen::ParamLibParameterCopyParameterFromLibrary (const char *libraryName, const char *libraryReference, bool retainParentPedigree)
NXOpen::ParamLibParameterCopyParameterFromLibrary (const NXString &libraryName, const NXString &libraryReference)
NXOpen::ParamLibParameterCopyParameterFromLibrary (const NXString &libraryName, const NXString &libraryReference, bool retainParentPedigree)
NXOpen::ParamLibParameterListBuilderCreateListBlockBuilder ()
NXOpen::ParamLibParameterListBuilderCreateListBlockBuilder1 (std::vector< NXString > &pcLibTypeNeuNames)
NXOpen::ParamLibParameterBuilderCreateParameterBuilder (const char *libTypeNeutralName, int parameterType)
NXOpen::ParamLibParameterBuilderCreateParameterBuilder (const NXString &libTypeNeutralName, int parameterType)
NXOpen::ParamLibParameterBuilderCreateParameterEditBuilder (NXOpen::ParamLibParameter *parameterTag)
NXOpen::ParamLibParameterBuilderCreateParameterInspectBuilder (NXOpen::ParamLibParameter *parameterTag)
NXOpen::ParamLibLibraryManagerBuilderCreateParameterLibmgrBuilder (std::vector< NXString > &pcLibTypeNeuNames)
void DeleteParametersFromLibrary (std::vector< NXString > &pParamNames, const char *pcLibName)
void DeleteParametersFromLibrary (std::vector< NXString > &pParamNames, const NXString &pcLibName)
iterator end ()
void ExportParametersToLibrary (std::vector< NXString > &pcParamNames, std::vector< NXString > &pcLibNames, const char *pcExportedLibName, bool bUpdateLibraryReference)
void ExportParametersToLibrary (std::vector< NXString > &pcParamNames, std::vector< NXString > &pcLibNames, const char *pcExportedLibName, const std::vector< bool > &bUpdateLibraryReference)
void ExportParametersToLibrary (std::vector< NXString > &pcParamNames, std::vector< NXString > &pcLibNames, const NXString &pcExportedLibName, bool bUpdateLibraryReference)
void ExportParametersToLibrary (std::vector< NXString > &pcParamNames, std::vector< NXString > &pcLibNames, const NXString &pcExportedLibName, const std::vector< bool > &bUpdateLibraryReference)
NXOpen::ParamLibParameterFindObject (const char *journalIdentifier)
NXOpen::ParamLibParameterFindObject (const NXString &journalIdentifier)
NXOpen::ParamLibParameterGetLoadedLibraryParameter (const char *pcLibName, const char *pcParamName)
NXOpen::ParamLibParameterGetLoadedLibraryParameter (const NXString &pcLibName, const NXString &pcParamName)
std::vector< NXOpen::ParamLibParameter * > GetUsedParameters ()
void InfoLibraryParameter (const char *pcLibAr, const char *pcParamNameAr)
void InfoLibraryParameter (const NXString &pcLibAr, const NXString &pcParamNameAr)
void InfoLibraryParameterToFile (const char *pcLibAr, const char *pcParamNameAr, bool bOverride, const char *pcFileName)
void InfoLibraryParameterToFile (const NXString &pcLibAr, const NXString &pcParamNameAr, bool bOverride, const NXString &pcFileName)
NXOpen::ParamLibParameterLoadFromNxparampllibrary (const char *parameterName)
NXOpen::ParamLibParameterLoadFromNxparampllibrary (const NXString &parameterName)
NXOpen::ParamLibParameterLoadFromParamplLibrary (const char *libraryName, const char *parameterName)
NXOpen::ParamLibParameterLoadFromParamplLibrary (const NXString &libraryName, const NXString &parameterName)
void OutputParametersToLibrary (std::vector< NXString > &pcParamNames, std::vector< NXString > &pcLibNames, const char *pcExportedLibName)
void OutputParametersToLibrary (std::vector< NXString > &pcParamNames, std::vector< NXString > &pcLibNames, const NXString &pcExportedLibName)
tag_t Tag () const
void UpdateParametersInLibrary (const std::vector< NXOpen::ParamLibParameter * > &tEditedParam, std::vector< NXString > &pParamNames, const char *pcLibName)
void UpdateParametersInLibrary (const std::vector< NXOpen::ParamLibParameter * > &tEditedParam, std::vector< NXString > &pParamNames, const NXString &pcLibName)

详细描述

表示当前部件中所有参数库参数 对象的集合。
要获取此类的实例,请参考NXOpen::参数库参数库管理器

创建于NX1847.0.0版本。

参数库参数集合

成员函数说明

◆ begin()

iterator NXOpen::ParamLibParameterCollection::begin ( )

返回指向第一个元素的迭代器。

◆ CopyParameterFromLibrary() [1/4]

NXOpen::ParamLibParameter * NXOpen::ParamLibParameterCollection::CopyParameterFromLibrary ( const char * libraryName,
const char * libraryReference )

根据库参数定义在部件中创建可编辑的参数(副本)。

返回
复制得到的参数
创建于NX1847.0.0。

许可要求:无
参数
libraryName完全限定的库名称;如果是叶名称,将先使用当前目录,再依次使用客户默认设置中配置的用户和站点目录
libraryReference参数名称/标识符

◆ CopyParameterFromLibrary() [2/4]

NXOpen::ParamLibParameter * NXOpen::ParamLibParameterCollection::CopyParameterFromLibrary ( const char * libraryName,
const char * libraryReference,
bool retainParentPedigree )

根据库参数定义在部件中创建可编辑的参数(副本)。

返回
复制得到的参数
创建于NX1847.0.0。

许可要求:无
参数
libraryName完全限定的库名称;如果是叶名称,将先使用当前目录,再依次使用客户默认设置中配置的用户和站点目录
libraryReference参数名称/标识符
retainParentPedigree为true时,复制得到的参数将保留其来源库参数的信息

◆ CopyParameterFromLibrary() [3/4]

NXOpen::ParamLibParameter * NXOpen::ParamLibParameterCollection::CopyParameterFromLibrary ( const NXString & libraryName,
const NXString & libraryReference )

根据库参数定义在部件中创建可编辑的参数(副本)。

返回
复制得到的参数
创建于NX1847.0.0。

许可要求:无
参数
libraryName完全限定的库名称;如果是叶名称,将先使用当前目录,再依次使用客户默认设置中配置的用户和站点目录
libraryReference参数名称/标识符

◆ CopyParameterFromLibrary() [4/4]

NXOpen::ParamLibParameter * NXOpen::ParamLibParameterCollection::CopyParameterFromLibrary ( const NXString & libraryName,
const NXString & libraryReference,
bool retainParentPedigree )

根据库参数定义在部件中创建可编辑的参数(副本)。

返回
复制得到的参数
创建于NX1847.0.0。

许可要求:无
参数
libraryName完全限定的库名称;如果是叶名称,将先使用当前目录,再依次使用客户默认设置中配置的用户和站点目录
libraryReference参数名称/标识符
retainParentPedigree为true时,复制得到的参数将保留其来源库参数的信息

◆ CreateListBlockBuilder()

NXOpen::ParamLibParameterListBuilder * NXOpen::ParamLibParameterCollection::CreateListBlockBuilder ( )

创建一个NXOpen::ParamLibParameterListBuilder,用于控制参数列表UI块的外观,并捕获交互操作以便记录值/设置。

返回
创建的NXOpen::ParamLibParameterListBuilder
版本:NX1847.0.0。

许可要求:无

◆ CreateListBlockBuilder1()

NXOpen::ParamLibParameterListBuilder * NXOpen::ParamLibParameterCollection::CreateListBlockBuilder1 ( std::vector< NXString > & pcLibTypeNeuNames)

创建一个NXOpen::ParamLibParameterListBuilder,用于控制参数列表UI块的外观,并捕获交互操作以便记录值/设置。

返回
创建的NXOpen::ParamLibParameterListBuilder
版本:NX1847.0.0。

许可要求:无
参数
pcLibTypeNeuNames有效参数库类型的中性名称数组

◆ CreateParameterBuilder() [1/2]

NXOpen::ParamLibParameterBuilder * NXOpen::ParamLibParameterCollection::CreateParameterBuilder ( const char * libTypeNeutralName,
int parameterType )

创建用于在指定类型的参数库中创建指定类型参数的ParamLibParameterBuilder。

返回
创建的NXOpen::ParamLibParameterBuilder
版本:NX1847.0.0。

许可要求:无
参数
libTypeNeutralName参数库类型的中性名称
parameterType要创建的NXOpen::ParamLibParameter 的类型

◆ CreateParameterBuilder() [2/2]

NXOpen::ParamLibParameterBuilder * NXOpen::ParamLibParameterCollection::CreateParameterBuilder ( const NXString & libTypeNeutralName,
int parameterType )

创建用于在指定类型的参数库中创建指定类型参数的ParamLibParameterBuilder。

返回
创建的NXOpen::ParamLibParameterBuilder
版本:NX1847.0.0。

许可要求:无
参数
libTypeNeutralName参数库类型的中性名称
parameterType要创建的NXOpen::ParamLibParameter 的类型

◆ CreateParameterEditBuilder()

NXOpen::ParamLibParameterBuilder * NXOpen::ParamLibParameterCollection::CreateParameterEditBuilder ( NXOpen::ParamLibParameter * parameterTag)

创建用于编辑参数的ParamLibParameterBuilder。

返回
创建的NXOpen::ParamLibParameterBuilder
版本:NX1847.0.0。

许可要求:无
参数
parameterTag要编辑的NXOpen::ParamLibParameter

◆ CreateParameterInspectBuilder()

NXOpen::ParamLibParameterBuilder * NXOpen::ParamLibParameterCollection::CreateParameterInspectBuilder ( NXOpen::ParamLibParameter * parameterTag)

创建用于查看参数的ParamLibParameterBuilder。

返回
创建的NXOpen::ParamLibParameterBuilder
版本:NX1847.0.0。

许可要求:无
参数
parameterTag要查看的NXOpen::ParamLibParameter

◆ CreateParameterLibmgrBuilder()

NXOpen::ParamLibLibraryManagerBuilder * NXOpen::ParamLibParameterCollection::CreateParameterLibmgrBuilder ( std::vector< NXString > & pcLibTypeNeuNames)

创建参数库管理器UI使用的ParamLibLibraryManagerBuilder,用于控制其外观,并捕获交互操作以便记录值/设置。

返回
创建的NXOpen::ParamLibLibraryManagerBuilder
版本:NX1847.0.0。

许可要求:无
参数
pcLibTypeNeuNames有效参数库类型的中性名称数组

◆ DeleteParametersFromLibrary() [1/2]

void NXOpen::ParamLibParameterCollection::DeleteParametersFromLibrary ( std::vector< NXString > & pParamNames,
const char * pcLibName )

从参数库文件中删除参数。此操作需要写入权限。
创建于NX1847.0.0。

许可要求: 无

参数
pParamNames要从库中删除的参数标识符数组
pcLibName要修改的库

◆ DeleteParametersFromLibrary() [2/2]

void NXOpen::ParamLibParameterCollection::DeleteParametersFromLibrary ( std::vector< NXString > & pParamNames,
const NXString & pcLibName )

从参数库文件中删除参数。此操作需要写入权限。
创建于NX1847.0.0。

许可要求: 无

参数
pParamNames要从库中删除的参数标识符数组
pcLibName要修改的库

◆ end()

iterator NXOpen::ParamLibParameterCollection::end ( )
inline

返回指向最后一个元素之后位置的迭代器。

◆ ExportParametersToLibrary() [1/4]

void NXOpen::ParamLibParameterCollection::ExportParametersToLibrary ( std::vector< NXString > & pcParamNames,
std::vector< NXString > & pcLibNames,
const char * pcExportedLibName,
bool bUpdateLibraryReference )

将参数写入参数库文件。这些参数可以是本地参数定义或来自其他参数库的参数定义。 参数名称与库名称的组合用于标识参数定义。如果是本地参数定义,需指定参数名称,库名称设为""。 对目标导出库需要写入权限。若bUpdateLibraryReferences设为true,NX模型将更新, 使参数的引用库改为导出库。
创建于NX1847.0.0。

许可要求: 无

参数
pcParamNames要导出的参数标识符数组
pcLibNames与参数名称对应的库名称数组
pcExportedLibName要写入参数定义的目标库
bUpdateLibraryReferencetrue表示将已加载/本地参数的引用库更新为导出库,false表示保持引用库不变

◆ ExportParametersToLibrary() [2/4]

void NXOpen::ParamLibParameterCollection::ExportParametersToLibrary ( std::vector< NXString > & pcParamNames,
std::vector< NXString > & pcLibNames,
const char * pcExportedLibName,
const std::vector< bool > & bUpdateLibraryReference )

将参数写入参数库文件。这些参数可以是本地参数定义或来自其他参数库的参数定义。 参数名称与库名称的组合用于标识参数定义。如果是本地参数定义,需指定参数名称,库名称设为""。 对目标导出库需要写入权限。若bUpdateLibraryReferences设为true,NX模型将更新, 使参数的引用库改为导出库。在此版本的调用中,每个参数可单独设置是否更新引用。
创建于NX1847.0.0。

许可要求: 无

参数
pcParamNames要导出的参数标识符数组
pcLibNames与参数名称对应的库名称数组
pcExportedLibName要写入参数定义的目标库
bUpdateLibraryReferencetrue表示将已加载/本地参数的引用库更新为导出库,false表示保持引用库不变

◆ ExportParametersToLibrary() [3/4]

void NXOpen::ParamLibParameterCollection::ExportParametersToLibrary ( std::vector< NXString > & pcParamNames,
std::vector< NXString > & pcLibNames,
const NXString & pcExportedLibName,
bool bUpdateLibraryReference )

将参数写入参数库文件。这些参数可以是本地参数定义或来自其他参数库的参数定义。 参数名称与库名称的组合用于标识参数定义。如果是本地参数定义,需指定参数名称,库名称设为""。 对目标导出库需要写入权限。若bUpdateLibraryReferences设为true,NX模型将更新, 使参数的引用库改为导出库。
创建于NX1847.0.0。

许可要求: 无

参数
pcParamNames要导出的参数标识符数组
pcLibNames与参数名称对应的库名称数组
pcExportedLibName要写入参数定义的目标库
bUpdateLibraryReferencetrue表示将已加载/本地参数的引用库更新为导出库,false表示保持引用库不变

◆ ExportParametersToLibrary() [4/4]

void NXOpen::ParamLibParameterCollection::ExportParametersToLibrary ( std::vector< NXString > & pcParamNames,
std::vector< NXString > & pcLibNames,
const NXString & pcExportedLibName,
const std::vector< bool > & bUpdateLibraryReference )

将参数写入参数库文件。这些参数可以是本地参数定义或来自其他参数库的参数定义。 参数名称与库名称的组合用于标识参数定义。如果是本地参数定义,需指定参数名称,库名称设为""。 对目标导出库需要写入权限。若bUpdateLibraryReferences设为true,NX模型将更新, 使参数的引用库改为导出库。在此版本的调用中,每个参数可单独设置是否更新引用。
创建于NX1847.0.0。

许可要求: 无

参数
pcParamNames要导出的参数标识符数组
pcLibNames与参数名称对应的库名称数组
pcExportedLibName要写入参数定义的目标库
bUpdateLibraryReferencetrue表示将已加载/本地参数的引用库更新为导出库,false表示保持引用库不变

◆ FindObject() [1/2]

NXOpen::ParamLibParameter * NXOpen::ParamLibParameterCollection::FindObject ( const char * journalIdentifier)

根据日志中记录的标识符查找NXOpen::ParamLibParameter。 如果找不到具有给定日志标识符的对象,将抛出异常。

返回
找到的参数
版本:NX1847.0.0。

许可要求:无
参数
journalIdentifier要查找的标识符

◆ FindObject() [2/2]

NXOpen::ParamLibParameter * NXOpen::ParamLibParameterCollection::FindObject ( const NXString & journalIdentifier)

根据日志中记录的标识符查找NXOpen::ParamLibParameter。 如果找不到具有给定日志标识符的对象,将抛出异常。

返回
找到的参数
版本:NX1847.0.0。

许可要求:无
参数
journalIdentifier要查找的标识符

◆ GetLoadedLibraryParameter() [1/2]

NXOpen::ParamLibParameter * NXOpen::ParamLibParameterCollection::GetLoadedLibraryParameter ( const char * pcLibName,
const char * pcParamName )

检查库参数是否已加载到部件文件中。如果已加载,返回该参数。

返回
已加载的参数
创建于NX1847.0.0。

许可要求:无
参数
pcLibName完全限定的库名称;如果是叶名称,将先使用当前目录,再依次使用客户默认设置中配置的用户和站点目录
pcParamName参数名称

◆ GetLoadedLibraryParameter() [2/2]

NXOpen::ParamLibParameter * NXOpen::ParamLibParameterCollection::GetLoadedLibraryParameter ( const NXString & pcLibName,
const NXString & pcParamName )

检查库参数是否已加载到部件文件中。如果已加载,返回该参数。

返回
已加载的参数
创建于NX1847.0.0。

许可要求:无
参数
pcLibName完全限定的库名称;如果是叶名称,将先使用当前目录,再依次使用客户默认设置中配置的用户和站点目录
pcParamName参数名称

◆ GetUsedParameters()

std::vector< NXOpen::ParamLibParameter * > NXOpen::ParamLibParameterCollection::GetUsedParameters ( )

返回部件中使用的参数。

返回
已使用的参数
创建于NX1847.0.0。

许可要求: 无

◆ InfoLibraryParameter() [1/2]

void NXOpen::ParamLibParameterCollection::InfoLibraryParameter ( const char * pcLibAr,
const char * pcParamNameAr )

在信息窗口中显示指定库参数的属性值。
创建于NX1847.0.0。

许可要求: 无

参数
pcLibAr库名称
pcParamNameAr参数名称

◆ InfoLibraryParameter() [2/2]

void NXOpen::ParamLibParameterCollection::InfoLibraryParameter ( const NXString & pcLibAr,
const NXString & pcParamNameAr )

在信息窗口中显示指定库参数的属性值。
创建于NX1847.0.0。

许可要求: 无

参数
pcLibAr库名称
pcParamNameAr参数名称

◆ InfoLibraryParameterToFile() [1/2]

void NXOpen::ParamLibParameterCollection::InfoLibraryParameterToFile ( const char * pcLibAr,
const char * pcParamNameAr,
bool bOverride,
const char * pcFileName )

将指定库参数的属性值写入文件。
创建于NX1847.0.0。

许可要求: 无

参数
pcLibAr库名称
pcParamNameAr参数名称
bOverride如果文件已存在,true表示覆盖文件,false表示追加到文件
pcFileName要写入信息的文件的完整路径(含文件名)

◆ InfoLibraryParameterToFile() [2/2]

void NXOpen::ParamLibParameterCollection::InfoLibraryParameterToFile ( const NXString & pcLibAr,
const NXString & pcParamNameAr,
bool bOverride,
const NXString & pcFileName )

将指定库参数的属性值写入文件。
创建于NX1847.0.0。

许可要求: 无

参数
pcLibAr库名称
pcParamNameAr参数名称
bOverride如果文件已存在,true表示覆盖文件,false表示追加到文件
pcFileName要写入信息的文件的完整路径(含文件名)

◆ LoadFromNxparampllibrary() [1/2]

NXOpen::ParamLibParameter * NXOpen::ParamLibParameterCollection::LoadFromNxparampllibrary ( const char * parameterName)

根据NX参数库的参数定义在部件中创建不可编辑的参数。

返回
加载的参数
创建于NX1847.0.0。

许可要求:无
参数
parameterName库内的唯一参数名称

◆ LoadFromNxparampllibrary() [2/2]

NXOpen::ParamLibParameter * NXOpen::ParamLibParameterCollection::LoadFromNxparampllibrary ( const NXString & parameterName)

根据NX参数库的参数定义在部件中创建不可编辑的参数。

返回
加载的参数
创建于NX1847.0.0。

许可要求:无
参数
parameterName库内的唯一参数名称

◆ LoadFromParamplLibrary() [1/2]

NXOpen::ParamLibParameter * NXOpen::ParamLibParameterCollection::LoadFromParamplLibrary ( const char * libraryName,
const char * parameterName )

根据参数库文件定义在部件中创建不可编辑的参数。参数由库名称和唯一参数名称标识。 如果库名称不是完全限定的,程序会先在当前目录查找该名称的参数库,再依次在用户和站点级参数库的客户默认设置目录中查找。如果客户默认设置使用文件格式,则会在指定文件所在目录中查找。

返回
加载的参数
创建于NX1847.0.0。

许可要求:无
参数
libraryName完全限定的库名称;如果是叶名称,将先使用当前目录,再依次使用客户默认设置中配置的用户和站点目录
parameterName参数名称

◆ LoadFromParamplLibrary() [2/2]

NXOpen::ParamLibParameter * NXOpen::ParamLibParameterCollection::LoadFromParamplLibrary ( const NXString & libraryName,
const NXString & parameterName )

根据参数库文件定义在部件中创建不可编辑的参数。参数由库名称和唯一参数名称标识。 如果库名称不是完全限定的,程序会先在当前目录查找该名称的参数库,再依次在用户和站点级参数库的客户默认设置目录中查找。如果客户默认设置使用文件格式,则会在指定文件所在目录中查找。

返回
加载的参数
创建于NX1847.0.0。

许可要求:无
参数
libraryName完全限定的库名称;如果是叶名称,将先使用当前目录,再依次使用客户默认设置中配置的用户和站点目录
parameterName参数名称

◆ OutputParametersToLibrary() [1/2]

void NXOpen::ParamLibParameterCollection::OutputParametersToLibrary ( std::vector< NXString > & pcParamNames,
std::vector< NXString > & pcLibNames,
const char * pcExportedLibName )

将参数写入参数库文件。这些参数可以是本地参数定义或来自其他参数库的参数定义。 参数名称与库名称的组合用于标识参数定义。如果是本地参数定义,需指定参数名称,库名称设为""。 对目标导出库需要写入权限。
创建于NX1847.0.0。

许可要求: 无

参数
pcParamNames要导出的参数标识符数组
pcLibNames与参数名称对应的库名称数组
pcExportedLibName要写入参数定义的目标库

◆ OutputParametersToLibrary() [2/2]

void NXOpen::ParamLibParameterCollection::OutputParametersToLibrary ( std::vector< NXString > & pcParamNames,
std::vector< NXString > & pcLibNames,
const NXString & pcExportedLibName )

将参数写入参数库文件。这些参数可以是本地参数定义,也可以是来自其他参数库的参数定义。 参数名称和库名称的组合用于标识参数定义。如果是本地参数定义,需指定参数名称,库名称指定为""。需要拥有目标导出库的写入权限。
创建于NX1847.0.0。

许可要求:无

参数
pcParamNames待导出参数的标识符数组
pcLibNames与参数名称对应的库名称数组
pcExportedLibName要写入参数定义的目标库

◆ Tag()

tag_t NXOpen::ParamLibParameterCollection::Tag ( ) const

返回此对象的标识。

◆ UpdateParametersInLibrary() [1/2]

void NXOpen::ParamLibParameterCollection::UpdateParametersInLibrary ( const std::vector< NXOpen::ParamLibParameter * > & tEditedParam,
std::vector< NXString > & pParamNames,
const char * pcLibName )

更新参数库文件中的参数。此操作需要写入权限。
创建于NX1847.0.0。

许可要求: 无

参数
tEditedParam已加载的参数标签数组
pParamNames与库中参数名称匹配的数组,这些库参数将采用对应tEditedParam参数的属性
pcLibName要修改的库

◆ UpdateParametersInLibrary() [2/2]

void NXOpen::ParamLibParameterCollection::UpdateParametersInLibrary ( const std::vector< NXOpen::ParamLibParameter * > & tEditedParam,
std::vector< NXString > & pParamNames,
const NXString & pcLibName )

更新参数库文件中的参数。此操作需要写入权限。
创建于NX1847.0.0。

许可要求: 无

参数
tEditedParam已加载的参数标签数组
pParamNames与库中参数名称匹配的数组,这些库参数将采用对应tEditedParam参数的属性
pcLibName要修改的库