Represents an PDM::EffectivityAttributePropertiesBuilder to be used for creating effectivity attributes. More...

Inheritance diagram for NXOpen::PDM::EffectivityAttributePropertiesBuilder:

Public Member Functions
NXString	Category ()
	Returns the category.

bool	CreateAttribute ()
	Create the attribute from the data set in the builder.

void	Delete (NXOpen::NXObject *object)
	Delete the attribute from the given object.

NXOpen::PDM::EffectivityTableBuilder *	EffectivityTableBuilder ()
	Returns the effectivity table builder.

NXOpen::SelectNXObjectList *	SelectedObjects ()
	Returns the selected object(s) list.

void	SetAttributeObjects (const std::vector< NXOpen::NXObject * > &objects)
	Sets the array of objects that have this attribute Created in NX8.5.0.

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

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

void	SetStringValue (const NXString &stringValue)
	Sets the string value.

void	SetStringValue (const char *stringValue)
	Sets the string value.

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

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

NXString	StringValue ()
	Returns the string value.

NXString	Title ()
	Returns the attribute title.

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 PDM::EffectivityAttributePropertiesBuilder to be used for creating effectivity attributes.

   The attribute will be distributed to all objects supplied in the selected object list.
<br> To create a new instance of this class, use @link PDM::ConfigurationManager::CreateEffectivityAttributePropertiesBuilder  PDM::ConfigurationManager::CreateEffectivityAttributePropertiesBuilder @endlink  <br>

Created in NX9.0.0.

Member Function Documentation

NXString NXOpen::PDM::EffectivityAttributePropertiesBuilder::Category ( )

Returns the category.

The category is an optional, user-defined string that allows attributes to be grouped together.
Created in NX9.0.0.

License requirements : nx_4gd_integration ("4th Generation Design")

bool NXOpen::PDM::EffectivityAttributePropertiesBuilder::CreateAttribute ( )

Create the attribute from the data set in the builder.

Unlike calling commit, this method will not perform an update.

Returns: True if the attribute was created/edited successfully
Created in NX9.0.0.

License requirements : nx_4gd_integration ("4th Generation Design")

void NXOpen::PDM::EffectivityAttributePropertiesBuilder::Delete ( NXOpen::NXObject * object )

Delete the attribute from the given object.

Created in NX9.0.0.

License requirements : nx_4gd_integration ("4th Generation Design")

Parameters

object The object containing the attribute

NXOpen::PDM::EffectivityTableBuilder* NXOpen::PDM::EffectivityAttributePropertiesBuilder::EffectivityTableBuilder ( )

Returns the effectivity table builder.

Created in NX9.0.0.

License requirements : None

NXOpen::SelectNXObjectList* NXOpen::PDM::EffectivityAttributePropertiesBuilder::SelectedObjects ( )

Returns the selected object(s) list.

The created attribute will be applied to all objects in this list.
Created in NX9.0.0.

License requirements : nx_4gd_integration ("4th Generation Design")

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

Sets the array of objects that have this attribute
Created in NX8.5.0.

License requirements : nx_4gd_integration ("4th Generation Design")

Parameters

objects the array of objects

void NXOpen::PDM::EffectivityAttributePropertiesBuilder::SetCategory ( const NXString & category )

Sets the category.

The category is an optional, user-defined string that allows attributes to be grouped together.
Created in NX9.0.0.

License requirements : nx_4gd_integration ("4th Generation Design")

Parameters

category category

void NXOpen::PDM::EffectivityAttributePropertiesBuilder::SetCategory ( const char * category )

Sets the category.

The category is an optional, user-defined string that allows attributes to be grouped together.
Created in NX9.0.0.

License requirements : nx_4gd_integration ("4th Generation Design")

Parameters

category category

void NXOpen::PDM::EffectivityAttributePropertiesBuilder::SetStringValue ( const NXString & stringValue )

Sets the string value.

Required if creating an attribute of type String.
Created in NX9.0.0.

License requirements : nx_4gd_integration ("4th Generation Design")

Parameters

stringValue stringvalue

void NXOpen::PDM::EffectivityAttributePropertiesBuilder::SetStringValue ( const char * stringValue )

Sets the string value.

Required if creating an attribute of type String.
Created in NX9.0.0.

License requirements : nx_4gd_integration ("4th Generation Design")

Parameters

stringValue stringvalue

void NXOpen::PDM::EffectivityAttributePropertiesBuilder::SetTitle ( const NXString & title )

Sets the attribute title.

The title is required for creating an attribute and must be unique on the given object. Once the attribute is created, the title cannot be modified.
Created in NX9.0.0.

License requirements : nx_4gd_integration ("4th Generation Design")

Parameters

title title

void NXOpen::PDM::EffectivityAttributePropertiesBuilder::SetTitle ( const char * title )

Sets the attribute title.

The title is required for creating an attribute and must be unique on the given object. Once the attribute is created, the title cannot be modified.
Created in NX9.0.0.

License requirements : nx_4gd_integration ("4th Generation Design")

Parameters

title title

NXString NXOpen::PDM::EffectivityAttributePropertiesBuilder::StringValue ( )

Returns the string value.

Required if creating an attribute of type String.
Created in NX9.0.0.

License requirements : nx_4gd_integration ("4th Generation Design")

NXString NXOpen::PDM::EffectivityAttributePropertiesBuilder::Title ( )

Returns the attribute title.

The title is required for creating an attribute and must be unique on the given object. Once the attribute is created, the title cannot be modified.
Created in NX9.0.0.

License requirements : nx_4gd_integration ("4th Generation Design")

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

PDM_EffectivityAttributePropertiesBuilder.hxx

Public Member Functions

Detailed Description

Member Function Documentation