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

命令构建器 更多...

#include <Report_CommandBuilder.hxx>

类 NXOpen::Report::CommandBuilder 继承关系图:
NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public 类型

enum  UserInputLocation { UserInputLocationBeforeAutomation , UserInputLocationAfterAutomation }

Public 成员函数

bool Active ()
NXOpen::Report::BaseArgument * AddArgument (NXOpen::Report::BaseArgument::Type argumentType)
NXOpen::Report::UserInput * AddUserInput (NXOpen::Report::CommandBuilder::UserInputLocation userInputLocation, NXOpen::Report::UserInput::Type userInputType)
NXString Alias ()
NXString DisplayName ()
void GetArguments (std::vector< NXOpen::Report::BaseArgument * > &pArguments)
void GetHint (std::vector< NXString > &commandHint)
void GetNamespaces (std::vector< NXString > &pNamespaces)
void GetUserInputs (NXOpen::Report::CommandBuilder::UserInputLocation userInputLocation, std::vector< NXOpen::Report::UserInput * > &pUserInputs)
void MoveUserInputs (NXOpen::Report::CommandBuilder::UserInputLocation userInputLocation, const std::vector< NXOpen::Report::UserInput * > &pUserInputs, bool isBeforeRefUserInput, NXOpen::Report::UserInput *pRefUserInputs)
NXString Name ()
NXOpen::Report::ProgramInformation * ProgramInformation ()
void RemoveArguments (const std::vector< NXOpen::Report::BaseArgument * > &pArguments)
void RemoveUserInputs (NXOpen::Report::CommandBuilder::UserInputLocation userInputLocation, const std::vector< NXOpen::Report::UserInput * > &pUserInputs)
void SetActive (bool isActive)
void SetAlias (const char *aliasName)
void SetAlias (const NXString &aliasName)
void SetDisplayName (const char *displayName)
void SetDisplayName (const NXString &displayName)
void SetHint (std::vector< NXString > &commandHint)
void SetName (const char *commandName)
void SetName (const NXString &commandName)
void SetNamespaces (std::vector< NXString > &pNamespaces)
Public 成员函数 继承自 NXOpen::Builder
NXOpen::NXObject * Commit ()
void Destroy ()
std::vector< NXOpen::NXObject * > GetCommittedObjects ()
NXOpen::NXObject * GetObject ()
NXOpen::PreviewBuilder * PreviewBuilder ()
void ShowResults ()
virtual bool Validate ()
Public 成员函数 继承自 NXOpen::TaggedObject
tag_t Tag () const

友元

class _CommandBuilderBuilder

详细描述

命令构建器

表示一个 NXOpen::Report::CommandBuilder。
要创建此类的新实例，请使用 NXOpen::Report::CommandManager::CreateCommandBuilder

于NX11.0.0版本创建。

成员枚举类型说明

◆ UserInputLocation

enum NXOpen::Report::CommandBuilder::UserInputLocation

表示命令中用户输入的位置。

枚举值
UserInputLocationBeforeAutomation 

自动化步骤前的用户项

UserInputLocationAfterAutomation 

自动化步骤后的用户项

成员函数说明

◆ Active()

bool NXOpen::Report::CommandBuilder::Active ( )

返回一个值，指示命令是否处于激活状态
创建于NX11.0.0.

许可要求：无

◆ AddArgument()

NXOpen::Report::BaseArgument * NXOpen::Report::CommandBuilder::AddArgument ( NXOpen::Report::BaseArgument::Type argumentType)

添加一个参数到命令中
创建于NX11.0.0.

许可要求：无

参数
argumentType参数类型

◆ AddUserInput()

NXOpen::Report::UserInput * NXOpen::Report::CommandBuilder::AddUserInput ( NXOpen::Report::CommandBuilder::UserInputLocation userInputLocation,
NXOpen::Report::UserInput::Type userInputType )

添加用户输入并将其添加到命令中。

返回

创建于NX11.0.0。

许可要求：无
参数
userInputLocation用户输入位置
userInputType用户输入类型

◆ Alias()

NXString NXOpen::Report::CommandBuilder::Alias ( )

获取命令别名
于NX2206.0.0版本创建。

许可要求：无

◆ DisplayName()

NXString NXOpen::Report::CommandBuilder::DisplayName ( )

返回命令显示名称
创建于NX11.0.0.

许可要求：无

◆ GetArguments()

void NXOpen::Report::CommandBuilder::GetArguments ( std::vector< NXOpen::Report::BaseArgument * > & pArguments)

获取命令中的所有参数
创建于NX11.0.0.

许可要求：无

