FrameBarBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# FrameBarBuilder Class

class `NXOpen.Annotations.``FrameBarBuilder`

  Bases: `NXOpen.Annotations.BaseFrameBarBuilder`

  Represents a `NXOpen.Annotations.FrameBarBuilder`.

  This class allows to create frame bar annotation

  To create a new instance of this class, use `NXOpen.Annotations.FrameBarCollection.CreateFrameBarBuilder()`

  Default values.

  Property | Value
  --- | ---
  AftPerpendicular | 0
  Axis | X
  Baseline | 0
  BulkHeads | 0
  Centerline | 0
  Decks | 0
  ForwardPerpendicular | 0
  InterTransverseFrames | 0
  LongitudinalYFrames | 0
  LongitudinalZFrames | 0
  TransveralInsertArea | 0
  TransverseFrames | 0
  Waterline | 0

  New in version NX8.0.0.

# Properties

Property | Description
--- | ---
AftPerpendicular | Returns or sets the aft perpendicular
Axis | Returns or sets the axis
Baseline | Returns or sets the baseline
BulkHeads | Returns or sets the bulk heads
Centerline | Returns or sets the centerline
Decks | Returns or sets the decks
ForwardPerpendicular | Returns or sets the forward perpendicular
InterTransverseFrames | Returns or sets the inter transverse frames
LongitudinalYFrames | Returns or sets the longitudinal yframes
LongitudinalZFrames | Returns or sets the longitudinal zframes
Origin | Returns the origin
Style | Returns the style
Tag | Returns the Tag for this object.
TransveralInsertArea | Returns or sets the transveral insert area
TransverseFrames | Returns or sets the transverse frames
View | Returns the select view
Waterline | Returns or sets the waterline

# Methods

Method | Description
--- | ---
Commit | Commits any edits that have been applied to the builder.
CreateFrameBarObject | Creates frame bar object
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.
GetFramebar | The frame bar
GetObject | Returns the object currently being edited by this builder.
ReverseTics | This function is used to reverse tics on the framebar
ShowResults | Updates the model to reflect the result of an edit to the model for all builders that support showing results.
UpdateFrameBarFromStyle | Updates frame bar object as per style
UpdateFromConceptModel | This function is used to update framebar from Concept model
Validate | Validate whether the inputs to the component are sufficient for commit to be called.

# Method Detail

## Validate

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