ValueTestBuilder Class

class NXOpen.GeometricUtilities.ValueTestBuilder

Bases: NXOpen.Builder

Represents a ValueTestBuilder

Temporary Fix

Default values.

Property	Value
Color	5

New in version NX5.0.0.

Properties

Property	Description
Color	Returns or sets the color
Combo	Returns or sets the combo
ComboMru	Returns or sets the most recently used-enabled combo
IconKeyin	Returns or sets the icon keyin
IntCombo	Returns or sets the int combo
IntKeyin	Returns or sets the int keyin
IntScale	Returns or sets the int scale
IntScaleKeyin	Returns or sets the int scale keyin
IntSpin	Returns or sets the int spin
IsUnassignableComboAssigned	Returns or sets whether or not the unassignable combo is assigned
IsUnassignableIntComboAssigned	Returns or sets whether or not the unassignable int combo is assigned
IsUnassignableIntKeyinAssigned	Returns or sets whether or not the unassignable int keyin is assigned
IsUnassignableIntSpinAssigned	Returns or sets whether or not the unassignable int spin is assigned
IsUnassignableKeyinAssigned	Returns or sets whether or not the unassignable keyin is assigned
IsUnassignableSpinAssigned	Returns or sets whether or not the unassignable spin is assigned
Keyin	Returns or sets the keyin
Scale	Returns or sets the scale
ScaleDefault	Returns or sets the scale default
ScaleKeyin	Returns or sets the scale keyin
Spin	Returns or sets the spin
Tag	Returns the Tag for this object.
UnassignableCombo	Returns or sets the unassignable combo
UnassignableIntCombo	Returns or sets the unassignable int combo
UnassignableIntKeyin	Returns or sets the unassignable int keyin
UnassignableIntSpin	Returns or sets the unassignable int spin
UnassignableKeyin	Returns or sets the unassignable keyin
UnassignableSpin	Returns or sets the unassignable spin

Methods

Method	Description
Commit	Commits any edits that have been applied to the builder.
Destroy	Deletes the builder, and cleans up any objects created by the builder.
GetCommittedObjects	For builders that create more than one object, this method returns the objects that are created by commit.
GetMultipleColors	Returns the colors
GetObject	Returns the object currently being edited by this builder.
GetRgbColor	Returns the RGB color
SetMultipleColors	Sets the array of colors
SetRgbColor	Sets the RGB color
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

Color

ValueTestBuilder.Color

Returns or sets the color

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

Getter Method

Signature Color

Returns: Return type:Id

New in version NX5.0.0.

License requirements: solid_modeling (“SOLIDS MODELING”)

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

Setter Method

Signature Color

Parameters:color (Id) –

New in version NX5.0.0.

License requirements: solid_modeling (“SOLIDS MODELING”)

Combo

ValueTestBuilder.Combo

Returns or sets the combo

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

Getter Method

Signature Combo

Returns: Return type:float

New in version NX8.0.0.

License requirements: None.

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

Setter Method

Signature Combo

Parameters:combo (float) –

New in version NX8.0.0.

License requirements: solid_modeling (“SOLIDS MODELING”)

ComboMru

ValueTestBuilder.ComboMru

Returns or sets the most recently used-enabled combo

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

Getter Method

Signature ComboMru

Returns: Return type:float

New in version NX8.0.0.

License requirements: None.

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

Setter Method

Signature ComboMru

Parameters:comboMru (float) –

New in version NX8.0.0.

License requirements: solid_modeling (“SOLIDS MODELING”)

IconKeyin

ValueTestBuilder.IconKeyin

Returns or sets the icon keyin

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

Getter Method

Signature IconKeyin

Returns: Return type:float

New in version NX5.0.0.

License requirements: None.

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

Setter Method

Signature IconKeyin

Parameters:iconKeyin (float) –

New in version NX5.0.0.

License requirements: solid_modeling (“SOLIDS MODELING”)

IntCombo

ValueTestBuilder.IntCombo

Returns or sets the int combo

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

Getter Method

Signature IntCombo

Returns: Return type:int

New in version NX8.0.0.

License requirements: None.

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

Setter Method

Signature IntCombo

Parameters:intCombo (int) –

New in version NX8.0.0.

License requirements: solid_modeling (“SOLIDS MODELING”)

IntKeyin

ValueTestBuilder.IntKeyin

Returns or sets the int keyin

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

Getter Method

Signature IntKeyin

Returns: Return type:int

New in version NX5.0.0.

License requirements: None.

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

Setter Method

Signature IntKeyin

Parameters:intKeyin (int) –

New in version NX5.0.0.

License requirements: solid_modeling (“SOLIDS MODELING”)

IntScale

ValueTestBuilder.IntScale

Returns or sets the int scale

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

Getter Method

Signature IntScale

Returns: Return type:int

New in version NX5.0.0.

License requirements: None.

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

Setter Method

Signature IntScale

