QualifySketchBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# QualifySketchBuilder Class

class `NXOpen.Features.ShipDesign.``QualifySketchBuilder`

  Bases: `NXOpen.Builder`

  Represents a `NXOpen.Features.ShipDesign.QualifySketchBuilder` builder.

  To create a new instance of this class, use `NXOpen.Features.ShipCollection.CreateQualifySketchBuilder()`

  New in version NX8.0.0.

# Properties

Property | Description
--- | ---
ActiveRowIndex | Returns or sets the active row index.
BaseLine | Returns the selected base line.
ContextAttribute | Returns or sets the context attribute.
Feature | Returns or sets the steel feture type.
ModelFile | Returns or sets the model file name.
ModelList | Returns the model list.
ModelPath | Returns or sets the model file path.
MoldLine | Returns the selected mold line.
OpposingMoldLine | Returns the selected opposing mold line.
SectionType | Returns or sets the section type.
ShearLine | Returns the selected shear line.
ShipNo | Returns or sets the ship no.
SpreadSheetFile | Returns or sets the parameter spreadsheet file.
SpreadSheetPath | Returns or sets the parameter spreadsheet path.
Tag | Returns the Tag for this object.
TaperLine | Returns the selected taper line.
TopLine | Returns the selected top line.

# Methods

Method | Description
--- | ---
AssignAttribute | Assigns attributes to the anchor point.
Commit | Commits any edits that have been applied to the builder.
CreateNewAnchorPoint | Creates the anchor point.
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.
OpenParameterSpreadSheetToEdit | Opens parameter spreadsheet to edit.
OpenPartFile | Opens the template part file.
OpenRegistrationSpreadSheetToEdit | Opens registration spreadsheet to edit.
PreviewLeftImage | Previews left image.
PreviewRightImage | Previews right image.
ReloadParameterSpreadSheet | Reloads parameter spreadsheet.
ReloadRegisterSpreadSheet | Reloads registration spreadsheet.
ReloadTable | Reloads expression table.
RemoveAttribute | Removes attributes from the entity.
ShowResults | Updates the model to reflect the result of an edit to the model for all builders that support showing results.
UpdateSketch | Updates sketch.
Validate | Validate whether the inputs to the component are sufficient for commit to be called.
ValidateCurves | Validates Curves.
ValidateParameterSpreadSheet | Validates parameter spreadsheet.
ValidatePartAttributes | Validates the part attributes.
ValidateSketchCurves | Validates the sketch curves.

# Property Detail

## ActiveRowIndex

`QualifySketchBuilder.``ActiveRowIndex`

  Returns or sets the active row index.

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

  Getter Method

  Signature `ActiveRowIndex`

  Returns: |
  Return type: | int

  New in version NX8.0.0.

  License requirements: None.

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

  Setter Method

  Signature `ActiveRowIndex`

  Parameters: | activeRowIndex (int) –

  New in version NX8.0.0.

  License requirements: nx_ship_detail (“Ship Detail Design”) OR nx_ship_basic (“Ship Basic Design”)

## BaseLine

`QualifySketchBuilder.``BaseLine`

  Returns the selected base line.

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

  Getter Method

  Signature `BaseLine`

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

  New in version NX8.0.0.

  License requirements: None.

## ContextAttribute

`QualifySketchBuilder.``ContextAttribute`

  Returns or sets the context attribute.

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

  Getter Method

  Signature `ContextAttribute`

  Returns: |
  Return type: | int

  New in version NX8.0.0.

  License requirements: None.

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

  Setter Method

  Signature `ContextAttribute`

  Parameters: | contextAttribute (int) –

  New in version NX8.0.0.

  License requirements: nx_ship_detail (“Ship Detail Design”) OR nx_ship_basic (“Ship Basic Design”)

## Feature

`QualifySketchBuilder.``Feature`

  Returns or sets the steel feture type.

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

  Getter Method

  Signature `Feature`

  Returns: |
  Return type: | int

  New in version NX8.0.0.

  License requirements: None.

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

  Setter Method

  Signature `Feature`

  Parameters: | feature (int) –

  New in version NX8.0.0.

  License requirements: nx_ship_detail (“Ship Detail Design”) OR nx_ship_basic (“Ship Basic Design”)

## ModelFile

`QualifySketchBuilder.``ModelFile`

  Returns or sets the model file name.

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

  Getter Method

  Signature `ModelFile`

  Returns: |
  Return type: | str

  New in version NX8.0.0.

  License requirements: None.

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

  Setter Method

  Signature `ModelFile`

  Parameters: | modelFile (str) –

  New in version NX8.0.0.

  License requirements: nx_ship_detail (“Ship Detail Design”) OR nx_ship_basic (“Ship Basic Design”)

## ModelList

