TBSShapeRestrictAreaBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# TBSShapeRestrictAreaBuilder Class

class `NXOpen.CAE.Optimization.``TBSShapeRestrictAreaBuilder`

  Bases: `NXOpen.CAE.Optimization.TBSRestrictAreaBuilder`

  Represents the builder of `NXOpen.CAE.Optimization.TBSShapeRestrictArea`

  To create a new instance of this class, use `NXOpen.CAE.Optimization.TBSOptimizationManager.CreateShapeRestrictAreaBuilder()`

  New in version NX8.5.0.

# Properties

Property | Description
--- | ---
ActLinkConditionButton | Returns the link condition
CheckBoundaryCondition | Returns or sets a value indicating whether to accept nodes of boundary condition as constraint
CheckDof | Returns or sets a value indicating whether to restrict the dispacement in the coordinate direction of the referenced coordinate system
CheckElementGroup | Returns or sets a value indicating whether to check elements for penetration
CheckLinkCondition | Returns or sets a value indicating whether to check link condition
CheckMaximumGrowValue | Returns or sets a value indicating whether to check maximum grow value
CheckMaximumShrinkValue | Returns or sets a value indicating whether to check maximum shrink value
CheckedElements | Returns the elements checked for penetration
DofSettings | Returns the DOF settings
MaximumGrowValue | Returns the maximum grow value
MaximumShrinkValue | Returns the maximum shrink value
NameDescription | Returns the name description
RestrictedNodes | Returns the nodes to react on the restrictions
Tag | Returns the Tag for this object.

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

# Property Detail

## ActLinkConditionButton

`TBSShapeRestrictAreaBuilder.``ActLinkConditionButton`

  Returns the link condition

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

  Getter Method

  Signature `ActLinkConditionButton`

  Returns: |
  Return type: | `NXOpen.CAE.Optimization.TBSShapeLinkCondition`

  New in version NX8.5.0.

  License requirements: None.

## CheckBoundaryCondition

`TBSShapeRestrictAreaBuilder.``CheckBoundaryCondition`

  Returns or sets a value indicating whether to accept nodes of boundary condition as constraint

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

  Getter Method

  Signature `CheckBoundaryCondition`

  Returns: |
  Return type: | bool

  New in version NX8.5.0.

  License requirements: None.

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

  Setter Method

  Signature `CheckBoundaryCondition`

  Parameters: | boundaryCondition (bool) –

  New in version NX8.5.0.

  License requirements: cae_opt_toposhape (“NX Shape Optimization”)

## CheckDof

`TBSShapeRestrictAreaBuilder.``CheckDof`

  Returns or sets a value indicating whether to restrict the dispacement in the coordinate direction of the referenced coordinate system

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

  Getter Method

  Signature `CheckDof`

  Returns: |
  Return type: | bool

  New in version NX8.5.0.

  License requirements: None.

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

  Setter Method

  Signature `CheckDof`

  Parameters: | checkDof (bool) –

  New in version NX8.5.0.

  License requirements: cae_opt_toposhape (“NX Shape Optimization”)

## CheckElementGroup

`TBSShapeRestrictAreaBuilder.``CheckElementGroup`

  Returns or sets a value indicating whether to check elements for penetration

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

  Getter Method

  Signature `CheckElementGroup`

  Returns: |
  Return type: | bool

  New in version NX8.5.0.

  License requirements: None.

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

  Setter Method

  Signature `CheckElementGroup`

  Parameters: | checkElements (bool) –

  New in version NX8.5.0.

  License requirements: cae_opt_toposhape (“NX Shape Optimization”)

## CheckLinkCondition

`TBSShapeRestrictAreaBuilder.``CheckLinkCondition`

  Returns or sets a value indicating whether to check link condition

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

  Getter Method

  Signature `CheckLinkCondition`

  Returns: |
  Return type: | bool

  New in version NX8.5.0.

  License requirements: None.

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

  Setter Method

  Signature `CheckLinkCondition`

  Parameters: | checkLinkCondition (bool) –

  New in version NX8.5.0.

  License requirements: cae_opt_toposhape (“NX Shape Optimization”)

## CheckMaximumGrowValue

`TBSShapeRestrictAreaBuilder.``CheckMaximumGrowValue`

  Returns or sets a value indicating whether to check maximum grow value

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

  Getter Method

  Signature `CheckMaximumGrowValue`

  Returns: |
  Return type: | bool

  New in version NX8.5.0.

  License requirements: None.

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

  Setter Method

  Signature `CheckMaximumGrowValue`

  Parameters: | isMaxGrowValue (bool) –

  New in version NX8.5.0.

  License requirements: cae_opt_toposhape (“NX Shape Optimization”)

## CheckMaximumShrinkValue

`TBSShapeRestrictAreaBuilder.``CheckMaximumShrinkValue`

  Returns or sets a value indicating whether to check maximum shrink value

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

  Getter Method

  Signature `CheckMaximumShrinkValue`

  Returns: |
  Return type: | bool

  New in version NX8.5.0.

  License requirements: None.

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

  Setter Method

  Signature `CheckMaximumShrinkValue`

  Parameters: | isMaxShrinkValue (bool) –

  New in version NX8.5.0.

  License requirements: cae_opt_toposhape (“NX Shape Optimization”)

## CheckedElements

`TBSShapeRestrictAreaBuilder.``CheckedElements`

  Returns the elements checked for penetration

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

  Getter Method

  Signature `CheckedElements`

  Returns: |
  Return type: | `NXOpen.CAE.Optimization.TBSGroupDefinition`

  New in version NX8.5.0.

  License requirements: None.

## DofSettings

`TBSShapeRestrictAreaBuilder.``DofSettings`

  Returns the DOF settings

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

  Getter Method

  Signature `DofSettings`

  Returns: |
  Return type: | `NXOpen.CAE.Optimization.TBSCheckDOF`

  New in version NX8.5.0.

  License requirements: None.

## MaximumGrowValue

`TBSShapeRestrictAreaBuilder.``MaximumGrowValue`

  Returns the maximum grow value

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

  Getter Method

  Signature `MaximumGrowValue`

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

  New in version NX8.5.0.

  License requirements: None.

## MaximumShrinkValue

`TBSShapeRestrictAreaBuilder.``MaximumShrinkValue`

  Returns the maximum shrink value

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

  Getter Method

  Signature `MaximumShrinkValue`

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

  New in version NX8.5.0.

  License requirements: None.

## RestrictedNodes

`TBSShapeRestrictAreaBuilder.``RestrictedNodes`

  Returns the nodes to react on the restrictions

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

  Getter Method

  Signature `RestrictedNodes`

  Returns: |
  Return type: | `NXOpen.CAE.Optimization.TBSGroupDefinition`

  New in version NX8.5.0.

  License requirements: None.

# Method Detail

## Validate

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