AnalyticalContactPropertyBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# AnalyticalContactPropertyBuilder Class

class `NXOpen.Motion.``AnalyticalContactPropertyBuilder`

  Bases: `NXOpen.Builder`

  Represents a `Motion.AnalyticalContactProperty` builder

  To create a new instance of this class, use `NXOpen.Motion.AnalyticalContactPropertyCollection.CreateAnalyticalContactPropertyBuilder()`

  Default values.

  Property | Value
  --- | ---
  DampingValue.Value | 0 (millimeters part), 0 (inches part)
  FirstCustomizedMaterial.Density.Value | 7.8e-6 (millimeters part), 7.3e-4 (inches part)
  FirstCustomizedMaterial.PoissonRatio.Value | 0.3
  FirstCustomizedMaterial.YoungModulus.Value | 2e+8 (millimeters part), 2.9e+7 (inches part)
  FrictionCoefficientOption | Expression
  FrictionCoefficientValue.Value | 0
  RestitutionCoefficient.Value | 1
  StiffnessValue.Value | 0 (millimeters part), 0 (inches part)
  TransitionVelocity.Value | 10 (millimeters part), 0.393701 (inches part)

  New in version NX12.0.0.

# Properties

Property | Description
--- | ---
DampingCurve | Returns or sets the damping function
DampingOption | Returns or sets the damping type.
DampingProfile | Returns the damping Profile.
DampingValue | Returns the damping value
FirstCustomizedMaterial | Returns the first customized material
FrictionCoefficientCurve | Returns or sets the friction coefficient function
FrictionCoefficientOption | Returns or sets the friction coefficient option
FrictionCoefficientProfile | Returns the friction coefficient Profile.
FrictionCoefficientValue | Returns the friction coefficient value
Name | Returns or sets the name
RestitutionCoefficient | Returns the restitution coefficient
SecondCustomizedMaterial | Returns the second customized material
StiffnessCurve | Returns or sets the stiffness function
StiffnessOption | Returns or sets the stiffness type.
StiffnessProfile | Returns the stiffness Profile.
StiffnessValue | Returns the stiffness value
Tag | Returns the Tag for this object.
TransitionVelocity | Returns the transition velocity

# 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

AnalyticalContactPropertyBuilderDampingType Enumeration | Damping Type
AnalyticalContactPropertyBuilderFrictionCoefficientType Enumeration | Friction Coefficient Type
AnalyticalContactPropertyBuilderStiffnessType Enumeration | Stiffness Type

# Property Detail

## DampingCurve

`AnalyticalContactPropertyBuilder.``DampingCurve`

  Returns or sets the damping function

  `-------------------------------------`

  Getter Method

  Signature `DampingCurve`

  Returns: |
  Return type: | `NXOpen.Motion.MotionFunction`

  New in version NX12.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `DampingCurve`

  Parameters: | dampingCurve (`NXOpen.Motion.MotionFunction`) –

  New in version NX12.0.0.

  License requirements: mechanisms (“MECHANISMS”)

## DampingOption

`AnalyticalContactPropertyBuilder.``DampingOption`

  Returns or sets the damping type.

  `-------------------------------------`

  Getter Method

  Signature `DampingOption`

  Returns: |
  Return type: | `NXOpen.Motion.AnalyticalContactPropertyBuilderDampingType`

  New in version NX12.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `DampingOption`

  Parameters: | type (`NXOpen.Motion.AnalyticalContactPropertyBuilderDampingType`) –

  New in version NX12.0.0.

  License requirements: mechanisms (“MECHANISMS”)

## DampingProfile

`AnalyticalContactPropertyBuilder.``DampingProfile`

  Returns the damping Profile.

  `-------------------------------------`

  Getter Method

  Signature `DampingProfile`

  Returns: |
  Return type: | `NXOpen.Motion.SelectFieldData`

  New in version NX12.0.0.

  License requirements: mechanisms (“MECHANISMS”)

## DampingValue

`AnalyticalContactPropertyBuilder.``DampingValue`

  Returns the damping value

  `-------------------------------------`

  Getter Method

  Signature `DampingValue`

  Returns: |
  Return type: | `NXOpen.Expression`

  New in version NX12.0.0.

  License requirements: mechanisms (“MECHANISMS”)

## FirstCustomizedMaterial

`AnalyticalContactPropertyBuilder.``FirstCustomizedMaterial`

  Returns the first customized material

  `-------------------------------------`

  Getter Method

  Signature `FirstCustomizedMaterial`

  Returns: |
  Return type: | `NXOpen.Motion.CustomizedMaterialBuilder`

  New in version NX12.0.0.

  License requirements: mechanisms (“MECHANISMS”)

## FrictionCoefficientCurve

`AnalyticalContactPropertyBuilder.``FrictionCoefficientCurve`

  Returns or sets the friction coefficient function

  `-------------------------------------`

  Getter Method

  Signature `FrictionCoefficientCurve`

  Returns: |
  Return type: | `NXOpen.Motion.MotionFunction`

  New in version NX12.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `FrictionCoefficientCurve`

  Parameters: | frictionCoefficient (`NXOpen.Motion.MotionFunction`) –

  New in version NX12.0.0.

  License requirements: mechanisms (“MECHANISMS”)

