TagTableBuilder Class

class NXOpen.Mechatronics.TagTableBuilder

Bases: NXOpen.Builder

Represents a NXOpen.Mechatronics.TagTableBuilder builder.

To create a new instance of this class, use NXOpen.Mechatronics.TagTableCollection.CreateTagTableBuilder()

New in version NX10.0.0.

Properties

Property Description
Name Returns or sets the name.
Tag Returns the Tag for this object.

Methods

Method Description
ChangeId Changes ID.
Commit Commits any edits that have been applied to the builder.
DeleteAllParameters Delete all parameters.
DeleteParameter Delete parameter.
Destroy Deletes the builder, and cleans up any objects created by the builder.
EditBoolParameter Edits bool parameter value.
EditIntParameter Edits Int parameter.
EditListParameter Edits List parameter.
EditRealParameter Edits Real parameter.
EditStringParameter Edits String parameter.
GenerateNewValue Generates new value.
GetBoolParameter Gets bool parameter value.
GetCommittedObjects For builders that create more than one object, this method returns the objects that are created by commit.
GetIds Gets Ids of all values .
GetIntParameter Gets int parameter value.
GetListParameter Gets list parameter value.
GetObject Returns the object currently being edited by this builder.
GetParameterNamesAndTypesByID Gets parameter names and types by value ID.
GetRealParameter Gets real parameter value.
GetStringParameter Gets string parameter value.
Getform Gets selected form NXOpen.Mechatronics.TagFormObject.
MoveParameterDown Move parameter down.
MoveParameterUp Move parameter up.
SetForm Sets the form NXOpen.Mechatronics.TagFormObject object.
ShowResults Updates the model to reflect the result of an edit to the model for all builders that support showing results.
Validate Validate whether the inputs to the component are sufficient for commit to be called.

Property Detail

Name

TagTableBuilder.Name

Returns or sets the name.

-------------------------------------

Getter Method

Signature Name

Returns:
Return type:str

New in version NX10.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature Name

Parameters:name (str) –

New in version NX10.0.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

Method Detail

ChangeId

TagTableBuilder.ChangeId

Changes ID.

Signature ChangeId(oldId, newId)

Parameters:
  • oldId (str) –
  • newId (str) –

New in version NX10.0.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

DeleteAllParameters

TagTableBuilder.DeleteAllParameters

Delete all parameters.

Signature DeleteAllParameters()

New in version NX10.0.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

DeleteParameter

TagTableBuilder.DeleteParameter

Delete parameter.

Signature DeleteParameter(id)

Parameters:id (str) –

New in version NX10.0.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

EditBoolParameter

TagTableBuilder.EditBoolParameter

Edits bool parameter value.

Signature EditBoolParameter(id, name, value)

Parameters:
  • id (str) –
  • name (str) –
  • value (bool) –

New in version NX10.0.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

EditIntParameter

TagTableBuilder.EditIntParameter

Edits Int parameter.

Signature EditIntParameter(id, name, value)

Parameters:
  • id (str) –
  • name (str) –
  • value (int) –

New in version NX10.0.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

EditListParameter

TagTableBuilder.EditListParameter

Edits List parameter.

Signature EditListParameter(id, name, newSelectedIndex)

Parameters:
  • id (str) –
  • name (str) –
  • newSelectedIndex (int) –

New in version NX10.0.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

EditRealParameter

TagTableBuilder.EditRealParameter

Edits Real parameter.

Signature EditRealParameter(id, name, value)

Parameters:
  • id (str) –
  • name (str) –
  • value (float) –

New in version NX10.0.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

EditStringParameter

TagTableBuilder.EditStringParameter

Edits String parameter.

Signature EditStringParameter(id, name, value)

Parameters:
  • id (str) –
  • name (str) –
  • value (str) –

New in version NX10.0.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

GenerateNewValue

TagTableBuilder.GenerateNewValue

Generates new value.

Signature GenerateNewValue()

Returns:
Return type:str

New in version NX10.0.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

GetBoolParameter

TagTableBuilder.GetBoolParameter

Gets bool parameter value.

Signature GetBoolParameter(id, name)

Parameters:
  • id (str) –
  • name (str) –
Returns:
Return type:

bool

New in version NX10.0.0.

License requirements: None.

GetIds

TagTableBuilder.GetIds

Gets Ids of all values .

Signature GetIds()

Returns:
Return type:list of str

New in version NX10.0.0.

License requirements: None.

GetIntParameter

TagTableBuilder.GetIntParameter

Gets int parameter value.

Signature GetIntParameter(id, name)

Parameters:
  • id (str) –
  • name (str) –
Returns:
Return type:

int

New in version NX10.0.0.

License requirements: None.

GetListParameter

TagTableBuilder.GetListParameter

Gets list parameter value.

Signature GetListParameter(id, name)

Parameters:
  • id (str) –
  • name (str) –
Returns:

a tuple
Return type:

A tuple consisting of (values, selectedIndex) values is a list of str. selectedIndex is a int.

New in version NX10.0.0.

License requirements: None.

GetParameterNamesAndTypesByID

TagTableBuilder.GetParameterNamesAndTypesByID

Gets parameter names and types by value ID.

Signature GetParameterNamesAndTypesByID(id)

Parameters:id (str) –
Returns:a tuple
Return type:A tuple consisting of (names, types). names is a list of str. types is a list of NXOpen.Mechatronics.ParameterStockBuilderDataType.

New in version NX10.0.0.

License requirements: None.

GetRealParameter

TagTableBuilder.GetRealParameter

Gets real parameter value.

Signature GetRealParameter(id, name)

Parameters:
  • id (str) –
  • name (str) –
Returns:

a tuple
Return type:

A tuple consisting of (value, unit). value is a float. unit is a NXOpen.Unit.

New in version NX10.0.0.

License requirements: None.

GetStringParameter

TagTableBuilder.GetStringParameter

Gets string parameter value.

Signature GetStringParameter(id, name)

Parameters:
  • id (str) –
  • name (str) –
Returns:
Return type:

str

New in version NX10.0.0.

License requirements: None.

Getform

TagTableBuilder.Getform

Gets selected form NXOpen.Mechatronics.TagFormObject.

Signature Getform()

Returns:
Return type:NXOpen.Mechatronics.TagFormObject

New in version NX10.0.0.

License requirements: None.

MoveParameterDown

TagTableBuilder.MoveParameterDown

Move parameter down.

Signature MoveParameterDown(id)

Parameters:id (str) –

New in version NX10.0.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

MoveParameterUp

TagTableBuilder.MoveParameterUp

Move parameter up.

Signature MoveParameterUp(id)

Parameters:id (str) –

New in version NX10.0.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

SetForm

TagTableBuilder.SetForm

Sets the form NXOpen.Mechatronics.TagFormObject object.

Signature SetForm(form)

Parameters:form (NXOpen.Mechatronics.TagFormObject) –

New in version NX10.0.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

Validate

TagTableBuilder.Validate

Validate whether the inputs to the component are sufficient for commit to be called.

If the component is not in a state to commit then an exception is thrown. For example, if the component requires you to set some property, this method will throw an exception if you haven’t set it. This method throws a not-yet-implemented NXException for some components.

Signature Validate()

Returns:Was self validation successful
Return type:bool

New in version NX3.0.1.

License requirements: None.