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

报告对象 更多...

#include <Report_Report.hxx>

类 NXOpen::Report::Report 继承关系图:
NXOpen::NXObject NXOpen::TaggedObject NXOpen::INXObject

Public 类型

enum  MoveItemLocation { MoveItemLocationBefore , MoveItemLocationAfter }
Public 类型 继承自 NXOpen::NXObject
enum  AttributeType {
  AttributeTypeInvalid , AttributeTypeNull , AttributeTypeBoolean , AttributeTypeInteger ,
  AttributeTypeReal , AttributeTypeString , AttributeTypeTime , AttributeTypeReference ,
  AttributeTypeAny = 100
}
enum  DateAndTimeFormat { DateAndTimeFormatNumeric , DateAndTimeFormatTextual }

Public 成员函数

void ClearTemplateItems ()
NXOpen::Report::IUserItem * CopyUserItem (NXOpen::Report::IUserItem *userItem)
NXOpen::Report::IUserItem * CreateUserItem (NXOpen::Report::UserInput::Type inputType)
void DeleteUserItems ()
void Export (const char *reportDocument, bool listError)
void Export (const NXString &reportDocument, bool listError)
void GetTemplateItems (std::vector< NXOpen::Report::TemplateItem * > &pTemplateItems)
void GetUserItems (std::vector< NXOpen::Report::IUserItem * > &userItems)
void HideTempalteItemsWithoutInput (bool hideTemplateItemsWithoutInput)
void MoveUserItems (const std::vector< NXOpen::Report::IUserItem * > &userItems, NXOpen::Report::Report::MoveItemLocation newLocation, NXOpen::Report::IUserItem *referencedItem)
NXOpen::Report::IReportCollection * ReportCollection ()
void SetTemplateFile (const char *templateFile)
void SetTemplateFile (const NXString &templateFile)
void SynchronizeWithCommands ()
NXString TemplateFile ()
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 _ReportBuilder

额外继承的成员函数

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

详细描述

报告对象

表示一个报告。
不支持KF。

在NX11.0.0版本创建。

成员枚举类型说明

◆ MoveItemLocation

enum NXOpen::Report::Report::MoveItemLocation

表示项的移动位置。

枚举值
MoveItemLocationBefore 

将项移动到参考项之前的位置

MoveItemLocationAfter 

将项移动到参考项之后的位置

成员函数说明

◆ ClearTemplateItems()

void NXOpen::Report::Report::ClearTemplateItems ( )

清除报告中的所有模板项。
在NX11.0.0版本创建。

许可要求: 无

◆ CopyUserItem()

NXOpen::Report::IUserItem * NXOpen::Report::Report::CopyUserItem ( NXOpen::Report::IUserItem * userItem)

复制一个用户项到报告中。

返回
输入用户项的副本
在NX11.0.0版本创建。

许可要求: 无
参数
userItem输入的用户项

◆ CreateUserItem()

NXOpen::Report::IUserItem * NXOpen::Report::Report::CreateUserItem ( NXOpen::Report::UserInput::Type inputType)

创建一个用户项并添加到报告中。

返回
创建的用户项
在NX11.0.0版本创建。

许可要求: 无
参数
inputType输入类型

◆ DeleteUserItems()

void NXOpen::Report::Report::DeleteUserItems ( )

删除报告中的所有用户项。
在NX11.0.0版本创建。

许可要求: 无

◆ Export() [1/2]

void NXOpen::Report::Report::Export ( const char * reportDocument,
bool listError )

将报告内容导出到文档。
在NX11.0.0版本创建。

许可要求: 无

参数
reportDocument报告文档路径
listError在信息窗口中列出错误信息

◆ Export() [2/2]

void NXOpen::Report::Report::Export ( const NXString & reportDocument,
bool listError )

将报告内容导出到文档。
在NX11.0.0版本创建。

许可要求: 无

参数
reportDocument报告文档路径
listError在信息窗口中列出错误信息

◆ GetTemplateItems()

void NXOpen::Report::Report::GetTemplateItems ( std::vector< NXOpen::Report::TemplateItem * > & pTemplateItems)

获取所有模板项。
在NX11.0.0版本创建。

许可要求: 无

参数
pTemplateItems模板项列表

◆ GetUserItems()

void NXOpen::Report::Report::GetUserItems ( std::vector< NXOpen::Report::IUserItem * > & userItems)

获取报告中的所有用户项。
在NX11.0.0版本创建。

许可要求: 无

参数
userItems用户项列表

◆ HideTempalteItemsWithoutInput()

void NXOpen::Report::Report::HideTempalteItemsWithoutInput ( bool hideTemplateItemsWithoutInput)

隐藏报告中无需用户输入的模板项。
在NX11.0.0版本创建。

许可要求: 无

参数
hideTemplateItemsWithoutInput是否隐藏无需输入的模板项

◆ MoveUserItems()

void NXOpen::Report::Report::MoveUserItems ( const std::vector< NXOpen::Report::IUserItem * > & userItems,
NXOpen::Report::Report::MoveItemLocation newLocation,
NXOpen::Report::IUserItem * referencedItem )

将用户项移动到新位置。
在NX11.0.0版本创建。

许可要求: 无

参数
userItems要移动的用户项列表
newLocation目标位置
referencedItem参考用户项

◆ ReportCollection()

NXOpen::Report::IReportCollection * NXOpen::Report::Report::ReportCollection ( )

返回报告集合对象。
在NX11.0.0版本创建。

许可要求: 无

◆ SetTemplateFile() [1/2]

void NXOpen::Report::Report::SetTemplateFile ( const char * templateFile)

设置模板文档文件。
在NX11.0.0版本创建。

许可要求: 无

参数
templateFile带完整路径的模板文件名

◆ SetTemplateFile() [2/2]

void NXOpen::Report::Report::SetTemplateFile ( const NXString & templateFile)

设置模板文档文件。
在NX11.0.0版本创建。

许可要求: 无

参数
templateFile带完整路径的模板文件名

◆ SynchronizeWithCommands()

void NXOpen::Report::Report::SynchronizeWithCommands ( )

同步报告与命令。
在NX11.0.0版本创建。

许可要求: 无

◆ TemplateFile()

NXString NXOpen::Report::Report::TemplateFile ( )

返回模板文档文件路径。
在NX11.0.0版本创建。

许可要求: 无