`QualifySketchBuilder.``ModelList`

  Returns the model list.

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

  Getter Method

  Signature `ModelList`

  Returns: |
  Return type: | `NXOpen.Features.ShipDesign.AnchorPointList`

  New in version NX8.0.0.

  License requirements: None.

## ModelPath

`QualifySketchBuilder.``ModelPath`

  Returns or sets the model file path.

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

  Getter Method

  Signature `ModelPath`

  Returns: |
  Return type: | str

  New in version NX8.0.0.

  License requirements: None.

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

  Setter Method

  Signature `ModelPath`

  Parameters: | modelPath (str) –

  New in version NX8.0.0.

  License requirements: nx_ship_detail (“Ship Detail Design”) OR nx_ship_basic (“Ship Basic Design”)

## MoldLine

`QualifySketchBuilder.``MoldLine`

  Returns the selected mold line.

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

  Getter Method

  Signature `MoldLine`

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

  New in version NX8.0.0.

  License requirements: None.

## OpposingMoldLine

`QualifySketchBuilder.``OpposingMoldLine`

  Returns the selected opposing mold line.

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

  Getter Method

  Signature `OpposingMoldLine`

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

  New in version NX8.0.0.

  License requirements: None.

## SectionType

`QualifySketchBuilder.``SectionType`

  Returns or sets the section type.

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

  Getter Method

  Signature `SectionType`

  Returns: |
  Return type: | int

  New in version NX8.0.0.

  License requirements: None.

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

  Setter Method

  Signature `SectionType`

  Parameters: | sectionType (int) –

  New in version NX8.0.0.

  License requirements: nx_ship_detail (“Ship Detail Design”) OR nx_ship_basic (“Ship Basic Design”)

## ShearLine

`QualifySketchBuilder.``ShearLine`

  Returns the selected shear line.

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

  Getter Method

  Signature `ShearLine`

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

  New in version NX8.0.0.

  License requirements: None.

## ShipNo

`QualifySketchBuilder.``ShipNo`

  Returns or sets the ship no.

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

  Getter Method

  Signature `ShipNo`

  Returns: |
  Return type: | int

  New in version NX8.0.0.

  License requirements: None.

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

  Setter Method

  Signature `ShipNo`

  Parameters: | shipNo (int) –

  New in version NX8.0.0.

  License requirements: nx_ship_detail (“Ship Detail Design”) OR nx_ship_basic (“Ship Basic Design”)

## SpreadSheetFile

`QualifySketchBuilder.``SpreadSheetFile`

  Returns or sets the parameter spreadsheet file.

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

  Getter Method

  Signature `SpreadSheetFile`

  Returns: |
  Return type: | str

  New in version NX8.0.0.

  License requirements: None.

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

  Setter Method

  Signature `SpreadSheetFile`

  Parameters: | spreadSheetFile (str) –

  New in version NX8.0.0.

  License requirements: nx_ship_detail (“Ship Detail Design”) OR nx_ship_basic (“Ship Basic Design”)

## SpreadSheetPath

`QualifySketchBuilder.``SpreadSheetPath`

  Returns or sets the parameter spreadsheet path.

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

  Getter Method

  Signature `SpreadSheetPath`

  Returns: |
  Return type: | str

  New in version NX8.0.0.

  License requirements: None.

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

  Setter Method

  Signature `SpreadSheetPath`

  Parameters: | spreadSheetPath (str) –

  New in version NX8.0.0.

  License requirements: nx_ship_detail (“Ship Detail Design”) OR nx_ship_basic (“Ship Basic Design”)

## TaperLine

`QualifySketchBuilder.``TaperLine`

  Returns the selected taper line.

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

  Getter Method

  Signature `TaperLine`

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

  New in version NX8.0.0.

  License requirements: None.

## TopLine

`QualifySketchBuilder.``TopLine`

  Returns the selected top line.

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

  Getter Method

  Signature `TopLine`

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

  New in version NX8.0.0.

  License requirements: None.

# Method Detail

## AssignAttribute

`QualifySketchBuilder.``AssignAttribute`

  Assigns attributes to the anchor point.

  Signature `AssignAttribute(entity, category, title, value, attrType, objName)`

  Parameters:

  - entity (`NXOpen.TaggedObject`) –
  - category (str) –
  - title (str) –
  - value (str) –
  - attrType (int) –
  - objName (str) –

  New in version NX8.0.0.

  License requirements: nx_ship_detail (“Ship Detail Design”) OR nx_ship_basic (“Ship Basic Design”)

## CreateNewAnchorPoint

`QualifySketchBuilder.``CreateNewAnchorPoint`

  Creates the anchor point.

  Signature `CreateNewAnchorPoint()`

  Returns: |
  Return type: | `NXOpen.Features.ShipDesign.AnchorPoint`

  New in version NX8.0.0.

  License requirements: nx_ship_detail (“Ship Detail Design”) OR nx_ship_basic (“Ship Basic Design”)