Parameters:intScale (int) –

New in version NX5.0.0.

License requirements: solid_modeling (“SOLIDS MODELING”)

IntScaleKeyin

ValueTestBuilder.IntScaleKeyin

Returns or sets the int scale keyin

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

Getter Method

Signature IntScaleKeyin

Returns: Return type:int

New in version NX5.0.0.

License requirements: None.

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

Setter Method

Signature IntScaleKeyin

Parameters:intScale (int) –

New in version NX5.0.0.

License requirements: solid_modeling (“SOLIDS MODELING”)

IntSpin

ValueTestBuilder.IntSpin

Returns or sets the int spin

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

Getter Method

Signature IntSpin

Returns: Return type:int

New in version NX5.0.0.

License requirements: None.

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

Setter Method

Signature IntSpin

Parameters:intSpin (int) –

New in version NX5.0.0.

License requirements: solid_modeling (“SOLIDS MODELING”)

IsUnassignableComboAssigned

ValueTestBuilder.IsUnassignableComboAssigned

Returns or sets whether or not the unassignable combo is assigned

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

Getter Method

Signature IsUnassignableComboAssigned

Returns: Return type:bool

New in version NX8.5.0.

License requirements: None.

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

Setter Method

Signature IsUnassignableComboAssigned

Parameters:unassignableComboAssigned (bool) –

New in version NX8.5.0.

License requirements: solid_modeling (“SOLIDS MODELING”)

IsUnassignableIntComboAssigned

ValueTestBuilder.IsUnassignableIntComboAssigned

Returns or sets whether or not the unassignable int combo is assigned

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

Getter Method

Signature IsUnassignableIntComboAssigned

Returns: Return type:bool

New in version NX8.5.0.

License requirements: None.

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

Setter Method

Signature IsUnassignableIntComboAssigned

Parameters:unassignableIntComboAssigned (bool) –

New in version NX8.5.0.

License requirements: solid_modeling (“SOLIDS MODELING”)

IsUnassignableIntKeyinAssigned

ValueTestBuilder.IsUnassignableIntKeyinAssigned

Returns or sets whether or not the unassignable int keyin is assigned

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

Getter Method

Signature IsUnassignableIntKeyinAssigned

Returns: Return type:bool

New in version NX8.5.0.

License requirements: None.

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

Setter Method

Signature IsUnassignableIntKeyinAssigned

Parameters:unassignableIntKeyinAssigned (bool) –

New in version NX8.5.0.

License requirements: solid_modeling (“SOLIDS MODELING”)

IsUnassignableIntSpinAssigned

ValueTestBuilder.IsUnassignableIntSpinAssigned

Returns or sets whether or not the unassignable int spin is assigned

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

Getter Method

Signature IsUnassignableIntSpinAssigned

Returns: Return type:bool

New in version NX12.0.0.

License requirements: None.

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

Setter Method

Signature IsUnassignableIntSpinAssigned

Parameters:unassignableIntSpinAssigned (bool) –

New in version NX12.0.0.

License requirements: solid_modeling (“SOLIDS MODELING”)

IsUnassignableKeyinAssigned

ValueTestBuilder.IsUnassignableKeyinAssigned

Returns or sets whether or not the unassignable keyin is assigned

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

Getter Method

Signature IsUnassignableKeyinAssigned

Returns: Return type:bool

New in version NX8.5.0.

License requirements: None.

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

Setter Method

Signature IsUnassignableKeyinAssigned

Parameters:unassignableKeyinAssigned (bool) –

New in version NX8.5.0.

License requirements: solid_modeling (“SOLIDS MODELING”)

IsUnassignableSpinAssigned

ValueTestBuilder.IsUnassignableSpinAssigned

Returns or sets whether or not the unassignable spin is assigned

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

Getter Method

Signature IsUnassignableSpinAssigned

Returns: Return type:bool

New in version NX12.0.0.

License requirements: None.

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

Setter Method

Signature IsUnassignableSpinAssigned

Parameters:unassignableSpinAssigned (bool) –

New in version NX12.0.0.

License requirements: solid_modeling (“SOLIDS MODELING”)

Keyin

ValueTestBuilder.Keyin

Returns or sets the keyin

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

Getter Method

Signature Keyin

Returns: Return type:float

New in version NX5.0.0.

License requirements: None.

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

Setter Method

Signature Keyin

Parameters:keyin (float) –

New in version NX5.0.0.

License requirements: solid_modeling (“SOLIDS MODELING”)

Scale

ValueTestBuilder.Scale

Returns or sets the scale

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

Getter Method

Signature Scale

Returns: Return type:float

New in version NX5.0.0.

License requirements: None.

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

Setter Method

Signature Scale

Parameters:scale (float) –

New in version NX5.0.0.

License requirements: solid_modeling (“SOLIDS MODELING”)

ScaleDefault

ValueTestBuilder.ScaleDefault

