PreferencesBuilder Class

class NXOpen.Mechatronics.PreferencesBuilder

Bases: NXOpen.Builder

Represents a NXOpen.Mechatronics.PreferencesBuilder builder.

To create a new instance of this class, use NXOpen.Mechatronics.PhysicsPreferenceCollection.CreatePreferenceBuilder()

Default values.

Property Value
AngularDampingExpression.Value 3490.6585 (millimeters part), 0.030895 (inches part)
CoSimulation false
CollisionPrecisionExpression.Value 0.1 (millimeters part), 0.0039 (inches part)
ConnectURL  
DynamicFrictionExpression.Value 0.7
EnableTimeSync false
ErrorReductionExpression.Value 50
Gx.Value 0 (millimeters part), 0 (inches part)
Gy.Value 0 (millimeters part), 0 (inches part)
Gz.Value -9806.65 (millimeters part), -386.09 (inches part)
LinearDampingExpression.Value 0.05 (millimeters part), 0.0002855 (inches part)
MaxIterationExpression.Value 100
RestitutionExpression.Value 0.01
RollingFrictionExpression.Value 0.0
SpringForceMultiplierExpression.Value 100
StaticFrictionExpression.Value 0.7
StepTimeExpression.Value 0.001
ToleranceExpression.Value 0.1 (millimeters part), 0.0039 (inches part)

New in version NX7.5.1.

Properties

Property Description
AngularDampingExpression Returns the angular damping expression
CoSimulation Returns or sets the co-simulation option
CollisionPrecision Returns or sets the collision precision.
CollisionPrecisionExpression Returns the Collision Precision Expression
ConnectURL Returns or sets the Simit Connect URL string
DynamicFriction Returns or sets the dynamic friction.
DynamicFrictionExpression Returns the Dynamic Friction Expression
EnableTimeSync Returns or sets the time synchronization option
ErrorReduction Returns or sets the error reduction.
ErrorReductionExpression Returns the Error Reduction Expression
FilePicker Returns or sets the export timing chart file path
ForwardStepTime Returns the Forward Step Time Expression
GeometryHighlight Returns or sets the geometry highlight on collsion.
Gx Returns the gx.
Gy Returns the gy.
Gz Returns the gz.
InvokeExport Returns or sets the toggle value for the invoke timing chart after import
LinearDampingExpression Returns the linear damping expression
LoadAsSaved Returns or sets the load as saved option for MCD Objects.
MasterType Returns or sets the master type option
MaxIteration Returns or sets the max iteration.
MaxIterationExpression Returns the Maximum Iteration Expression
RefreshPrecision Returns or sets the inspector refresh precision.
Restitution Returns or sets the restitution.
RestitutionExpression Returns the Restitution Expression
RevisionRule Returns or sets the revision rule for MCD Objects.
RollingFrictionExpression Returns the rolling Friction Expression
ShapeHighlight Returns or sets the shape highlight on collsion.
SpringForceMultiplier Returns or sets the spring force multiplier.
SpringForceMultiplierExpression Returns the Spring Force Multiplier Expression
StaticFriction Returns or sets the static friction.
StaticFrictionExpression Returns the static Friction Expression
StepTime Returns or sets the step time.
StepTimeExpression Returns the Step Time Expression
StickyFactor Returns or sets the sticky factor.
StickyForce Returns the sticky factor Expression
SynchronizationTime Returns the time interval to do synchronization with SIMIT
Tag Returns the Tag for this object.
TimeScaleFactor Returns or sets the time scale factor
Tolerance Returns or sets the tolerance.
ToleranceExpression Returns the Tolerance Expression

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.
GetObject Returns the object currently being edited by this builder.
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

PreferencesBuilderMasterTypes Enumeration the Co-Simulation master type.

Property Detail

AngularDampingExpression

PreferencesBuilder.AngularDampingExpression

Returns the angular damping expression

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

Getter Method

Signature AngularDampingExpression()

Returns:
Return type:NXOpen.Expression

New in version NX9.0.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

CoSimulation

PreferencesBuilder.CoSimulation

Returns or sets the co-simulation option

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

Getter Method

Signature CoSimulation()

Returns:
Return type:bool

New in version NX9.0.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

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

Setter Method

Signature CoSimulation(coSimulation)

Parameters:coSimulation (bool) –

New in version NX9.0.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

CollisionPrecision

PreferencesBuilder.CollisionPrecision

Returns or sets the collision precision.

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

Getter Method

