Represents an AttributeTemplatesBuilder to be used when creating attribute templates. More...

Inheritance diagram for NXOpen::AttributeTemplatesBuilder:

Public Types
enum	AccessKey { AccessKeyPart, AccessKeyReferenceSet, AccessKeyComponentInstance, AccessKeyComponentOccurrence, AccessKeyObjects }
	Specifies the available access keys that determine which objects will have access to this attribute template. More...

enum	ConstraintOptions { ConstraintOptionsNone, ConstraintOptionsUpperLimit, ConstraintOptionsLowerLimit, ConstraintOptionsUpperAndLowerLimit, ConstraintOptionsList }
	Specifies the constraint data associated with the template. More...

enum	DefaultBooleanOptions { DefaultBooleanOptionsTrue, DefaultBooleanOptionsFalse }
	Specifies the default value for a template of type Boolean. More...

enum	TemplatesOptions { TemplatesOptionsPart, TemplatesOptionsCatalog }
	Specifies the templates option when setting or displaying templates. More...

Public Member Functions
void	AddAccessKey (NXOpen::AttributeTemplatesBuilder::AccessKey accessKey)
	Add a new access key to the list of access keys.

NXString	Alias ()
	Returns the Alias.

bool	AllowMultipleValues ()
	Returns the flag specifying if an attribute can contain multiple values.

NXString	CatalogFilename ()
	Returns the catalog filename.

NXString	Category ()
	Returns the category.

NXOpen::AttributeTemplatesBuilder::ConstraintOptions	Constraint ()
	Returns the constraint.

bool	CopyAttributeOnObjectCopy ()
	Returns the flag specifying whether the attribute should be copied when the object is copied.

NXOpen::AttributePropertiesBaseBuilder::DataTypeOptions	DataType ()
	Returns the data type.

NXOpen::DateBuilder *	DateConstraint ()
	Returns the date constraint.

NXOpen::AttributeTemplatesBuilder::DefaultBooleanOptions	DefaultBoolean ()
	Returns the default boolean.

NXOpen::DateBuilder *	DefaultDate ()
	Returns the default date.

int	DefaultInteger ()
	Returns the default integer.

double	DefaultNumber ()
	Returns the default number.

NXString	DefaultString ()
	Returns the default string.

bool	Delete (const NXString &title, NXOpen::AttributePropertiesBaseBuilder::DataTypeOptions type)
	Delete an attribute template by specifying the title and type of the template.

bool	Delete (const char *title, NXOpen::AttributePropertiesBaseBuilder::DataTypeOptions type)
	Delete an attribute template by specifying the title and type of the template.

bool	EnforcedConstraints ()
	Returns the enforced constraints.

void	ExportCatalog ()
	Exports templates to a specified external catalog.

std::vector < NXOpen::AttributeTemplatesBuilder::AccessKey >	GetAccessKeys ()
	Get the access keys.

std::vector< NXString >	GetIntegerList ()
	Returns the integer list.

std::vector< NXString >	GetNote ()
	Returns the note.

std::vector< NXString >	GetNumberList ()
	Returns the number list.

std::vector< NXString >	GetStringList ()
	Returns the string list.

void	ImportCatalog ()
	Imports templates from a specified external catalog.

bool	LockOnSave ()
	Returns the flag specifying if the attribute should be locked on save.

int	MaxInteger ()
	Returns the max integer.

double	MaxNumber ()
	Returns the max number.

NXString	MaxString ()
	Returns the max string.

int	MinInteger ()
	Returns the min integer.

double	MinNumber ()
	Returns the min number.

NXString	MinString ()
	Returns the min string.

bool	Persistent ()
	Returns the persistent flag.

NXString	ProxyAttributeForLocking ()
	Returns the proxy attribute for locking.

void	RemoveAccessKey (NXOpen::AttributeTemplatesBuilder::AccessKey accessKey)
	Remove an access key from the list of access keys.

void	SetAccessKeys (const std::vector< NXOpen::AttributeTemplatesBuilder::AccessKey > &accessKeys)
	Set the access keys.

void	SetAlias (const NXString &alias)
	Sets the Alias.

void	SetAlias (const char *alias)
	Sets the Alias.

void	SetAllowMultipleValues (bool array)
	Sets the flag specifying if an attribute can contain multiple values.