Returns or sets the scale default

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

Getter Method

Signature ScaleDefault

Returns: Return type:float

New in version NX5.0.0.

License requirements: None.

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

Setter Method

Signature ScaleDefault

Parameters:scaleDefault (float) –

New in version NX5.0.0.

License requirements: solid_modeling (“SOLIDS MODELING”)

ScaleKeyin

ValueTestBuilder.ScaleKeyin

Returns or sets the scale keyin

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

Getter Method

Signature ScaleKeyin

Returns: Return type:float

New in version NX5.0.0.

License requirements: None.

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

Setter Method

Signature ScaleKeyin

Parameters:scaleDefault (float) –

New in version NX5.0.0.

License requirements: solid_modeling (“SOLIDS MODELING”)

Spin

ValueTestBuilder.Spin

Returns or sets the spin

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

Getter Method

Signature Spin

Returns: Return type:float

New in version NX5.0.0.

License requirements: None.

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

Setter Method

Signature Spin

Parameters:spin (float) –

New in version NX5.0.0.

License requirements: solid_modeling (“SOLIDS MODELING”)

UnassignableCombo

ValueTestBuilder.UnassignableCombo

Returns or sets the unassignable combo

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

Getter Method

Signature UnassignableCombo

Returns: Return type:float

New in version NX8.5.0.

License requirements: None.

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

Setter Method

Signature UnassignableCombo

Parameters:unassignableCombo (float) –

New in version NX8.5.0.

License requirements: solid_modeling (“SOLIDS MODELING”)

UnassignableIntCombo

ValueTestBuilder.UnassignableIntCombo

Returns or sets the unassignable int combo

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

Getter Method

Signature UnassignableIntCombo

Returns: Return type:int

New in version NX8.5.0.

License requirements: None.

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

Setter Method

Signature UnassignableIntCombo

Parameters:unassignableIntCombo (int) –

New in version NX8.5.0.

License requirements: solid_modeling (“SOLIDS MODELING”)

UnassignableIntKeyin

ValueTestBuilder.UnassignableIntKeyin

Returns or sets the unassignable int keyin

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

Getter Method

Signature UnassignableIntKeyin

Returns: Return type:int

New in version NX8.5.0.

License requirements: None.

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

Setter Method

Signature UnassignableIntKeyin

Parameters:unassignableIntKeyin (int) –

New in version NX8.5.0.

License requirements: solid_modeling (“SOLIDS MODELING”)

UnassignableIntSpin

ValueTestBuilder.UnassignableIntSpin

Returns or sets the unassignable int spin

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

Getter Method

Signature UnassignableIntSpin

Returns: Return type:int

New in version NX12.0.0.

License requirements: None.

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

Setter Method

Signature UnassignableIntSpin

Parameters:unassignableIntSpin (int) –

New in version NX12.0.0.

License requirements: solid_modeling (“SOLIDS MODELING”)

UnassignableKeyin

ValueTestBuilder.UnassignableKeyin

Returns or sets the unassignable keyin

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

Getter Method

Signature UnassignableKeyin

Returns: Return type:float

New in version NX8.5.0.

License requirements: None.

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

Setter Method

Signature UnassignableKeyin

Parameters:unassignableKeyin (float) –

New in version NX8.5.0.

License requirements: solid_modeling (“SOLIDS MODELING”)

UnassignableSpin

ValueTestBuilder.UnassignableSpin

Returns or sets the unassignable spin

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

Getter Method

Signature UnassignableSpin

Returns: Return type:float

New in version NX12.0.0.

License requirements: None.

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

Setter Method

Signature UnassignableSpin

Parameters:unassignableSpin (float) –

New in version NX12.0.0.

License requirements: solid_modeling (“SOLIDS MODELING”)

Method Detail

GetMultipleColors

ValueTestBuilder.GetMultipleColors

Returns the colors

Signature GetMultipleColors()

Returns: Return type:list of Id

New in version NX5.0.0.

License requirements: solid_modeling (“SOLIDS MODELING”)

GetRgbColor

ValueTestBuilder.GetRgbColor

Returns the RGB color

Signature GetRgbColor()

Returns:Array of 3 rgb values, each between 0 and 1 Return type:list of float

New in version NX5.0.0.

License requirements: solid_modeling (“SOLIDS MODELING”)

SetMultipleColors

ValueTestBuilder.SetMultipleColors

Sets the array of colors

Signature SetMultipleColors(colors)

Parameters:colors (list of Id) –

New in version NX5.0.0.

License requirements: solid_modeling (“SOLIDS MODELING”)

SetRgbColor

ValueTestBuilder.SetRgbColor

Sets the RGB color

Signature SetRgbColor(rgb)

Parameters:rgb (list of float) – Array of 3 rgb values, each between 0 and 1

New in version NX5.0.0.

License requirements: solid_modeling (“SOLIDS MODELING”)

Validate

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