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

属性属性基础构建器 更多...

#include <AttributePropertiesBaseBuilder.hxx>

类 NXOpen::AttributePropertiesBaseBuilder 继承关系图:
NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder NXOpen::AttributePropertiesBuilder NXOpen::PDM::PartOperationAttributePropertiesBuilder NXOpen::PDM::PartOperationValidationPropertiesBuilder NXOpen::PDM::PdmCopyOrEditOperationAttributePropertiesBuilder

Public 类型

enum  BooleanValueOptions { BooleanValueOptionsFalse , BooleanValueOptionsTrue }
enum  DataTypeOptions {
  DataTypeOptionsNull , DataTypeOptionsBoolean , DataTypeOptionsInteger , DataTypeOptionsNumber ,
  DataTypeOptionsString , DataTypeOptionsDate
}

Public 成员函数

bool ApplyUnits ()
int ArrayIndex ()
NXOpen::AttributePropertiesBaseBuilder::BooleanValueOptions BooleanValue ()
NXString Category ()
bool CreateAttribute ()
NXOpen::AttributePropertiesBaseBuilder::DataTypeOptions DataType ()
NXOpen::DateBuilderDateValue ()
void Delete (NXOpen::NXObject *object)
void DeleteArray (NXOpen::NXObject *object)
NXOpen::ExpressionExpression ()
void GetDateListOfValues (std::vector< NXOpen::DateItemBuilder * > &values)
void GetDoubleListOfValues (std::vector< double > &values)
void GetIntegerListOfValues (std::vector< int > &values)
void GetStringListOfValues (std::vector< NXString > &values)
int IntegerValue ()
bool IsArray ()
bool IsReferenceType ()
bool LockOnSave ()
double NumberValue ()
enum NX_DEPRECATED ("Deprecated in NX8.5.0. Use NXOpen::AttributePropertiesBaseBuilder::SetAttributeObjects instead.") ObjectOptions
NXOpen::SelectNXObjectListSelectedObjects ()
void SetArray (bool isArray)
void SetArrayIndex (int arrayIndex)
void SetAttributeObjects (const std::vector< NXOpen::NXObject * > &objects)
void SetBooleanValue (NXOpen::AttributePropertiesBaseBuilder::BooleanValueOptions boolValue)
void SetCategory (const char *category)
void SetCategory (const NXString &category)
void SetDataType (NXOpen::AttributePropertiesBaseBuilder::DataTypeOptions dataType)
void SetExpression (NXOpen::Expression *expression)
void SetIntegerValue (int integerValue)
void SetLockOnSave (bool lockOnSave)
void SetNumberValue (double numberValue)
void SetReferenceType (bool isReferenceType)
void SetStringValue (const char *stringValue)
void SetStringValue (const NXString &stringValue)
void SetTitle (const char *title)
void SetTitle (const NXString &title)
void SetUnits (const char *units)
void SetUnits (const NXString &units)
void SetValueAlias (const char *valueAlias)
void SetValueAlias (const NXString &valueAlias)
NXString StringValue ()
NXString Title ()
NXString Units ()
NXString ValueAlias ()
Public 成员函数 继承自 NXOpen::Builder
NXOpen::NXObjectCommit ()
void Destroy ()
std::vector< NXOpen::NXObject * > GetCommittedObjects ()
NXOpen::NXObjectGetObject ()
NXOpen::PreviewBuilderPreviewBuilder ()
void ShowResults ()
virtual bool Validate ()
Public 成员函数 继承自 NXOpen::TaggedObject
tag_t Tag () const

友元

class _AttributePropertiesBaseBuilderBuilder

详细描述

属性属性基础构建器

表示用于创建属性的 NXOpen::AttributePropertiesBaseBuilder。 基本属性包含标题、类型和值。属性有六种类型: 空、布尔、整数、数字、字符串和日期。类型决定了创建时将读取哪个值字段。 属性可以引用表达式而不是设置值。在这种情况下,被引用表达式的值也将作为属性的值,并在表达式更改时更新。 如果存在与属性同名的属性模板,则该属性将继承相应模板的所有特性(包括类型)。 属性模板驻留在部件级别,并为引用属性提供额外信息。它们使用 NXOpen::AttributeTemplatesBuilder 创建。 属性将被分发到所选对象列表中提供的所有对象。
这是一个抽象类,无法实例化。