void	SetCatalogFilename (const NXString &catalogFilename)
	Sets the catalog filename.

void	SetCatalogFilename (const char *catalogFilename)
	Sets the catalog filename.

void	SetCategory (const NXString &category)
	Sets the category.

void	SetCategory (const char *category)
	Sets the category.

void	SetConstraint (NXOpen::AttributeTemplatesBuilder::ConstraintOptions constraint)
	Sets the constraint.

void	SetCopyAttributeOnObjectCopy (bool copyAttributeOnObjectCopy)
	Sets the flag specifying whether the attribute should be copied when the object is copied.

void	SetDataType (NXOpen::AttributePropertiesBaseBuilder::DataTypeOptions dataType)
	Sets the data type.

void	SetDefaultBoolean (NXOpen::AttributeTemplatesBuilder::DefaultBooleanOptions defaultBoolean)
	Sets the default boolean.

void	SetDefaultInteger (int defaultInteger)
	Sets the default integer.

void	SetDefaultNumber (double defaultNumber)
	Sets the default number.

void	SetDefaultString (const NXString &defaultString)
	Sets the default string.

void	SetDefaultString (const char *defaultString)
	Sets the default string.

void	SetEnforcedConstraints (bool enforcedConstraints)
	Sets the enforced constraints.

void	SetIntegerList (const std::vector< NXString > &integerList)
	Sets the integer list.

void	SetLockOnSave (bool lockOnSave)
	Sets the flag specifying if the attribute should be locked on save.

void	SetMaxInteger (int maxInteger)
	Sets the max integer.

void	SetMaxNumber (double maxNumber)
	Sets the max number.

void	SetMaxString (const NXString &maxString)
	Sets the max string.

void	SetMaxString (const char *maxString)
	Sets the max string.

void	SetMinInteger (int minInteger)
	Sets the min integer.

void	SetMinNumber (double minNumber)
	Sets the min number.

void	SetMinString (const NXString &minString)
	Sets the min string.

void	SetMinString (const char *minString)
	Sets the min string.

void	SetNote (const std::vector< NXString > &note)
	Sets the note.

void	SetNumberList (const std::vector< NXString > &numberList)
	Sets the number list.

void	SetPersistent (bool persistent)
	Sets the persistent flag.

void	SetProxyAttributeForLocking (const NXString &proxyAttributeForLocking)
	Sets the proxy attribute for locking.

void	SetProxyAttributeForLocking (const char *proxyAttributeForLocking)
	Sets the proxy attribute for locking.

void	SetStringList (const std::vector< NXString > &stringList)
	Sets the string list.

void	SetTemplates (NXOpen::AttributeTemplatesBuilder::TemplatesOptions dataType)
	Sets the templates option.

void	SetTitle (const NXString &title)
	Sets the title.

void	SetTitle (const char *title)
	Sets the title.

void	SetUnits (const NXString &units)
	Sets the units.

void	SetUnits (const char *units)
	Sets the units.

NXOpen::AttributeTemplatesBuilder::TemplatesOptions	Templates ()
	Returns the templates option.

NXString	Title ()
	Returns the title.

NXString	Units ()
	Returns the units.

void	UpdateTemplates ()
	Update templates in the part from the external catalog defined in customer defaults.

Public Member Functions inherited from NXOpen::Builder
NXOpen::NXObject *	Commit ()
	Commits any edits that have been applied to the builder.

void	Destroy ()
	Deletes the builder, and cleans up any objects created by the builder.

std::vector< NXOpen::NXObject * >	GetCommittedObjects ()
	For builders that create more than one object, this method returns the objects that are created by commit.

NXOpen::NXObject *	GetObject ()
	Returns the object currently being edited by this builder.

void	ShowResults ()
	Updates the model to reflect the result of an edit to the model for all builders that support showing results.

virtual bool	Validate ()
	Validate whether the inputs to the component are sufficient for commit to be called.

Public Member Functions inherited from NXOpen::TaggedObject
tag_t	GetTag () const
	<b>Deprecated</b>:<br> Use Tag instead.

tag_t	Tag () const
	Returns the tag of this object.

Detailed Description

Represents an AttributeTemplatesBuilder to be used when creating attribute templates.

