nxopen.pdm

Interface EffectivityAttributePropertiesBuilder

All Superinterfaces:

Builder, IComponentBuilder, Remote, TaggedObject

public interface EffectivityAttributePropertiesBuilder
extends Builder

Represents an EffectivityAttributePropertiesBuilder to be used for creating effectivity attributes. The attribute will be distributed to all objects supplied in the selected object list.
To create a new instance of this class, use ConfigurationManager.createEffectivityAttributePropertiesBuilder(nxopen.BasePart, nxopen.NXObject[])

Created in NX9.0.0

Method Summary

Modifier and Type	Method and Description
String	category() Returns the category.
boolean	createAttribute() Create the attribute from the data set in the builder.
void	delete(NXObject object) Delete the attribute from the given object.
String	displayValue() Returns the display value.
EffectivityTableBuilder	effectivityTableBuilder() Returns the effectivity table builder.
SelectNXObjectList	selectedObjects() Returns the selected object(s) list.
void	setAttributeObjects(NXObject[] objects) Sets the array of objects that have this attribute License requirements: nx_4gd_integration ("4th Generation Design") .
void	setCategory(String category) License requirements: nx_4gd_integration ("4th Generation Design") .
void	setDisplayValue(String displayValue) License requirements: nx_4gd_integration ("4th Generation Design") .
void	setStringValue(String stringValue) License requirements: nx_4gd_integration ("4th Generation Design") .
void	setTitle(String title) License requirements: nx_4gd_integration ("4th Generation Design") .
String	stringValue() Returns the string value.
String	title() Returns the attribute title.

Methods inherited from interface nxopen.Builder

commit, destroy, getCommittedObjects, getObject, showResults

Methods inherited from interface nxopen.TaggedObject

printTestData, printTestData, tag, tagValue

Methods inherited from interface nxopen.geometricutilities.IComponentBuilder

validate

Method Detail

selectedObjects

SelectNXObjectList selectedObjects()
                            throws NXException,
                                   RemoteException

Returns the selected object(s) list. The created attribute will be applied to all objects in this list.
License requirements: nx_4gd_integration ("4th Generation Design")

Created in NX9.0.0

Throws:

NXException

RemoteException

effectivityTableBuilder

EffectivityTableBuilder effectivityTableBuilder()
                                         throws NXException,
                                                RemoteException

Returns the effectivity table builder.
License requirements: None.

Created in NX9.0.0

Throws:

NXException

RemoteException

category

String category()
         throws NXException,
                RemoteException

Returns the category. The category is an optional, user-defined string that allows attributes to be grouped together.
License requirements: nx_4gd_integration ("4th Generation Design")

Created in NX9.0.0

Throws:

NXException

RemoteException

setCategory

void setCategory(String category)
          throws NXException,
                 RemoteException

License requirements: nx_4gd_integration ("4th Generation Design")
.
Created in NX9.0.0

Parameters:

category -

Throws:

NXException

RemoteException

title

String title()
      throws NXException,
             RemoteException

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.
License requirements: nx_4gd_integration ("4th Generation Design")

Created in NX9.0.0

Throws:

NXException

RemoteException

setTitle

void setTitle(String title)
       throws NXException,
              RemoteException

License requirements: nx_4gd_integration ("4th Generation Design")
.
Created in NX9.0.0

Parameters:

title -

Throws:

NXException

RemoteException

stringValue

String stringValue()
            throws NXException,
                   RemoteException

Returns the string value. Required if creating an attribute of type String.
License requirements: nx_4gd_integration ("4th Generation Design")

Created in NX9.0.0

Throws:

NXException

RemoteException

setStringValue

void setStringValue(String stringValue)
             throws NXException,
                    RemoteException

License requirements: nx_4gd_integration ("4th Generation Design")
.
Created in NX9.0.0

Parameters:

stringValue -

Throws:

NXException

RemoteException

displayValue

String displayValue()
             throws NXException,
                    RemoteException

Returns the display value. Required if creating an attribute of type String.
License requirements: nx_4gd_integration ("4th Generation Design")

Created in NX10.0.0

Throws:

NXException

RemoteException

setDisplayValue

void setDisplayValue(String displayValue)
              throws NXException,
                     RemoteException

License requirements: nx_4gd_integration ("4th Generation Design")
.
Created in NX10.0.0

Parameters:

displayValue -

Throws:

NXException

RemoteException

delete

void delete(NXObject object)
     throws NXException,
            RemoteException

Delete the attribute from the given object.
License requirements: nx_4gd_integration ("4th Generation Design")

Created in NX9.0.0

Parameters:

object - The object containing the attribute

Throws:

NXException

RemoteException

createAttribute

boolean createAttribute()
                 throws NXException,
                        RemoteException

Create the attribute from the data set in the builder. Unlike calling commit, this method will not perform an update.
License requirements: nx_4gd_integration ("4th Generation Design")

Created in NX9.0.0

Returns:

True if the attribute was created/edited successfully

Throws:

NXException

RemoteException

setAttributeObjects

void setAttributeObjects(NXObject[] objects)
                  throws NXException,
                         RemoteException

Sets the array of objects that have this attribute
License requirements: nx_4gd_integration ("4th Generation Design")
.
Created in NX8.5.0

Parameters:

objects - the array of objects

Throws:

NXException

RemoteException