创建于 NX8.0.0。

成员枚举类型说明

◆ BooleanValueOptions

布尔类型属性的值选项

枚举值
BooleanValueOptionsFalse 

BooleanValueOptionsTrue 

◆ DataTypeOptions

指定属性的数据类型,属性创建后无法更改

枚举值
DataTypeOptionsNull 

空,属性没有值

DataTypeOptionsBoolean 

布尔,值为真或假

DataTypeOptionsInteger 

整数,值为整数

DataTypeOptionsNumber 

数字,值为浮点数且可包含单位

DataTypeOptionsString 

字符串,值为文本字符串

DataTypeOptionsDate 

日期,值为日期和时间

成员函数说明

◆ ApplyUnits()

bool NXOpen::AttributePropertiesBaseBuilder::ApplyUnits ( )

将构建器上当前设置的单位应用于任何为当前属性设置了值的对象。此方法不应用构建器上设置的当前值。 应使用 NXOpen::AttributePropertiesBaseBuilder::CreateAttribute 来执行此操作。

返回
如果属性更新成功则为 True
创建于 NX11.0.0。

许可要求:无

◆ ArrayIndex()

int NXOpen::AttributePropertiesBaseBuilder::ArrayIndex ( )

获取数组索引。修改具有多个值的属性时需要。IsArray 标志也必须设置。
创建于 NX8.0.0。

许可要求:无

◆ BooleanValue()

NXOpen::AttributePropertiesBaseBuilder::BooleanValueOptions NXOpen::AttributePropertiesBaseBuilder::BooleanValue ( )

返回布尔值。创建布尔类型属性时必须设置。
创建于 NX8.0.0。

许可要求:无

◆ Category()

NXString NXOpen::AttributePropertiesBaseBuilder::Category ( )

返回对象选择器。这决定了属性将应用于哪些对象。如果被修改,选定对象列表将根据此值更改。

弃用
Deprecated in NX10.0.0. 请改用 NXOpen::AttributePropertiesBaseBuilder::SetAttributeObjects

Created in NX8.0.0.

License requirements : None

设置对象选择器。这决定了属性将应用于哪些对象。如果被修改,选定对象列表将根据此值更改。

弃用
Deprecated in NX10.0.0. 请改用 NXOpen::AttributePropertiesBaseBuilder::SetAttributeObjects

Created in NX8.0.0.

License requirements : None

objectpicker 返回类别。类别是一个可选的、用户定义的字符串,允许将属性分组在一起。
Created in NX8.0.0.

License requirements : None

◆ CreateAttribute()

bool NXOpen::AttributePropertiesBaseBuilder::CreateAttribute ( )

使用构建器中设置的数据创建属性。与调用提交不同,此方法不会执行更新。

返回
如果属性创建/编辑成功则为 True
创建于 NX8.0.0。

许可要求:无

◆ DataType()

NXOpen::AttributePropertiesBaseBuilder::DataTypeOptions NXOpen::AttributePropertiesBaseBuilder::DataType ( )

返回数据类型,该类型决定了要创建的属性类型。属性创建后,数据类型无法修改。
Created in NX8.0.0.

License requirements : None

◆ DateValue()

NXOpen::DateBuilder * NXOpen::AttributePropertiesBaseBuilder::DateValue ( )

返回日期值。该日期对象将包含日期类型属性的值。
创建于 NX8.0.0。

许可要求:无

◆ Delete()

void NXOpen::AttributePropertiesBaseBuilder::Delete ( NXOpen::NXObject * object)

从给定对象中删除属性。
创建于 NX8.0.0。

许可要求:无

参数
object包含属性的对象

◆ DeleteArray()

void NXOpen::AttributePropertiesBaseBuilder::DeleteArray ( NXOpen::NXObject * object)