An attribute template is optional for an attribute and lives in the depository. It's main purpose is to provide extra data to further describe a referencing attribute. All attributes that are created from a template will take on the characteristics of the template, most notable the title, type, and units (for templates of type number only). The template contains other data, such as input assisting data (ranges and lists of values) to be used when creating a value on the attribute. The template may also contain a category, which allows attributes to be grouped together and easily sorted. A note may also be set on a template to provide further description about a referencing attribute.

Each template must contain a unique title and a type. If the type is number, then the units must also be set. All other data is optional.

There are six types of attribute templates: Null, Boolean, Integer, Number, String, and Date. Each type requires a title, type, and can optionally contain a note and a category. Other data varies depending on the type. Below describes the differences betweeen the types.

Null - No other data can be set for a template of type Null.

Boolean - A default boolean can be set to True or False. This can be set by calling SetDefaultBoolean.

Integer - A default integer can be set to assist when creating an attribute referencing an integer template. The integer type also allows for constraints to be set. If the constraint is set to Range, then the min integer and max integer need to be set to define the range. If the constraint is set to List, then the value integer list will need to be set to define the acceptable list of values. If constraint is set to None, then no constraints will be enforced. The default value must comply with all constraints in order for the template to be created successfully.

Number - A default floating point number and constraints can be set in the exact same fashion as with the integer, the only difference being that the number fields will be used instead of the integer fields. The units must be set to define the template's measure. Only the measure (Length, Area, Volume, etc) is considered required information, the units themselves (mm, kg, etc) will only be used along with the default value as input assistance when creating an attribute referencing a number template.

String - A default string can be set. The string type also allows for a list of values to be set as input assistance. To do this, the constraint must be set to List and the string list will need to be populated with the desired values. The string type does not allow for the constraint to be set to Range, it must be set to either List or None. The default string must be contained in the list of values if Constraint is set to List.

Date - No other data can be set for a template of type Date. The current date will always be used as input assistance when creating an attribute referencing a date template.

This class will also allow for the import and export of attribute templates. The export feature will save all templates currently in the depository to an external catalog file so they can be imported at a later time to another part file. To use this feature, the catalog filename must be set to specify the external file. Similarly, the import feature will take all templates contained in the specified catalog file and instantiate them in the part. If the title, type, or measure of an imported template conflicts with a template already in the depository, then the template will not be imported. If the optional data of an imported template conflicts with a template already in the depository, then the data from the imported template will overwrite the data in the depository.
To create a new instance of this class, use PropertiesManager::CreateAttributeTemplatesBuilder
Default values.

Property

Value

Constraint

None

CopyAttributeOnObjectCopy

True

DataType

String

DefaultBoolean

True

DefaultInteger

0

DefaultNumber

0

MaxInteger

0

MaxNumber

0

MinInteger

0

MinNumber

0

ProxyAttributeForLocking

Created in NX8.0.0.

Member Enumeration Documentation

enum NXOpen::AttributeTemplatesBuilder::AccessKey

Specifies the available access keys that determine which objects will have access to this attribute template.

Enumerator:

AccessKeyPart	This attribute template will be accessible by parts.
AccessKeyReferenceSet	This attribute template will be accessible by reference sets.
AccessKeyComponentInstance	This attribute template will be accessible by component instances.
AccessKeyComponentOccurrence	This attribute template will be accessible by component occurrences.
AccessKeyObjects	This attribute template will be accessible by all non-part related objects including solids, features, etc.

enum NXOpen::AttributeTemplatesBuilder::ConstraintOptions

Specifies the constraint data associated with the template.

All constraints are enabled for templates of type integer, number, string, and date.

Enumerator:

ConstraintOptionsNone	No constraint data, no further action is needed.
ConstraintOptionsUpperLimit	This template has an upper limit but no lower limit. The max value must be set. Available for integer, number, string, and date types.
ConstraintOptionsLowerLimit	This template has a lower limit but no upper limit. The min value must be set. Available for integer, number, string, and date types.
ConstraintOptionsUpperAndLowerLimit	This template has a lower limit and an upper limit. The min and max must also be set. Available for integer, number, string, and date types.
ConstraintOptionsList	List of values, the value list must also be set. Only available for integer, number, and string types.

enum NXOpen::AttributeTemplatesBuilder::DefaultBooleanOptions

Specifies the default value for a template of type Boolean.

Enumerator:

DefaultBooleanOptionsTrue	True.
DefaultBooleanOptionsFalse	False.

