LawBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# LawBuilder Class

class `NXOpen.GeometricUtilities.``LawBuilder`

  Bases: `NXOpen.TaggedObject`, `NXOpen.GeometricUtilities.IComponentBuilder`

  Represents a LawBuilder

  New in version NX5.0.0.

# Properties

Property | Description
--- | ---
AlongSpineData | Returns the linear or cubic along spine law.
BaseLine | Returns the base line.
EndValue | Returns the end value.
Function | Returns or sets the function.
IsSimpleCubicAlongSpine | Returns or sets a value indicating if `NXOpen.GeometricUtilities.LawBuilderType.CubicAlongSpine` is using simple cubic interpolation.
LawCurve | Returns the law curve.
LawCurveOption | Returns or sets the option to retain law curve.
LawType | Returns or sets the law type
MultiTransitionLaw | Returns the multi transition law.
NonInflectingLaw | Returns the non inflecting law.
Parameter | Returns or sets the parameter.
ReverseDirection | Returns or sets the reverse direction.
SShapedLaw | Returns the s-shaped law.
StartValue | Returns the start value.
Tag | Returns the Tag for this object.
Value | Returns the constant value.

# Methods

Method | Description
--- | ---
SetSpineIntoBuilder | Sets the spine dynamically into builder
Validate | Validate whether the inputs to the component are sufficient for commit to be called.

# Enumerations

LawBuilderRetainLawCurveOption Enumeration | Describes the option on whether to retain the original profile.
LawBuilderType Enumeration | The law types

# Property Detail

## AlongSpineData

`LawBuilder.``AlongSpineData`

  Returns the linear or cubic along spine law.

  This will be used only when the law type is linear along spine/cubic along spine

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

  Getter Method

  Signature `AlongSpineData`

  Returns: |
  Return type: | `NXOpen.GeometricUtilities.AlongSpineBuilder`

  New in version NX5.0.0.

  License requirements: None.

## BaseLine

`LawBuilder.``BaseLine`

  Returns the base line.

  This will be used only when the law type is by law curve

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

  Getter Method

  Signature `BaseLine`

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

  New in version NX5.0.0.

  License requirements: None.

## EndValue

`LawBuilder.``EndValue`

  Returns the end value.

  This will be used only when the law type is linear/cubic

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

  Getter Method

  Signature `EndValue`

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

  New in version NX5.0.0.

  License requirements: None.

## Function

`LawBuilder.``Function`

  Returns or sets the function.

  This will be used only when the law type is by equation. Make sure that the expression should be created before setting it in to the builder

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

  Getter Method

  Signature `Function`

  Returns: | Get the name of function expression
  Return type: | str

  New in version NX5.0.0.

  License requirements: None.

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

  Setter Method

  Signature `Function`

  Parameters: | function (str) – Set the name of function expression

  New in version NX5.0.0.

  License requirements: solid_modeling (“SOLIDS MODELING”) OR drafting (“DRAFTING”)

## IsSimpleCubicAlongSpine

`LawBuilder.``IsSimpleCubicAlongSpine`

  Returns or sets a value indicating if `NXOpen.GeometricUtilities.LawBuilderType.CubicAlongSpine` is using simple cubic interpolation.

  Simple cubic interpolation minimizes enforcement of automatic tangent constraints at the defining points. This option is valid only when `NXOpen.GeometricUtilities.LawBuilderType` is `NXOpen.GeometricUtilities.LawBuilderType.CubicAlongSpine`

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

  Getter Method

  Signature `IsSimpleCubicAlongSpine`

  Returns: |
  Return type: | bool

  New in version NX6.0.0.

  License requirements: None.

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

  Setter Method

  Signature `IsSimpleCubicAlongSpine`

  Parameters: | isSimpleCubic (bool) –

  New in version NX6.0.0.

  License requirements: None.

## LawCurve

`LawBuilder.``LawCurve`

  Returns the law curve.

  This will be used only when the law type is by law curve

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

  Getter Method

  Signature `LawCurve`

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

  New in version NX5.0.0.

  License requirements: None.

## LawCurveOption