从给定对象中删除属性数组。
创建于 NX8.0.0。

许可要求:无

参数
object包含属性的对象

◆ Expression()

NXOpen::Expression * NXOpen::AttributePropertiesBaseBuilder::Expression ( )

返回从此属性引用的表达式。仅用于数值、整数、布尔和字符串类型的属性。如果引用了表达式,则无需设置任何值字段,因为属性使用表达式的值。
创建于 NX8.0.0。

许可要求:无

◆ GetDateListOfValues()

void NXOpen::AttributePropertiesBaseBuilder::GetDateListOfValues ( std::vector< NXOpen::DateItemBuilder * > & values)

检索与此属性关联的有效日期值列表。必须先设置属性标题才能查询这些值。值从NX数据模型中的静态LOV检索,因此此调用期间不会进行服务器调用。
创建于 NX2406.0.0。

许可要求:无

参数
values与此属性关联的日期值列表。

◆ GetDoubleListOfValues()

void NXOpen::AttributePropertiesBaseBuilder::GetDoubleListOfValues ( std::vector< double > & values)

检索与此属性关联的有效双精度值列表。必须先设置属性标题才能查询这些值。值从NX数据模型中的静态LOV检索,因此此调用期间不会进行服务器调用。
创建于 NX2406.0.0。

许可要求:无

参数
values与此属性关联的双精度值列表。

◆ GetIntegerListOfValues()

void NXOpen::AttributePropertiesBaseBuilder::GetIntegerListOfValues ( std::vector< int > & values)

检索与此属性关联的有效整数值列表。必须先设置属性标题才能查询这些值。值从NX数据模型中的静态LOV检索,因此此调用期间不会进行服务器调用。
创建于 NX2406.0.0。

许可要求:无

参数
values与此属性关联的整数值列表。

◆ GetStringListOfValues()

void NXOpen::AttributePropertiesBaseBuilder::GetStringListOfValues ( std::vector< NXString > & values)

检索与此属性关联的有效字符串(或字符)值列表。必须先设置属性标题才能查询这些值。值从NX数据模型中的静态LOV检索,因此此调用期间不会进行服务器调用。
创建于 NX2406.0.0。

许可要求:无

参数
values与此属性关联的字符串(或字符)值列表。(如果可能,值将被本地化。)

◆ IntegerValue()

int NXOpen::AttributePropertiesBaseBuilder::IntegerValue ( )

返回整数值。创建整数类型属性时必须设置。
创建于 NX8.0.0。

许可要求:无

◆ IsArray()

bool NXOpen::AttributePropertiesBaseBuilder::IsArray ( )

获取“是否为数组”标志,该标志针对具有多个值的属性设置。当设置此标志时,需要提供索引以指示将修改哪个元素。
创建于 NX8.0.0。

许可要求:无

◆ IsReferenceType()

bool NXOpen::AttributePropertiesBaseBuilder::IsReferenceType ( )

获取是否为引用类型标志,该标志针对链接到系统表达式的属性设置。要创建/编辑引用属性,类型也必须设置为字符串。 如果引用属性不再链接到系统表达式,它将变为字符串属性。
创建于 NX8.0.0。

许可要求:无

◆ LockOnSave()

bool NXOpen::AttributePropertiesBaseBuilder::LockOnSave ( )

获取“保存时锁定”标志,该标志针对在部件保存(并重新加载)后将被锁定的属性设置。
创建于 NX8.0.0。

许可要求:无

◆ NumberValue()

double NXOpen::AttributePropertiesBaseBuilder::NumberValue ( )

返回数值。创建数值类型属性时必须设置。
创建于 NX8.0.0。

许可要求:无

◆ NX_DEPRECATED()

enum NXOpen::AttributePropertiesBaseBuilder::NX_DEPRECATED ( "Deprecated in NX8.5.0. Use NXOpen::AttributePropertiesBaseBuilder::SetAttributeObjects instead." )
inline

指定应用属性时将使用哪个对象。可用选项由传入的对象决定。 如果传入的对象是部件,则不会使用这些选项。