enum NXOpen::AttributeTemplatesBuilder::TemplatesOptions

Specifies the templates option when setting or displaying templates.

Enumerator:

TemplatesOptionsPart

Templates currently residing in the part.

TemplatesOptionsCatalog

Templates currently residing in the loaded catalog.

These are initially loaded from the external file specified in customer defaults and can be managed using Import and Export. Each template in the catalog can be defined as persistent or transient. A persistent template will be copied into the part when an attribute is created. A transient template will assist in the creation of an attribute but will not be stored in the part.

Member Function Documentation

void NXOpen::AttributeTemplatesBuilder::AddAccessKey ( NXOpen::AttributeTemplatesBuilder::AccessKey accessKey )

Add a new access key to the list of access keys.

If this access key alreadys exists, it will not be added.
Created in NX8.0.0.

License requirements : None

Parameters

accessKey accesskey

NXString NXOpen::AttributeTemplatesBuilder::Alias ( )

Returns the Alias.

This is the alias or synonym for the title of the template and must be unique.
Created in NX8.0.0.

License requirements : None

bool NXOpen::AttributeTemplatesBuilder::AllowMultipleValues ( )

Returns the flag specifying if an attribute can contain multiple values.

       If true, then any attributes created from this template will be treated as a VLA (variable length array)
       and will support multiple values.

Created in NX8.0.0.

License requirements : None

NXString NXOpen::AttributeTemplatesBuilder::CatalogFilename ( )

Returns the catalog filename.

Used during import and export of catalogs. This should be set to a full path location on disk.
Created in NX8.0.0.

License requirements : None

NXString NXOpen::AttributeTemplatesBuilder::Category ( )

Returns the category.

Optional category for templates of all types. This allows for templates to be grouped together.
Created in NX8.0.0.

License requirements : None

NXOpen::AttributeTemplatesBuilder::ConstraintOptions NXOpen::AttributeTemplatesBuilder::Constraint ( )

Returns the constraint.

Informs the template which method of constraints to use. If constraints are used the default value must satisfy the given constraints. Constraints are supported by templates of type Integer, Number, String, and Date.
Created in NX8.0.0.

License requirements : None

bool NXOpen::AttributeTemplatesBuilder::CopyAttributeOnObjectCopy ( )

Returns the flag specifying whether the attribute should be copied when the object is copied.

If false, the attribute copy is disallowed.
Created in NX8.0.0.

License requirements : None

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

Returns the data type.

Must be set for each template and cannot be changed once the template has been created.
Created in NX8.0.0.

License requirements : None

NXOpen::DateBuilder* NXOpen::AttributeTemplatesBuilder::DateConstraint ( )

Returns the date constraint.

Only used if the data type is Date. The default date must satisfy the constraints defined by this object.
Created in NX8.0.0.

License requirements : None

NXOpen::AttributeTemplatesBuilder::DefaultBooleanOptions NXOpen::AttributeTemplatesBuilder::DefaultBoolean ( )

Returns the default boolean.

Optional default value for a template of type Boolean.
Created in NX8.0.0.

License requirements : None

NXOpen::DateBuilder* NXOpen::AttributeTemplatesBuilder::DefaultDate ( )

Returns the default date.

Optional if no date constraints exists, otherwise it must satisfy the constraint data.
Created in NX8.0.0.

License requirements : None

int NXOpen::AttributeTemplatesBuilder::DefaultInteger ( )

Returns the default integer.

Optional if the constraint is set to None, otherwise it must satisfy the constraint data.
Created in NX8.0.0.

License requirements : None

double NXOpen::AttributeTemplatesBuilder::DefaultNumber ( )

Returns the default number.

Optional if the constraint is set to None, otherwise it must satisfy the constraint data.
Created in NX8.0.0.

License requirements : None

NXString NXOpen::AttributeTemplatesBuilder::DefaultString ( )

Returns the default string.

Optional if the constraint is set to None, otherwise it must satisfy the constraint data.
Created in NX8.0.0.

License requirements : None

bool NXOpen::AttributeTemplatesBuilder::Delete	(	const NXString &	title,
		NXOpen::AttributePropertiesBaseBuilder::DataTypeOptions	type
	)

Delete an attribute template by specifying the title and type of the template.

       The template will be deleted from the depository specified by the current 
       Templates Option.  The deleted flag will return true if the template was
       successfully deleted.  @return