## FrictionCoefficientOption

`AnalyticalContactPropertyBuilder.``FrictionCoefficientOption`

  Returns or sets the friction coefficient option

  `-------------------------------------`

  Getter Method

  Signature `FrictionCoefficientOption`

  Returns: |
  Return type: | `NXOpen.Motion.AnalyticalContactPropertyBuilderFrictionCoefficientType`

  New in version NX12.0.0.

  License requirements: mechanisms (“MECHANISMS”)

  `-------------------------------------`

  Setter Method

  Signature `FrictionCoefficientOption`

  Parameters: | frictionCoefficient (`NXOpen.Motion.AnalyticalContactPropertyBuilderFrictionCoefficientType`) –

  New in version NX12.0.0.

  License requirements: mechanisms (“MECHANISMS”)

## FrictionCoefficientProfile

`AnalyticalContactPropertyBuilder.``FrictionCoefficientProfile`

  Returns the friction coefficient Profile.

  `-------------------------------------`

  Getter Method

  Signature `FrictionCoefficientProfile`

  Returns: |
  Return type: | `NXOpen.Motion.SelectFieldData`

  New in version NX12.0.0.

  License requirements: mechanisms (“MECHANISMS”)

## FrictionCoefficientValue

`AnalyticalContactPropertyBuilder.``FrictionCoefficientValue`

  Returns the friction coefficient value

  `-------------------------------------`

  Getter Method

  Signature `FrictionCoefficientValue`

  Returns: |
  Return type: | `NXOpen.Expression`

  New in version NX12.0.0.

  License requirements: mechanisms (“MECHANISMS”)

## Name

`AnalyticalContactPropertyBuilder.``Name`

  Returns or sets the name

  `-------------------------------------`

  Getter Method

  Signature `Name`

  Returns: |
  Return type: | str

  New in version NX12.0.0.

  License requirements: mechanisms (“MECHANISMS”)

  `-------------------------------------`

  Setter Method

  Signature `Name`

  Parameters: | name (str) –

  New in version NX12.0.0.

  License requirements: mechanisms (“MECHANISMS”)

## RestitutionCoefficient

`AnalyticalContactPropertyBuilder.``RestitutionCoefficient`

  Returns the restitution coefficient

  `-------------------------------------`

  Getter Method

  Signature `RestitutionCoefficient`

  Returns: |
  Return type: | `NXOpen.Expression`

  New in version NX12.0.0.

  License requirements: mechanisms (“MECHANISMS”)

## SecondCustomizedMaterial

`AnalyticalContactPropertyBuilder.``SecondCustomizedMaterial`

  Returns the second customized material

  `-------------------------------------`

  Getter Method

  Signature `SecondCustomizedMaterial`

  Returns: |
  Return type: | `NXOpen.Motion.CustomizedMaterialBuilder`

  New in version NX12.0.0.

  License requirements: mechanisms (“MECHANISMS”)

## StiffnessCurve

`AnalyticalContactPropertyBuilder.``StiffnessCurve`

  Returns or sets the stiffness function

  `-------------------------------------`

  Getter Method

  Signature `StiffnessCurve`

  Returns: |
  Return type: | `NXOpen.Motion.MotionFunction`

  New in version NX12.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `StiffnessCurve`

  Parameters: | stiffnessCurve (`NXOpen.Motion.MotionFunction`) –

  New in version NX12.0.0.

  License requirements: mechanisms (“MECHANISMS”)

## StiffnessOption

`AnalyticalContactPropertyBuilder.``StiffnessOption`

  Returns or sets the stiffness type.

  `-------------------------------------`

  Getter Method

  Signature `StiffnessOption`

  Returns: |
  Return type: | `NXOpen.Motion.AnalyticalContactPropertyBuilderStiffnessType`

  New in version NX12.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `StiffnessOption`

  Parameters: | type (`NXOpen.Motion.AnalyticalContactPropertyBuilderStiffnessType`) –

  New in version NX12.0.0.

  License requirements: mechanisms (“MECHANISMS”)

## StiffnessProfile

`AnalyticalContactPropertyBuilder.``StiffnessProfile`

  Returns the stiffness Profile.

  `-------------------------------------`

  Getter Method

  Signature `StiffnessProfile`

  Returns: |
  Return type: | `NXOpen.Motion.SelectFieldData`

  New in version NX12.0.0.

  License requirements: mechanisms (“MECHANISMS”)

## StiffnessValue

`AnalyticalContactPropertyBuilder.``StiffnessValue`

  Returns the stiffness value

  `-------------------------------------`

  Getter Method

  Signature `StiffnessValue`

  Returns: |
  Return type: | `NXOpen.Expression`

  New in version NX12.0.0.

  License requirements: mechanisms (“MECHANISMS”)

## TransitionVelocity

`AnalyticalContactPropertyBuilder.``TransitionVelocity`

  Returns the transition velocity

  `-------------------------------------`

  Getter Method

  Signature `TransitionVelocity`

  Returns: |
  Return type: | `NXOpen.Expression`

  New in version NX12.0.0.

  License requirements: mechanisms (“MECHANISMS”)

# Method Detail

## Validate

`AnalyticalContactPropertyBuilder.``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.