弃用
已在 NX8.5.0 中弃用。请改用 NXOpen::AttributePropertiesBaseBuilder::SetAttributeObjects

将属性应用到所选对象列表中的对象

将属性应用到所选对象列表中的特征

仅将属性应用到引用集

将属性应用到组件的实例。 该实例的所有引用集都将继承此属性。

将属性应用到引用集

将属性应用到组件部件中的对象

将属性作为部件属性应用到组件

所选对象列表中不包含任何对象

◆ SelectedObjects()

NXOpen::SelectNXObjectList * NXOpen::AttributePropertiesBaseBuilder::SelectedObjects ( )

返回选定的对象列表。创建的属性将应用于此列表中的所有对象。
Created in NX8.0.0.

License requirements : None

◆ SetArray()

void NXOpen::AttributePropertiesBaseBuilder::SetArray ( bool isArray)

设置“是否为数组”标志,该标志针对具有多个值的属性设置。当设置此标志时,需要提供索引以指示将修改哪个元素。
创建于 NX8.0.0。

许可要求:无

参数
isArrayisarray

◆ SetArrayIndex()

void NXOpen::AttributePropertiesBaseBuilder::SetArrayIndex ( int arrayIndex)

设置数组索引。修改具有多个值的属性时需要。IsArray 标志也必须设置。
创建于 NX8.0.0。

许可要求:无

参数
arrayIndexarrayindex

◆ SetAttributeObjects()

void NXOpen::AttributePropertiesBaseBuilder::SetAttributeObjects ( const std::vector< NXOpen::NXObject * > & objects)

设置具有此属性的对象数组
创建于 NX8.5.0。

许可要求:无

参数
objects对象数组

◆ SetBooleanValue()

void NXOpen::AttributePropertiesBaseBuilder::SetBooleanValue ( NXOpen::AttributePropertiesBaseBuilder::BooleanValueOptions boolValue)

设置布尔值。创建布尔类型属性时必须设置。
创建于 NX8.0.0。

许可要求:无

参数
boolValue布尔值

◆ SetCategory() [1/2]

void NXOpen::AttributePropertiesBaseBuilder::SetCategory ( const char * category)

设置类别。类别是一个可选的、用户定义的字符串,允许将属性分组在一起。
Created in NX8.0.0.

License requirements : None

参数
categorycategory

◆ SetCategory() [2/2]

void NXOpen::AttributePropertiesBaseBuilder::SetCategory ( const NXString & category)

设置类别。类别是一个可选的、用户定义的字符串,允许将属性分组在一起。
Created in NX8.0.0.

License requirements : None

参数
categorycategory

◆ SetDataType()

void NXOpen::AttributePropertiesBaseBuilder::SetDataType ( NXOpen::AttributePropertiesBaseBuilder::DataTypeOptions dataType)

设置数据类型,该类型决定了要创建的属性类型。属性创建后,数据类型无法修改。
Created in NX8.0.0.

License requirements : None

参数
dataTypedatatype

◆ SetExpression()

void NXOpen::AttributePropertiesBaseBuilder::SetExpression ( NXOpen::Expression * expression)

设置此属性引用的表达式。仅用于数值、整数、布尔和字符串类型的属性。如果引用了表达式,则无需设置任何值字段,因为属性将使用表达式的值。
创建于 NX8.0.0。

许可要求:无

参数
expressionexpression

◆ SetIntegerValue()

void NXOpen::AttributePropertiesBaseBuilder::SetIntegerValue ( int integerValue)

设置整数值。创建整数类型属性时必须设置。
创建于 NX8.0.0。

许可要求:无

参数
integerValue整数值

◆ SetLockOnSave()

void NXOpen::AttributePropertiesBaseBuilder::SetLockOnSave ( bool lockOnSave)

设置“保存时锁定”标志,该标志针对在部件保存(并重新加载)后将被锁定的属性设置。
创建于 NX8.0.0。

许可要求:无

参数
lockOnSavelockonsave

◆ SetNumberValue()

void NXOpen::AttributePropertiesBaseBuilder::SetNumberValue ( double numberValue)

