SpineDefinitionBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# SpineDefinitionBuilder Class

class `NXOpen.GeometricUtilities.``SpineDefinitionBuilder`

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

  Provides a spine definition for modeling operations

  New in version NX8.5.0.

# Properties

Property | Description
--- | ---
Method | Returns or sets the method
Section | Returns the section
Tag | Returns the Tag for this object.
Vector | Returns or sets the vector

# Methods

Method | Description
--- | ---
Validate | Validate whether the inputs to the component are sufficient for commit to be called.

# Enumerations

SpineDefinitionBuilderMethodOptions Enumeration | Options to define a spine

# Property Detail

## Method

`SpineDefinitionBuilder.``Method`

  Returns or sets the method

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

  Getter Method

  Signature `Method`

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

  New in version NX8.5.0.

  License requirements: None.

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

  Setter Method

  Signature `Method`

  Parameters: | method (`NXOpen.GeometricUtilities.SpineDefinitionBuilderMethodOptions`) –

  New in version NX8.5.0.

  License requirements: solid_modeling (“SOLIDS MODELING”)

## Section

`SpineDefinitionBuilder.``Section`

  Returns the section

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

  Getter Method

  Signature `Section`

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

  New in version NX8.5.0.

  License requirements: None.

## Vector

`SpineDefinitionBuilder.``Vector`

  Returns or sets the vector

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

  Getter Method

  Signature `Vector`

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

  New in version NX8.5.0.

  License requirements: None.

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

  Setter Method

  Signature `Vector`

  Parameters: | vector (`NXOpen.Direction`) –

  New in version NX8.5.0.

  License requirements: solid_modeling (“SOLIDS MODELING”)

# Method Detail

## Validate

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