参数
pArguments参数集合

◆ GetHint()

void NXOpen::Report::CommandBuilder::GetHint ( std::vector< NXString > & commandHint)

获取命令提示
创建于NX11.0.0.

许可要求：无

参数
commandHint命令提示

◆ GetNamespaces()

void NXOpen::Report::CommandBuilder::GetNamespaces ( std::vector< NXString > & pNamespaces)

获取命令适用的类别
创建于NX11.0.0.

许可要求：无

参数
pNamespaces类别集合

◆ GetUserInputs()

void NXOpen::Report::CommandBuilder::GetUserInputs ( NXOpen::Report::CommandBuilder::UserInputLocation userInputLocation,
std::vector< NXOpen::Report::UserInput * > & pUserInputs )

获取所有用户输入。
创建于NX11.0.0。

许可要求：无

参数
userInputLocation用户输入位置
pUserInputs用户输入列表

◆ MoveUserInputs()

void NXOpen::Report::CommandBuilder::MoveUserInputs ( NXOpen::Report::CommandBuilder::UserInputLocation userInputLocation,
const std::vector< NXOpen::Report::UserInput * > & pUserInputs,
bool isBeforeRefUserInput,
NXOpen::Report::UserInput * pRefUserInputs )

将用户输入移动到新位置。
创建于NX11.0.0。

许可要求：无

参数
userInputLocation用户输入位置
pUserInputs要移动的用户输入列表
isBeforeRefUserInput是否移至参考输入之前
pRefUserInputs目标参考用户输入

◆ Name()

NXString NXOpen::Report::CommandBuilder::Name ( )

获取命令名称
于NX11.0.0版本创建。

许可要求：无

◆ ProgramInformation()

NXOpen::Report::ProgramInformation * NXOpen::Report::CommandBuilder::ProgramInformation ( )

返回自动化程序信息对象。
创建于NX11.0.0。

许可要求：无

◆ RemoveArguments()

void NXOpen::Report::CommandBuilder::RemoveArguments ( const std::vector< NXOpen::Report::BaseArgument * > & pArguments)

移除指定参数
创建于NX11.0.0.

许可要求：无

参数
pArguments要移除的参数集合

◆ RemoveUserInputs()

void NXOpen::Report::CommandBuilder::RemoveUserInputs ( NXOpen::Report::CommandBuilder::UserInputLocation userInputLocation,
const std::vector< NXOpen::Report::UserInput * > & pUserInputs )

删除用户输入。
创建于NX11.0.0。

许可要求：无

参数
userInputLocation用户输入位置
pUserInputs要删除的用户输入列表

◆ SetActive()

void NXOpen::Report::CommandBuilder::SetActive ( bool isActive)

设置一个值，指示命令是否处于激活状态
创建于NX11.0.0.

许可要求：无

参数
isActive是否激活

◆ SetAlias() [1/2]

void NXOpen::Report::CommandBuilder::SetAlias ( const char * aliasName)

设置命令别名
创建于NX2206.0.0.

许可要求：无

参数
aliasName别名

◆ SetAlias() [2/2]

void NXOpen::Report::CommandBuilder::SetAlias ( const NXString & aliasName)

设置命令别名
创建于NX2206.0.0.

许可要求：无

参数
aliasName别名

◆ SetDisplayName() [1/2]

void NXOpen::Report::CommandBuilder::SetDisplayName ( const char * displayName)

设置命令显示名称
创建于NX11.0.0.

许可要求：无

参数
displayName显示名称

◆ SetDisplayName() [2/2]

void NXOpen::Report::CommandBuilder::SetDisplayName ( const NXString & displayName)

设置命令显示名称
创建于NX11.0.0.

许可要求：无

参数
displayName显示名称

◆ SetHint()

void NXOpen::Report::CommandBuilder::SetHint ( std::vector< NXString > & commandHint)

设置命令提示
创建于NX11.0.0.

许可要求：无

参数
commandHint命令提示

◆ SetName() [1/2]

void NXOpen::Report::CommandBuilder::SetName ( const char * commandName)

设置命令名称
于NX11.0.0版本创建。

许可要求：无

参数
commandName命令名称

◆ SetName() [2/2]

void NXOpen::Report::CommandBuilder::SetName ( const NXString & commandName)

设置命令名称
于NX11.0.0版本创建。

许可要求：无

参数
commandName命令名称

◆ SetNamespaces()

void NXOpen::Report::CommandBuilder::SetNamespaces ( std::vector< NXString > & pNamespaces)

设置命令适用的类别
创建于NX11.0.0.

许可要求：无

参数
pNamespaces类别集合