FeatureOffset Class — NXOpen Python API Reference 12.0.0 documentation

# FeatureOffset Class

class `NXOpen.GeometricUtilities.``FeatureOffset`

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

  Represents a Offset .

  New in version NX3.0.1.

# Properties

Property | Description
--- | ---
EndOffset | Returns the End Offset
Option | Returns or sets the Offset option
StartOffset | Returns the Start Offset
Tag | Returns the Tag for this object.

# Methods

Method | Description
--- | ---
SetEndOffset | The End Offset
SetStartOffset | The Start Offset
Validate | Validate whether the inputs to the component are sufficient for commit to be called.

# Property Detail

## EndOffset

`FeatureOffset.``EndOffset`

  Returns the End Offset

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

  Getter Method

  Signature `EndOffset`

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

  New in version NX3.0.1.

  License requirements: None.

## Option

`FeatureOffset.``Option`

  Returns or sets the Offset option

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

  Getter Method

  Signature `Option`

  Returns: | offset type
  Return type: | `NXOpen.GeometricUtilities.Type`

  New in version NX5.0.0.

  License requirements: None.

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

  Setter Method

  Signature `Option`

  Parameters: | offsetType (`NXOpen.GeometricUtilities.Type`) – offset type

  New in version NX5.0.0.

  License requirements: solid_modeling (“SOLIDS MODELING”)

## StartOffset

`FeatureOffset.``StartOffset`

  Returns the Start Offset

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

  Getter Method

  Signature `StartOffset`

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

  New in version NX3.0.1.

  License requirements: None.

# Method Detail

## SetEndOffset

`FeatureOffset.``SetEndOffset`

  The End Offset

  Signature `SetEndOffset(valueExpression)`

  Parameters: | valueExpression (str) – value of end offset expression

  New in version NX3.0.1.

  Deprecated since version NX8.5.0: To set the value of the expression modify the expression directly using `GeometricUtilities.FeatureOffset.EndOffset()` and `Expression.RightHandSide()`.

  License requirements: solid_modeling (“SOLIDS MODELING”)

## SetStartOffset

`FeatureOffset.``SetStartOffset`

  The Start Offset

  Signature `SetStartOffset(valueExpression)`

  Parameters: | valueExpression (str) – value of start offset expression

  New in version NX3.0.1.

  Deprecated since version NX8.5.0: To set the value of the expression modify the expression directly using `GeometricUtilities.FeatureOffset.StartOffset()` and `Expression.RightHandSide()`.

  License requirements: solid_modeling (“SOLIDS MODELING”)

## Validate

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