设置数值。创建数值类型属性时必须设置。
创建于 NX8.0.0。

许可要求:无

参数
numberValue数值

◆ SetReferenceType()

void NXOpen::AttributePropertiesBaseBuilder::SetReferenceType ( bool isReferenceType)

设置是否为引用类型标志,该标志针对链接到系统表达式的属性设置。要创建/编辑引用属性,类型也必须设置为字符串。 如果引用属性不再链接到系统系统表达式,它将变为字符串属性。
创建于 NX8.0.0。

许可要求:无

参数
isReferenceTypeisreferencetype

◆ SetStringValue() [1/2]

void NXOpen::AttributePropertiesBaseBuilder::SetStringValue ( const char * stringValue)

设置字符串值。创建字符串类型属性时必须设置。
创建于 NX8.0.0。

许可要求:无

参数
stringValue字符串值

◆ SetStringValue() [2/2]

void NXOpen::AttributePropertiesBaseBuilder::SetStringValue ( const NXString & stringValue)

设置字符串值。创建字符串类型属性时必须设置。
创建于 NX8.0.0。

许可要求:无

参数
stringValue字符串值

◆ SetTitle() [1/2]

void NXOpen::AttributePropertiesBaseBuilder::SetTitle ( const char * title)

设置属性标题。创建属性需要标题,并且在给定对象上必须唯一。属性创建后,标题无法修改。
Created in NX8.0.0.

License requirements : None

参数
titletitle

◆ SetTitle() [2/2]

void NXOpen::AttributePropertiesBaseBuilder::SetTitle ( const NXString & title)

设置属性标题。创建属性需要标题,并且在给定对象上必须唯一。属性创建后,标题无法修改。
Created in NX8.0.0.

License requirements : None

参数
titletitle

◆ SetUnits() [1/2]

void NXOpen::AttributePropertiesBaseBuilder::SetUnits ( const char * units)

设置与数值类型属性关联的单位。属性创建后,度量单位类型(长度、面积等)不可更改,但度量单位内的具体单位(毫米、英尺等)可以更改。
创建于 NX8.0.0。

许可要求:无

参数
units单位

◆ SetUnits() [2/2]

void NXOpen::AttributePropertiesBaseBuilder::SetUnits ( const NXString & units)

设置与数字类型属性关联的单位。属性创建后,单位度量(长度、面积等)无法更改,但度量内的单位(毫米、英尺等)可以更改。
Created in NX8.0.0.

License requirements : None

参数
unitsunits

◆ SetValueAlias() [1/2]

void NXOpen::AttributePropertiesBaseBuilder::SetValueAlias ( const char * valueAlias)

设置值别名。任何属性均可选设置。
创建于 NX10.0.0。

许可要求:无

参数
valueAlias值别名

◆ SetValueAlias() [2/2]

void NXOpen::AttributePropertiesBaseBuilder::SetValueAlias ( const NXString & valueAlias)

设置值别名。任何属性均可选设置。
创建于 NX10.0.0。

许可要求:无

参数
valueAlias值别名

◆ StringValue()

NXString NXOpen::AttributePropertiesBaseBuilder::StringValue ( )

返回字符串值。创建字符串类型属性时必须设置。
创建于 NX8.0.0。

许可要求:无

◆ Title()

NXString NXOpen::AttributePropertiesBaseBuilder::Title ( )

返回属性标题。创建属性需要标题,并且在给定对象上必须唯一。属性创建后,标题无法修改。
Created in NX8.0.0.

License requirements : None

◆ Units()

NXString NXOpen::AttributePropertiesBaseBuilder::Units ( )

返回与数字类型属性关联的单位。属性创建后,单位度量(长度、面积等)无法更改,但度量内的单位(毫米、英尺等)可以更改。
Created in NX8.0.0.

License requirements : None

◆ ValueAlias()

NXString NXOpen::AttributePropertiesBaseBuilder::ValueAlias ( )

返回值别名。任何属性均可选设置。
创建于 NX10.0.0。

许可要求:无