Created in NX8.0.0.

License requirements : None

Parameters

title	title
type	type

bool NXOpen::AttributeTemplatesBuilder::Delete	(	const char *	title,
		NXOpen::AttributePropertiesBaseBuilder::DataTypeOptions	type
	)

Delete an attribute template by specifying the title and type of the template.

       The template will be deleted from the depository specified by the current 
       Templates Option.  The deleted flag will return true if the template was
       successfully deleted.  @return

Created in NX8.0.0.

License requirements : None

Parameters

title	title
type	type

bool NXOpen::AttributeTemplatesBuilder::EnforcedConstraints ( )

Returns the enforced constraints.

Determines if the template constraints will be enforced.
Created in NX8.0.0.

License requirements : None

void NXOpen::AttributeTemplatesBuilder::ExportCatalog ( )

Exports templates to a specified external catalog.

All templates from the loaded catalog will be saved to disk at the location specified by the catalog filename. Any templates the previously existed in the external catalog will be deleted.

The catalog filename must be set to the location of the external catalog on disk.
Created in NX8.0.0.

License requirements : None

std::vector<NXOpen::AttributeTemplatesBuilder::AccessKey> NXOpen::AttributeTemplatesBuilder::GetAccessKeys ( )

Get the access keys.

The access keys define which objects will have access to this attribute template.

Returns: Created in NX8.0.0.

License requirements : None

std::vector<NXString> NXOpen::AttributeTemplatesBuilder::GetIntegerList ( )

Returns the integer list.

Only valid if the type is Integer and the contraint is set to list.

Returns: Created in NX8.0.0.

License requirements : None

std::vector<NXString> NXOpen::AttributeTemplatesBuilder::GetNote ( )

Returns the note.

Optional data for templates of all types.

Returns: Created in NX8.0.0.

License requirements : None

std::vector<NXString> NXOpen::AttributeTemplatesBuilder::GetNumberList ( )

Returns the number list.

Only valid if the type is Number and the contraint is set to list.

Returns: Created in NX8.0.0.

License requirements : None

std::vector<NXString> NXOpen::AttributeTemplatesBuilder::GetStringList ( )

Returns the string list.

Only valid if the type is String and the contraint is set to list.

Returns: Created in NX8.0.0.

License requirements : None

void NXOpen::AttributeTemplatesBuilder::ImportCatalog ( )

Imports templates from a specified external catalog.

The current catalog of templates will be erased and replaced with the templates from the external catalog. Import will not instantiate templates in the part, it only modifies what templates are currently available in the loaded catalog.

The catalog filename must be set to the location of the external catalog on disk.
Created in NX8.0.0.

License requirements : None

bool NXOpen::AttributeTemplatesBuilder::LockOnSave ( )

Returns the flag specifying if the attribute should be locked on save.

       If true, then any attributes created from this template will become locked when the part is saved (and reloaded).

Created in NX8.0.0.

License requirements : None

int NXOpen::AttributeTemplatesBuilder::MaxInteger ( )

Returns the max integer.

Only to be set if the data type is Integer and the constraint specifies an upper limit. The default integer value must be less than or equal to this value.
Created in NX8.0.0.

License requirements : None

double NXOpen::AttributeTemplatesBuilder::MaxNumber ( )

Returns the max number.

Only to be set if the data type is Number and the constraint specifies an upper limit. The default number value must be less than or equal to this value.
Created in NX8.0.0.

License requirements : None

NXString NXOpen::AttributeTemplatesBuilder::MaxString ( )

Returns the max string.

Only to be set if the data type is String and the constraint specifies an upper limit. The default string value must be less than or equal to this value.
Created in NX8.0.0.

License requirements : None

int NXOpen::AttributeTemplatesBuilder::MinInteger ( )

Returns the min integer.

Only to be set if the data type is Integer and the constraint specifies a lower limit. The default integer value must be greater than or equal to this value.
Created in NX8.0.0.

License requirements : None

double NXOpen::AttributeTemplatesBuilder::MinNumber ( )

Returns the min number.

Only to be set if the data type is Number and the constraint specifies a lower limit. The default number value must be greater than or equal to this value.
Created in NX8.0.0.

License requirements : None

NXString NXOpen::AttributeTemplatesBuilder::MinString ( )