Signature CollisionPrecision()

Returns:
Return type:float

New in version NX7.5.1.

Deprecated since version NX9.0.0: Use NXOpen.Mechatronics.PreferencesBuilder.CollisionPrecisionExpression() instead

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

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

Setter Method

Signature CollisionPrecision(collisionPrecision)

Parameters:collisionPrecision (float) –

New in version NX7.5.1.

Deprecated since version NX9.0.0: This functionality is no longer supported.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

CollisionPrecisionExpression

PreferencesBuilder.CollisionPrecisionExpression

Returns the Collision Precision Expression

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

Getter Method

Signature CollisionPrecisionExpression()

Returns:
Return type:NXOpen.Expression

New in version NX9.0.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

ConnectURL

PreferencesBuilder.ConnectURL

Returns or sets the Simit Connect URL string

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

Getter Method

Signature ConnectURL()

Returns:
Return type:str

New in version NX9.0.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

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

Setter Method

Signature ConnectURL(connectURL)

Parameters:connectURL (str) –

New in version NX9.0.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

DynamicFriction

PreferencesBuilder.DynamicFriction

Returns or sets the dynamic friction.

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

Getter Method

Signature DynamicFriction()

Returns:
Return type:float

New in version NX7.5.1.

Deprecated since version NX9.0.0: Use NXOpen.Mechatronics.PreferencesBuilder.DynamicFrictionExpression() instead

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

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

Setter Method

Signature DynamicFriction(dynamicFriction)

Parameters:dynamicFriction (float) –

New in version NX7.5.1.

Deprecated since version NX9.0.0: This functionality is no longer supported.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

DynamicFrictionExpression

PreferencesBuilder.DynamicFrictionExpression

Returns the Dynamic Friction Expression

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

Getter Method

Signature DynamicFrictionExpression()

Returns:
Return type:NXOpen.Expression

New in version NX9.0.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

EnableTimeSync

PreferencesBuilder.EnableTimeSync

Returns or sets the time synchronization option

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

Getter Method

Signature EnableTimeSync()

Returns:
Return type:bool

New in version NX9.0.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

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

Setter Method

Signature EnableTimeSync(enableTimeSync)

Parameters:enableTimeSync (bool) –

New in version NX9.0.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

ErrorReduction

PreferencesBuilder.ErrorReduction

Returns or sets the error reduction.

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

Getter Method

Signature ErrorReduction()

Returns:
Return type:float

New in version NX7.5.1.

Deprecated since version NX9.0.0: Use NXOpen.Mechatronics.PreferencesBuilder.ErrorReductionExpression() instead

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

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

Setter Method

Signature ErrorReduction(errorReduction)

Parameters:errorReduction (float) –

New in version NX7.5.1.

Deprecated since version NX9.0.0: This functionality is no longer supported.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

ErrorReductionExpression

PreferencesBuilder.ErrorReductionExpression

Returns the Error Reduction Expression

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

Getter Method

Signature ErrorReductionExpression()

Returns:
Return type:NXOpen.Expression

New in version NX9.0.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

FilePicker

PreferencesBuilder.FilePicker

Returns or sets the export timing chart file path

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

Getter Method

Signature FilePicker()

Returns:
Return type:str

New in version NX10.0.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

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

Setter Method

Signature FilePicker(exportFile)

Parameters:exportFile (str) –

New in version NX10.0.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

ForwardStepTime

PreferencesBuilder.ForwardStepTime

Returns the Forward Step Time Expression

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

Getter Method

Signature ForwardStepTime()

Returns:
Return type:NXOpen.Expression

New in version NX10.0.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

GeometryHighlight

PreferencesBuilder.GeometryHighlight

Returns or sets the geometry highlight on collsion.

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

Getter Method

Signature GeometryHighlight()

Returns:
Return type:bool

New in version NX9.0.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

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

Setter Method

Signature GeometryHighlight(highlight)

Parameters:highlight (bool) –

New in version NX9.0.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

Gx

PreferencesBuilder.Gx

Returns the gx.

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

Getter Method

Signature Gx()

Returns:
Return type:NXOpen.Expression

New in version NX7.5.1.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

Gy

PreferencesBuilder.Gy

Returns the gy.

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

Getter Method

Signature Gy()

Returns:
Return type:NXOpen.Expression

New in version NX7.5.1.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

Gz

PreferencesBuilder.Gz

Returns the gz.

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

Getter Method

Signature Gz()

