ParameterStockBuilder Class

class NXOpen.Mechatronics.ParameterStockBuilder

Bases: NXOpen.Builder

Represents a NXOpen.Mechatronics.ParameterStockBuilder builder.

This class is sub-object of another builder, and cannot be directly instantiated.

New in version NX10.0.0.

Properties

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

Methods

Method Description
AddBoolParameter Adds Bool parameter.
AddIntParameter Adds Int parameter.
AddListParameter Adds List parameter.
AddRealParameter Adds Real parameter.
AddStringParameter Adds String parameter.
Commit Commits any edits that have been applied to the builder.
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.
GetBoolParameter Gets bool parameter value.
GetCommittedObjects For builders that create more than one object, this method returns the objects that are created by commit.
GetIntParameter Gets int parameter value.
GetListParameter Gets list parameter value.
GetObject Returns the object currently being edited by this builder.
GetParameterNamesAndTypes Gets parameter names and types.
GetRealParameter Gets real parameter value.
GetStringParameter Gets string parameter value.
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.

Enumerations

ParameterStockBuilderAssignment Enumeration the assignment for runtime property.
ParameterStockBuilderDataType Enumeration the data type for parameter value.

Property Detail

ApplicationName

ParameterStockBuilder.ApplicationName

Returns or sets the application name.

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

Getter Method

Signature ApplicationName

Returns:
Return type:str

New in version NX10.0.0.

License requirements: None.

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

Setter Method

Signature ApplicationName

Parameters:applicationName (str) –

New in version NX10.0.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

Method Detail

AddBoolParameter

ParameterStockBuilder.AddBoolParameter

Adds Bool parameter.

Signature AddBoolParameter(name, value, predefined, readOnly)

Parameters:
  • name (str) –
  • value (bool) –
  • predefined (bool) –
  • readOnly (bool) –

New in version NX10.0.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

AddIntParameter

ParameterStockBuilder.AddIntParameter

Adds Int parameter.

Signature AddIntParameter(name, value, predefined, readOnly)

Parameters:
  • name (str) –
  • value (int) –
  • predefined (bool) –
  • readOnly (bool) –

New in version NX10.0.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

AddListParameter

ParameterStockBuilder.AddListParameter

Adds List parameter.

Signature AddListParameter(name, values, eAssignment, predefined, readOnly)

Parameters:

New in version NX10.0.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

AddRealParameter

ParameterStockBuilder.AddRealParameter

Adds Real parameter.

Signature AddRealParameter(name, value, unit, predefined, readOnly)

Parameters:
  • name (str) –
  • value (float) –
  • unit (NXOpen.Unit) –
  • predefined (bool) –
  • readOnly (bool) –

New in version NX10.0.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

AddStringParameter

ParameterStockBuilder.AddStringParameter

Adds String parameter.

Signature AddStringParameter(name, value, predefined, readOnly)

Parameters:
  • name (str) –
  • value (str) –
  • predefined (bool) –
  • readOnly (bool) –

New in version NX10.0.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

DeleteParameter

ParameterStockBuilder.DeleteParameter

Delete parameter.

Signature DeleteParameter(name)

Parameters:name (str) –

New in version NX10.0.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

EditBoolParameter

ParameterStockBuilder.EditBoolParameter

Edits bool parameter value.

Signature EditBoolParameter(name, value)

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

New in version NX10.0.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

EditIntParameter

ParameterStockBuilder.EditIntParameter

Edits Int parameter.

Signature EditIntParameter(name, value)

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

New in version NX10.0.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

EditListParameter

ParameterStockBuilder.EditListParameter

Edits List parameter.

Signature EditListParameter(name, values, eAssignment)

Parameters:

New in version NX10.0.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

EditRealParameter

ParameterStockBuilder.EditRealParameter

Edits Real parameter.

Signature EditRealParameter(name, value, unit)

Parameters:
  • name (str) –
  • value (float) –
  • unit (NXOpen.Unit) –

New in version NX10.0.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

EditStringParameter

ParameterStockBuilder.EditStringParameter

Edits String parameter.

Signature EditStringParameter(name, value)

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

New in version NX10.0.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

GetBoolParameter

ParameterStockBuilder.GetBoolParameter

Gets bool parameter value.

Signature GetBoolParameter(name)

Parameters:name (str) –
Returns:a tuple
Return type:A tuple consisting of (value, predefined, readOnly) value is a bool. predefined is a bool. readOnly is a bool.

New in version NX10.0.0.

License requirements: None.

GetIntParameter

ParameterStockBuilder.GetIntParameter

Gets int parameter value.

Signature GetIntParameter(name)

Parameters:name (str) –
Returns:a tuple
Return type:A tuple consisting of (value, predefined, readOnly) value is a int. predefined is a bool. readOnly is a bool.

New in version NX10.0.0.

License requirements: None.

GetListParameter

ParameterStockBuilder.GetListParameter

Gets list parameter value.

Signature GetListParameter(name)

Parameters:name (str) –
Returns:a tuple
Return type:A tuple consisting of (values, eAssignment, predefined, readOnly). values is a list of str. eAssignment is a NXOpen.Mechatronics.ParameterStockBuilderAssignment. predefined is a bool. readOnly is a bool.

New in version NX10.0.0.

License requirements: None.

GetParameterNamesAndTypes

ParameterStockBuilder.GetParameterNamesAndTypes

Gets parameter names and types.

Signature GetParameterNamesAndTypes()

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

ParameterStockBuilder.GetRealParameter

Gets real parameter value.

Signature GetRealParameter(name)

Parameters:name (str) –
Returns:a tuple
Return type:A tuple consisting of (value, unit, predefined, readOnly). value is a float. unit is a NXOpen.Unit. predefined is a bool. readOnly is a bool.

New in version NX10.0.0.

License requirements: None.

GetStringParameter

ParameterStockBuilder.GetStringParameter

Gets string parameter value.

Signature GetStringParameter(name)

Parameters:name (str) –
Returns:a tuple
Return type:A tuple consisting of (value, predefined, readOnly) value is a str. predefined is a bool. readOnly is a bool.

New in version NX10.0.0.

License requirements: None.

Validate

ParameterStockBuilder.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.