Returns the min string.

Only to be set if the data type is String and the constraint specifies a lower limit. The default string value must be greater than or equal to this value.
Created in NX8.0.0.

License requirements : None

bool NXOpen::AttributeTemplatesBuilder::Persistent ( )

Returns the persistent flag.

If a template is marked as persistent, then the template will be saved with the part when a template attribute is created. This flag is only used when editing templates in the catalog file, during which the default is false. If editing templates in the part, the template will be created in the part, making it persistent by definition.
Created in NX8.0.0.

License requirements : None

NXString NXOpen::AttributeTemplatesBuilder::ProxyAttributeForLocking ( )

Returns the proxy attribute for locking.

This must be PDM attribute available in the Access Control List. This functionality is available only in managed mode. Specify relevent proxy attribute based on NXOpen::AttributeTemplatesBuilder::TemplatesOptions .

Created in NX8.0.0.

License requirements : None

void NXOpen::AttributeTemplatesBuilder::RemoveAccessKey ( NXOpen::AttributeTemplatesBuilder::AccessKey accessKey )

Remove an access key from the list of access keys.

Created in NX8.0.0.

License requirements : None

Parameters

accessKey accesskey

void NXOpen::AttributeTemplatesBuilder::SetAccessKeys ( const std::vector< NXOpen::AttributeTemplatesBuilder::AccessKey > & accessKeys )

Set the access keys.

The access keys define which objects will have access to this attribute template. If no access keys are provided, the attribute template will be visible to all objects.
Created in NX8.0.0.

License requirements : None

Parameters

accessKeys accesskeys

void NXOpen::AttributeTemplatesBuilder::SetAlias ( const NXString & alias )

Sets the Alias.

This is the alias or synonym for the title of the template and must be unique.
Created in NX8.0.0.

License requirements : None

Parameters

alias alias

void NXOpen::AttributeTemplatesBuilder::SetAlias ( const char * alias )

Sets the Alias.

This is the alias or synonym for the title of the template and must be unique.
Created in NX8.0.0.

License requirements : None

Parameters

alias alias

void NXOpen::AttributeTemplatesBuilder::SetAllowMultipleValues ( bool array )

Sets the flag specifying if an attribute can contain multiple values.

       If true, then any attributes created from this template will be treated as a VLA (variable length array)
       and will support multiple values.

Created in NX8.0.0.

License requirements : None

Parameters

array array

void NXOpen::AttributeTemplatesBuilder::SetCatalogFilename ( const NXString & catalogFilename )

Sets the catalog filename.

Used during import and export of catalogs. This should be set to a full path location on disk.
Created in NX8.0.0.

License requirements : None

Parameters

catalogFilename catalogfilename

void NXOpen::AttributeTemplatesBuilder::SetCatalogFilename ( const char * catalogFilename )

Sets the catalog filename.

Used during import and export of catalogs. This should be set to a full path location on disk.
Created in NX8.0.0.

License requirements : None

Parameters

catalogFilename catalogfilename

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

Sets the category.

Optional category for templates of all types. This allows for templates to be grouped together.
Created in NX8.0.0.

License requirements : None

Parameters

category category

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

Sets the category.

Optional category for templates of all types. This allows for templates to be grouped together.
Created in NX8.0.0.

License requirements : None

Parameters

category category

void NXOpen::AttributeTemplatesBuilder::SetConstraint ( NXOpen::AttributeTemplatesBuilder::ConstraintOptions constraint )

Sets the constraint.

Informs the template which method of constraints to use. If constraints are used the default value must satisfy the given constraints. Constraints are supported by templates of type Integer, Number, String, and Date.
Created in NX8.0.0.

License requirements : None

Parameters

constraint constraint

void NXOpen::AttributeTemplatesBuilder::SetCopyAttributeOnObjectCopy ( bool copyAttributeOnObjectCopy )

Sets the flag specifying whether the attribute should be copied when the object is copied.

If false, the attribute copy is disallowed.
Created in NX8.0.0.

License requirements : None

Parameters

copyAttributeOnObjectCopy copyattributeonobjectcopy

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

Sets the data type.

Must be set for each template and cannot be changed once the template has been created.
Created in NX8.0.0.

License requirements : None

Parameters

dataType datatype