Returns:
Return type:NXOpen.Expression

New in version NX7.5.1.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

InvokeExport

PreferencesBuilder.InvokeExport

Returns or sets the toggle value for the invoke timing chart after import

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

Getter Method

Signature InvokeExport()

Returns:
Return type:bool

New in version NX10.0.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

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

Setter Method

Signature InvokeExport(param)

Parameters:param (bool) –

New in version NX10.0.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

LinearDampingExpression

PreferencesBuilder.LinearDampingExpression

Returns the linear damping expression

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

Getter Method

Signature LinearDampingExpression()

Returns:
Return type:NXOpen.Expression

New in version NX9.0.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

LoadAsSaved

PreferencesBuilder.LoadAsSaved

Returns or sets the load as saved option for MCD Objects.

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

Getter Method

Signature LoadAsSaved()

Returns:
Return type:bool

New in version NX8.5.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

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

Setter Method

Signature LoadAsSaved(loadAsSaved)

Parameters:loadAsSaved (bool) –

New in version NX8.5.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

MasterType

PreferencesBuilder.MasterType

Returns or sets the master type option

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

Getter Method

Signature MasterType()

Returns:
Return type:NXOpen.Mechatronics.PreferencesBuilderMasterTypes

New in version NX10.0.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

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

Setter Method

Signature MasterType(masterType)

Parameters:masterType (NXOpen.Mechatronics.PreferencesBuilderMasterTypes) –

New in version NX10.0.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

MaxIteration

PreferencesBuilder.MaxIteration

Returns or sets the max iteration.

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

Getter Method

Signature MaxIteration()

Returns:
Return type:int

New in version NX7.5.1.

Deprecated since version NX9.0.0: Use NXOpen.Mechatronics.PreferencesBuilder.MaxIterationExpression() instead

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

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

Setter Method

Signature MaxIteration(maxIter)

Parameters:maxIter (int) –

New in version NX7.5.1.

Deprecated since version NX9.0.0: This functionality is no longer supported.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

MaxIterationExpression

PreferencesBuilder.MaxIterationExpression

Returns the Maximum Iteration Expression

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

Getter Method

Signature MaxIterationExpression()

Returns:
Return type:NXOpen.Expression

New in version NX9.0.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

RefreshPrecision

PreferencesBuilder.RefreshPrecision

Returns or sets the inspector refresh precision.

This option specifies the refresh precision to be used by the inspector to determine whether to update property values in UI or not.

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

Getter Method

Signature RefreshPrecision()

Returns:
Return type:float

New in version NX7.5.1.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

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

Setter Method

Signature RefreshPrecision(refreshPrecision)

Parameters:refreshPrecision (float) –

New in version NX7.5.1.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

Restitution

PreferencesBuilder.Restitution

Returns or sets the restitution.

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

Getter Method

Signature Restitution()

Returns:
Return type:float

New in version NX7.5.1.

Deprecated since version NX9.0.0: Use NXOpen.Mechatronics.PreferencesBuilder.RestitutionExpression() instead

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

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

Setter Method

Signature Restitution(restitution)

Parameters:restitution (float) –

New in version NX7.5.1.

Deprecated since version NX9.0.0: This functionality is no longer supported.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

RestitutionExpression

PreferencesBuilder.RestitutionExpression

Returns the Restitution Expression

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

Getter Method

Signature RestitutionExpression()

Returns:
Return type:NXOpen.Expression

New in version NX9.0.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

RevisionRule

PreferencesBuilder.RevisionRule

Returns or sets the revision rule for MCD Objects.

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

Getter Method

Signature RevisionRule()

Returns:
Return type:str

New in version NX8.5.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

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

Setter Method

Signature RevisionRule(revisionRule)

Parameters:revisionRule (str) –

New in version NX8.5.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

RollingFrictionExpression

PreferencesBuilder.RollingFrictionExpression

Returns the rolling Friction Expression

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

Getter Method

Signature RollingFrictionExpression()

Returns:
Return type:NXOpen.Expression

New in version NX9.0.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

ShapeHighlight

PreferencesBuilder.ShapeHighlight

Returns or sets the shape highlight on collsion.

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

Getter Method

Signature ShapeHighlight()

Returns:
Return type:bool

New in version NX9.0.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

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

Setter Method

Signature ShapeHighlight(highlight)

Parameters:highlight (bool) –

New in version NX9.0.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

SpringForceMultiplier

PreferencesBuilder.SpringForceMultiplier