## OpenParameterSpreadSheetToEdit

`QualifySketchBuilder.``OpenParameterSpreadSheetToEdit`

  Opens parameter spreadsheet to edit.

  Signature `OpenParameterSpreadSheetToEdit()`

  New in version NX8.0.0.

  License requirements: nx_ship_detail (“Ship Detail Design”) OR nx_ship_basic (“Ship Basic Design”)

## OpenPartFile

`QualifySketchBuilder.``OpenPartFile`

  Opens the template part file.

  Signature `OpenPartFile()`

  New in version NX8.0.0.

  License requirements: nx_ship_detail (“Ship Detail Design”) OR nx_ship_basic (“Ship Basic Design”)

## OpenRegistrationSpreadSheetToEdit

`QualifySketchBuilder.``OpenRegistrationSpreadSheetToEdit`

  Opens registration spreadsheet to edit.

  Signature `OpenRegistrationSpreadSheetToEdit()`

  New in version NX8.0.0.

  License requirements: nx_ship_detail (“Ship Detail Design”) OR nx_ship_basic (“Ship Basic Design”)

## PreviewLeftImage

`QualifySketchBuilder.``PreviewLeftImage`

  Previews left image.

  Signature `PreviewLeftImage()`

  New in version NX8.0.0.

  License requirements: nx_ship_detail (“Ship Detail Design”) OR nx_ship_basic (“Ship Basic Design”)

## PreviewRightImage

`QualifySketchBuilder.``PreviewRightImage`

  Previews right image.

  Signature `PreviewRightImage()`

  New in version NX8.0.0.

  License requirements: nx_ship_detail (“Ship Detail Design”) OR nx_ship_basic (“Ship Basic Design”)

## ReloadParameterSpreadSheet

`QualifySketchBuilder.``ReloadParameterSpreadSheet`

  Reloads parameter spreadsheet.

  Signature `ReloadParameterSpreadSheet()`

  New in version NX8.0.0.

  License requirements: nx_ship_detail (“Ship Detail Design”) OR nx_ship_basic (“Ship Basic Design”)

## ReloadRegisterSpreadSheet

`QualifySketchBuilder.``ReloadRegisterSpreadSheet`

  Reloads registration spreadsheet.

  Signature `ReloadRegisterSpreadSheet()`

  New in version NX8.0.0.

  License requirements: nx_ship_detail (“Ship Detail Design”) OR nx_ship_basic (“Ship Basic Design”)

## ReloadTable

`QualifySketchBuilder.``ReloadTable`

  Reloads expression table.

  Signature `ReloadTable()`

  New in version NX8.0.0.

  License requirements: nx_ship_detail (“Ship Detail Design”) OR nx_ship_basic (“Ship Basic Design”)

## RemoveAttribute

`QualifySketchBuilder.``RemoveAttribute`

  Removes attributes from the entity.

  Signature `RemoveAttribute(entity, category, title, attrType)`

  Parameters:

  - entity (`NXOpen.TaggedObject`) –
  - category (str) –
  - title (str) –
  - attrType (int) –

  New in version NX8.0.0.

  License requirements: nx_ship_detail (“Ship Detail Design”) OR nx_ship_basic (“Ship Basic Design”)

## UpdateSketch

`QualifySketchBuilder.``UpdateSketch`

  Updates sketch.

  Signature `UpdateSketch()`

  New in version NX8.0.0.

  License requirements: nx_ship_detail (“Ship Detail Design”) OR nx_ship_basic (“Ship Basic Design”)

## Validate

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

## ValidateCurves

`QualifySketchBuilder.``ValidateCurves`

  Validates Curves.

  Signature `ValidateCurves()`

  New in version NX8.0.0.

  License requirements: nx_ship_detail (“Ship Detail Design”) OR nx_ship_basic (“Ship Basic Design”)

## ValidateParameterSpreadSheet

`QualifySketchBuilder.``ValidateParameterSpreadSheet`

  Validates parameter spreadsheet.

  Signature `ValidateParameterSpreadSheet()`

  New in version NX8.0.0.

  License requirements: nx_ship_detail (“Ship Detail Design”) OR nx_ship_basic (“Ship Basic Design”)

## ValidatePartAttributes

`QualifySketchBuilder.``ValidatePartAttributes`

  Validates the part attributes.

  Signature `ValidatePartAttributes()`

  New in version NX8.0.0.

  License requirements: nx_ship_detail (“Ship Detail Design”) OR nx_ship_basic (“Ship Basic Design”)

## ValidateSketchCurves

`QualifySketchBuilder.``ValidateSketchCurves`

  Validates the sketch curves.

  Signature `ValidateSketchCurves()`

  New in version NX8.0.0.

  License requirements: nx_ship_detail (“Ship Detail Design”) OR nx_ship_basic (“Ship Basic Design”)