void NXOpen::AttributeTemplatesBuilder::SetDefaultBoolean ( NXOpen::AttributeTemplatesBuilder::DefaultBooleanOptions defaultBoolean )

Sets the default boolean.

Optional default value for a template of type Boolean.
Created in NX8.0.0.

License requirements : None

Parameters

defaultBoolean defaultboolean

void NXOpen::AttributeTemplatesBuilder::SetDefaultInteger ( int defaultInteger )

Sets the default integer.

Optional if the constraint is set to None, otherwise it must satisfy the constraint data.
Created in NX8.0.0.

License requirements : None

Parameters

defaultInteger defaultinteger

void NXOpen::AttributeTemplatesBuilder::SetDefaultNumber ( double defaultNumber )

Sets the default number.

Optional if the constraint is set to None, otherwise it must satisfy the constraint data.
Created in NX8.0.0.

License requirements : None

Parameters

defaultNumber defaultnumber

void NXOpen::AttributeTemplatesBuilder::SetDefaultString ( const NXString & defaultString )

Sets the default string.

Optional if the constraint is set to None, otherwise it must satisfy the constraint data.
Created in NX8.0.0.

License requirements : None

Parameters

defaultString defaultstring

void NXOpen::AttributeTemplatesBuilder::SetDefaultString ( const char * defaultString )

Sets the default string.

Optional if the constraint is set to None, otherwise it must satisfy the constraint data.
Created in NX8.0.0.

License requirements : None

Parameters

defaultString defaultstring

void NXOpen::AttributeTemplatesBuilder::SetEnforcedConstraints ( bool enforcedConstraints )

Sets the enforced constraints.

Determines if the template constraints will be enforced.
Created in NX8.0.0.

License requirements : None

Parameters

enforcedConstraints enforcedconstraints

void NXOpen::AttributeTemplatesBuilder::SetIntegerList ( const std::vector< NXString > & integerList )

Sets the integer list.

Must be set if the type is Integer and the contraint is set to list. The default integer value must be contained in this list.
Created in NX8.0.0.

License requirements : None

Parameters

integerList integerlist

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

Sets the flag specifying if the attribute should be locked on save.

       If true, then any attributes created from this template will become locked when the part is saved (and reloaded).

Created in NX8.0.0.

License requirements : None

Parameters

lockOnSave lockonsave

void NXOpen::AttributeTemplatesBuilder::SetMaxInteger ( int maxInteger )

Sets the max integer.

Only to be set if the data type is Integer and the constraint specifies an upper limit. The default integer value must be less than or equal to this value.
Created in NX8.0.0.

License requirements : None

Parameters

maxInteger maxinteger

void NXOpen::AttributeTemplatesBuilder::SetMaxNumber ( double maxNumber )

Sets the max number.

Only to be set if the data type is Number and the constraint specifies an upper limit. The default number value must be less than or equal to this value.
Created in NX8.0.0.

License requirements : None

Parameters

maxNumber maxnumber

void NXOpen::AttributeTemplatesBuilder::SetMaxString ( const NXString & maxString )

Sets the max string.

Only to be set if the data type is String and the constraint specifies an upper limit. The default string value must be less than or equal to this value.
Created in NX8.0.0.

License requirements : None

Parameters

maxString maxstring

void NXOpen::AttributeTemplatesBuilder::SetMaxString ( const char * maxString )

Sets the max string.

Only to be set if the data type is String and the constraint specifies an upper limit. The default string value must be less than or equal to this value.
Created in NX8.0.0.

License requirements : None

Parameters

maxString maxstring

void NXOpen::AttributeTemplatesBuilder::SetMinInteger ( int minInteger )

Sets the min integer.

Only to be set if the data type is Integer and the constraint specifies a lower limit. The default integer value must be greater than or equal to this value.
Created in NX8.0.0.

License requirements : None

Parameters

minInteger mininteger

void NXOpen::AttributeTemplatesBuilder::SetMinNumber ( double minNumber )

Sets the min number.

Only to be set if the data type is Number and the constraint specifies a lower limit. The default number value must be greater than or equal to this value.
Created in NX8.0.0.

License requirements : None

Parameters

minNumber minnumber

void NXOpen::AttributeTemplatesBuilder::SetMinString ( const NXString & minString )

Sets the min string.

Only to be set if the data type is String and the constraint specifies a lower limit. The default string value must be greater than or equal to this value.
Created in NX8.0.0.