Returns or sets the spring force multiplier.

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

Getter Method

Signature SpringForceMultiplier()

Returns:
Return type:float

New in version NX7.5.1.

Deprecated since version NX9.0.0: Use NXOpen.Mechatronics.PreferencesBuilder.SpringForceMultiplierExpression() instead

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

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

Setter Method

Signature SpringForceMultiplier(springForceMultiplier)

Parameters:springForceMultiplier (float) –

New in version NX7.5.1.

Deprecated since version NX9.0.0: This functionality is no longer supported.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

SpringForceMultiplierExpression

PreferencesBuilder.SpringForceMultiplierExpression

Returns the Spring Force Multiplier Expression

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

Getter Method

Signature SpringForceMultiplierExpression()

Returns:
Return type:NXOpen.Expression

New in version NX9.0.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

StaticFriction

PreferencesBuilder.StaticFriction

Returns or sets the static friction.

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

Getter Method

Signature StaticFriction()

Returns:
Return type:float

New in version NX7.5.1.

Deprecated since version NX9.0.0: Use NXOpen.Mechatronics.PreferencesBuilder.StaticFrictionExpression() instead

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

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

Setter Method

Signature StaticFriction(staticFriction)

Parameters:staticFriction (float) –

New in version NX7.5.1.

Deprecated since version NX9.0.0: This functionality is no longer supported.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

StaticFrictionExpression

PreferencesBuilder.StaticFrictionExpression

Returns the static Friction Expression

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

Getter Method

Signature StaticFrictionExpression()

Returns:
Return type:NXOpen.Expression

New in version NX9.0.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

StepTime

PreferencesBuilder.StepTime

Returns or sets the step time.

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

Getter Method

Signature StepTime()

Returns:
Return type:float

New in version NX7.5.1.

Deprecated since version NX9.0.0: Use NXOpen.Mechatronics.PreferencesBuilder.StepTimeExpression() instead

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

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

Setter Method

Signature StepTime(stepTime)

Parameters:stepTime (float) –

New in version NX7.5.1.

Deprecated since version NX9.0.0: This functionality is no longer supported.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

StepTimeExpression

PreferencesBuilder.StepTimeExpression

Returns the Step Time Expression

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

Getter Method

Signature StepTimeExpression()

Returns:
Return type:NXOpen.Expression

New in version NX9.0.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

StickyFactor

PreferencesBuilder.StickyFactor

Returns or sets the sticky factor.

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

Getter Method

Signature StickyFactor()

Returns:
Return type:float

New in version NX10.0.0.

Deprecated since version NX11.0.0: Use NXOpen.Mechatronics.PreferencesBuilder.StickyForce() instead.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

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

Setter Method

Signature StickyFactor(factor)

Parameters:factor (float) –

New in version NX10.0.0.

Deprecated since version NX11.0.0: This functionality is no longer supported.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

StickyForce

PreferencesBuilder.StickyForce

Returns the sticky factor Expression

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

Getter Method

Signature StickyForce()

Returns:
Return type:NXOpen.Expression

New in version NX11.0.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

SynchronizationTime

PreferencesBuilder.SynchronizationTime

Returns the time interval to do synchronization with SIMIT

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

Getter Method

Signature SynchronizationTime()

Returns:
Return type:NXOpen.Expression

New in version NX10.0.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

TimeScaleFactor

PreferencesBuilder.TimeScaleFactor

Returns or sets the time scale factor

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

Getter Method

Signature TimeScaleFactor()

Returns:
Return type:float

New in version NX10.0.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

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

Setter Method

Signature TimeScaleFactor(scaleFactor)

Parameters:scaleFactor (float) –

New in version NX10.0.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

Tolerance

PreferencesBuilder.Tolerance

Returns or sets the tolerance.

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

Getter Method

Signature Tolerance()

Returns:
Return type:float

New in version NX7.5.1.

Deprecated since version NX9.0.0: Use NXOpen.Mechatronics.PreferencesBuilder.ToleranceExpression() instead

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

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

Setter Method

Signature Tolerance(tolerance)

Parameters:tolerance (float) –

New in version NX7.5.1.

Deprecated since version NX9.0.0: This functionality is no longer supported.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

ToleranceExpression

PreferencesBuilder.ToleranceExpression

Returns the Tolerance Expression

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

Getter Method

Signature ToleranceExpression()

Returns:
Return type:NXOpen.Expression

New in version NX9.0.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

Method Detail

Validate

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