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

基础参数 更多...

#include <Report_BaseArgument.hxx>

类 NXOpen::Report::BaseArgument 继承关系图:
NXOpen::TaggedObject NXOpen::INXObject NXOpen::Report::DoubleArgument NXOpen::Report::EnumerationArgument NXOpen::Report::IntegerArgument NXOpen::Report::StringArgument

Public 类型

enum  Type { TypeInteger , TypeDouble , TypeString , TypeEnumeration }

Public 成员函数

NXString DisplayName ()
virtual NXOpen::INXObjectFindObject (const char *journalIdentifier)
virtual NXOpen::INXObjectFindObject (const NXString &journalIdentifier)
NXString Hint ()
virtual bool IsOccurrence ()
virtual NXString JournalIdentifier ()
virtual NXString Name ()
bool Optional ()
virtual NXOpen::Assemblies::ComponentOwningComponent ()
virtual NXOpen::BasePartOwningPart ()
virtual void Print ()
virtual NXOpen::INXObjectPrototype ()
void SetDisplayName (const char *displayName)
void SetDisplayName (const NXString &displayName)
void SetHint (const char *argumentHint)
void SetHint (const NXString &argumentHint)
virtual void SetName (const char *name)
virtual void SetName (const NXString &name)
void SetOptional (bool isOptional)
Public 成员函数 继承自 NXOpen::TaggedObject
tag_t Tag () const

友元

class _BaseArgumentBuilder

详细描述

基础参数

表示抽象命令参数。
不支持KF。

创建于NX11.0.0。

成员枚举类型说明

◆ Type

表示参数类型。

枚举值
TypeInteger 

整数数据参数

TypeDouble 

双精度数据参数

TypeString 

字符串数据参数

TypeEnumeration 

枚举数据参数

成员函数说明

◆ DisplayName()

NXString NXOpen::Report::BaseArgument::DisplayName ( )

返回参数显示名称
创建于NX11.0.0。

许可要求: 无

◆ FindObject() [1/2]

virtual NXOpen::INXObject * NXOpen::Report::BaseArgument::FindObject ( const char * journalIdentifier)
virtual

根据日志中记录的标识符查找NXOpen::NXObject 对象。 在不同软件版本中,对象的日志标识符可能不同,但新版本软件应能通过旧版本日志标识符找到同一对象。 通常该方法不应在手写代码中使用,仅用于支持日志的录制与回放。 若找不到对应日志标识符的对象,将抛出异常。

返回
找到的对象
创建于NX3.0.0。

许可要求:无
参数
journalIdentifier对象的日志标识符

实现了 NXOpen::INXObject.

◆ FindObject() [2/2]

virtual NXOpen::INXObject * NXOpen::Report::BaseArgument::FindObject ( const NXString & journalIdentifier)
virtual

根据日志中记录的标识符查找NXOpen::NXObject 对象。 在不同软件版本中,对象的日志标识符可能不同,但新版本软件应能通过旧版本日志标识符找到同一对象。 通常该方法不应在手写代码中使用,仅用于支持日志的录制与回放。 若找不到对应日志标识符的对象,将抛出异常。

返回
找到的对象
创建于NX3.0.0。

许可要求:无
参数
journalIdentifier对象的日志标识符

实现了 NXOpen::INXObject.

◆ Hint()

NXString NXOpen::Report::BaseArgument::Hint ( )

返回参数提示信息。
创建于NX11.0.0。

许可要求: 无

◆ IsOccurrence()

virtual bool NXOpen::Report::BaseArgument::IsOccurrence ( )
virtual

返回该对象是否为实例。
创建于NX3.0.0。

许可要求:无

实现了 NXOpen::INXObject.

◆ JournalIdentifier()

virtual NXString NXOpen::Report::BaseArgument::JournalIdentifier ( )
virtual

返回该对象在日志中记录的标识符。 该标识符在软件不同版本中可能不同。
创建于NX3.0.0。

许可要求:无

实现了 NXOpen::INXObject.

◆ Name()

virtual NXString NXOpen::Report::BaseArgument::Name ( )
virtual

返回对象的自定义名称。
创建于NX3.0.0。

许可要求:无

实现了 NXOpen::INXObject.

◆ Optional()

bool NXOpen::Report::BaseArgument::Optional ( )

返回一个值,指示该参数是否为可选参数。
创建于NX11.0.0。

许可要求:无

◆ OwningComponent()

virtual NXOpen::Assemblies::Component * NXOpen::Report::BaseArgument::OwningComponent ( )
virtual

若该对象为实例,返回其所属组件。
创建于NX3.0.0。

许可要求:无

实现了 NXOpen::INXObject.

◆ OwningPart()

virtual NXOpen::BasePart * NXOpen::Report::BaseArgument::OwningPart ( )
virtual

返回该对象所属的部件。
创建于NX3.0.0。

许可要求:无

实现了 NXOpen::INXObject.

◆ Print()

virtual void NXOpen::Report::BaseArgument::Print ( )
virtual

将该对象的信息输出到系统日志文件。
创建于NX3.0.0。

许可要求:无

实现了 NXOpen::INXObject.

◆ Prototype()

virtual NXOpen::INXObject * NXOpen::Report::BaseArgument::Prototype ( )
virtual

若该对象为实例,返回其原型对象。
创建于NX3.0.0。

许可要求:无

实现了 NXOpen::INXObject.

◆ SetDisplayName() [1/2]

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

设置参数显示名称
创建于NX11.0.0。

许可要求: 无

参数
displayName显示名称

◆ SetDisplayName() [2/2]

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

设置参数显示名称
创建于NX11.0.0。

许可要求: 无

参数
displayName显示名称

◆ SetHint() [1/2]

void NXOpen::Report::BaseArgument::SetHint ( const char * argumentHint)

设置参数提示。
创建于NX11.0.0。

许可要求:无

参数
argumentHint参数提示

◆ SetHint() [2/2]

void NXOpen::Report::BaseArgument::SetHint ( const NXString & argumentHint)

设置参数提示信息。
创建于NX11.0.0。

许可要求: 无

参数
argumentHint参数提示

◆ SetName() [1/2]

virtual void NXOpen::Report::BaseArgument::SetName ( const char * name)
virtual

设置对象的自定义名称。 注意:此方法不应用于编辑只读对象,例如镜像PMI对象。 若用于此类对象,在部件更新时所做更改将被覆盖。
创建于NX3.0.0。

许可要求:无

参数
name名称

实现了 NXOpen::INXObject.

◆ SetName() [2/2]

virtual void NXOpen::Report::BaseArgument::SetName ( const NXString & name)
virtual

设置对象的自定义名称。 注意:该方法不应用于编辑只读对象(如镜像PMI对象),否则在部件更新时修改将被覆盖。
创建于NX3.0.0。

许可要求:无

参数
name名称

实现了 NXOpen::INXObject.

◆ SetOptional()

void NXOpen::Report::BaseArgument::SetOptional ( bool isOptional)

设置一个值,指示该参数是否为可选参数。
创建于NX11.0.0。

许可要求:无

参数
isOptional是否可选