License requirements : None

Parameters

minString minstring

void NXOpen::AttributeTemplatesBuilder::SetMinString ( const char * minString )

Sets the min string.

Only to be set if the data type is String and the constraint specifies a lower limit. The default string value must be greater than or equal to this value.
Created in NX8.0.0.

License requirements : None

Parameters

minString minstring

void NXOpen::AttributeTemplatesBuilder::SetNote ( const std::vector< NXString > & note )

Sets the note.

Optional data for templates of all types.
Created in NX8.0.0.

License requirements : None

Parameters

note note

void NXOpen::AttributeTemplatesBuilder::SetNumberList ( const std::vector< NXString > & numberList )

Sets the number list.

Must be set if the type is Number and the contraint is set to list. The default number value must be contained in this list.
Created in NX8.0.0.

License requirements : None

Parameters

numberList numberlist

void NXOpen::AttributeTemplatesBuilder::SetPersistent ( bool persistent )

Sets the persistent flag.

If a template is marked as persistent, then the template will be saved with the part when a template attribute is created. This flag is only used when editing templates in the catalog file, during which the default is false. If editing templates in the part, the template will be created in the part, making it persistent by definition.
Created in NX8.0.0.

License requirements : None

Parameters

persistent persistent

void NXOpen::AttributeTemplatesBuilder::SetProxyAttributeForLocking ( const NXString & proxyAttributeForLocking )

Sets the proxy attribute for locking.

This must be PDM attribute available in the Access Control List. This functionality is available only in managed mode. Specify relevent proxy attribute based on NXOpen::AttributeTemplatesBuilder::TemplatesOptions .

Created in NX8.0.0.

License requirements : None

Parameters

proxyAttributeForLocking proxyattributeforlocking

void NXOpen::AttributeTemplatesBuilder::SetProxyAttributeForLocking ( const char * proxyAttributeForLocking )

Sets the proxy attribute for locking.

This must be PDM attribute available in the Access Control List. This functionality is available only in managed mode. Specify relevent proxy attribute based on NXOpen::AttributeTemplatesBuilder::TemplatesOptions .

Created in NX8.0.0.

License requirements : None

Parameters

proxyAttributeForLocking proxyattributeforlocking

void NXOpen::AttributeTemplatesBuilder::SetStringList ( const std::vector< NXString > & stringList )

Sets the string list.

Must be set if the type is String and the contraint is set to list. The default string value must be contained in this list.
Created in NX8.0.0.

License requirements : None

Parameters

stringList stringlist

void NXOpen::AttributeTemplatesBuilder::SetTemplates ( NXOpen::AttributeTemplatesBuilder::TemplatesOptions dataType )

Sets the templates option.

This option determines which set of templates will be modified.
Created in NX8.0.0.

License requirements : None

Parameters

dataType datatype

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

Sets the title.

This is the identifier of the template and must be unique.
Created in NX8.0.0.

License requirements : None

Parameters

title title

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

Sets the title.

This is the identifier of the template and must be unique.
Created in NX8.0.0.

License requirements : None

Parameters

title title

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

Sets the units.

Represents the units associated with a template of type Number.
Created in NX8.0.0.

License requirements : None

Parameters

units units

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

Sets the units.

Represents the units associated with a template of type Number.
Created in NX8.0.0.

License requirements : None

Parameters

units units

NXOpen::AttributeTemplatesBuilder::TemplatesOptions NXOpen::AttributeTemplatesBuilder::Templates ( )

Returns the templates option.

This option determines which set of templates will be modified.
Created in NX8.0.0.

License requirements : None

NXString NXOpen::AttributeTemplatesBuilder::Title ( )

Returns the title.

This is the identifier of the template and must be unique.
Created in NX8.0.0.

License requirements : None

NXString NXOpen::AttributeTemplatesBuilder::Units ( )

Returns the units.

Represents the units associated with a template of type Number.
Created in NX8.0.0.

License requirements : None

void NXOpen::AttributeTemplatesBuilder::UpdateTemplates ( )

Update templates in the part from the external catalog defined in customer defaults.

The title and type must match for the update to take place.
Created in NX8.0.0.

License requirements : None

The documentation for this class was generated from the following file:

AttributeTemplatesBuilder.hxx

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Member Function Documentation