`LawBuilder.``LawCurveOption`

  Returns or sets the option to retain law curve.

  This will be used only during the edit of Pre NX3 feature Parms

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

  Getter Method

  Signature `LawCurveOption`

  Returns: |
  Return type: | `NXOpen.GeometricUtilities.LawBuilderRetainLawCurveOption`

  New in version NX5.0.0.

  License requirements: None.

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

  Setter Method

  Signature `LawCurveOption`

  Parameters: | lawCurveOption (`NXOpen.GeometricUtilities.LawBuilderRetainLawCurveOption`) –

  New in version NX5.0.0.

  License requirements: solid_modeling (“SOLIDS MODELING”) OR drafting (“DRAFTING”)

## LawType

`LawBuilder.``LawType`

  Returns or sets the law type

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

  Getter Method

  Signature `LawType`

  Returns: | Returns the lawType
  Return type: | `NXOpen.GeometricUtilities.LawBuilderType`

  New in version NX5.0.0.

  License requirements: None.

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

  Setter Method

  Signature `LawType`

  Parameters: | lawType (`NXOpen.GeometricUtilities.LawBuilderType`) – Set the lawType

  New in version NX5.0.0.

  License requirements: solid_modeling (“SOLIDS MODELING”) OR drafting (“DRAFTING”)

## MultiTransitionLaw

`LawBuilder.``MultiTransitionLaw`

  Returns the multi transition law.

  This will be used only when the law type is multi transition law

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

  Getter Method

  Signature `MultiTransitionLaw`

  Returns: |
  Return type: | `NXOpen.GeometricUtilities.MultiTransitionLawBuilder`

  New in version NX6.0.0.

  License requirements: None.

## NonInflectingLaw

`LawBuilder.``NonInflectingLaw`

  Returns the non inflecting law.

  This will be used only when the law type is non inflecting law

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

  Getter Method

  Signature `NonInflectingLaw`

  Returns: |
  Return type: | `NXOpen.GeometricUtilities.NonInflectingLawBuilder`

  New in version NX6.0.0.

  License requirements: None.

## Parameter

`LawBuilder.``Parameter`

  Returns or sets the parameter.

  This will be used only when the law type is by equation. Make sure that the expression should be created before setting it in to the builder

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

  Getter Method

  Signature `Parameter`

  Returns: | Get the name of parameter expression
  Return type: | str

  New in version NX5.0.0.

  License requirements: None.

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

  Setter Method

  Signature `Parameter`

  Parameters: | parameter (str) – Set the name of parameter expression

  New in version NX5.0.0.

  License requirements: solid_modeling (“SOLIDS MODELING”) OR drafting (“DRAFTING”)

## ReverseDirection

`LawBuilder.``ReverseDirection`

  Returns or sets the reverse direction.

  This will be used only when the law type is by law curve

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

  Getter Method

  Signature `ReverseDirection`

  Returns: | Get the reverse direction flag
  Return type: | bool

  New in version NX5.0.0.

  License requirements: None.

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

  Setter Method

  Signature `ReverseDirection`

  Parameters: | reverseDirection (bool) – Set the reverse direction flag

  New in version NX5.0.0.

  License requirements: solid_modeling (“SOLIDS MODELING”) OR drafting (“DRAFTING”)

## SShapedLaw

`LawBuilder.``SShapedLaw`

  Returns the s-shaped law.

  This will be used only when the law type is s-shaped law

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

  Getter Method

  Signature `SShapedLaw`

  Returns: |
  Return type: | `NXOpen.GeometricUtilities.SShapedLawBuilder`

  New in version NX6.0.0.

  License requirements: None.

## StartValue

`LawBuilder.``StartValue`

  Returns the start value.

  This will be used only when the law type is linear/cubic

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

  Getter Method

  Signature `StartValue`

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

  New in version NX5.0.0.

  License requirements: None.

## Value

`LawBuilder.``Value`

  Returns the constant value.

  This will be used only when the law type is constant

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

  Getter Method

  Signature `Value`

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

  New in version NX5.0.0.

  License requirements: None.

# Method Detail

## SetSpineIntoBuilder

`LawBuilder.``SetSpineIntoBuilder`

  Sets the spine dynamically into builder

  Signature `SetSpineIntoBuilder(spine)`

  Parameters: | spine (`NXOpen.Section`) – Set the Spine into builder

  New in version NX5.0.0.

  License requirements: solid_modeling (“SOLIDS MODELING”) OR drafting (“DRAFTING”)

## Validate

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