BaseFrameBarBuilder Class

class NXOpen.Annotations.BaseFrameBarBuilder

Bases: NXOpen.Builder

Represents a NXOpen.Annotations.BaseFrameBarBuilder.

This class allows to create frame bar annotation

This is an abstract class, and cannot be instantiated.

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.

Enumerations

BaseFrameBarBuilderAxisType Enumeration

Enum for Ship Axis This is used by NXOpen.Annotations.BaseFrameBarBuilder.Axis() and NXOpen.Annotations.BaseFrameBarBuilder.Axis() to get/set the axis for a frame bar

Property Detail

AftPerpendicular

BaseFrameBarBuilder.AftPerpendicular

Returns or sets the aft perpendicular

-------------------------------------

Getter Method

Signature AftPerpendicular

Returns: Return type:bool

New in version NX8.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature AftPerpendicular

Parameters:aftPerpendicular (bool) –

New in version NX8.0.0.

License requirements: nx_ship_drafting (“Ship Drafting”)

Axis

BaseFrameBarBuilder.Axis

Returns or sets the axis

-------------------------------------

Getter Method

Signature Axis

Returns: Return type:NXOpen.Annotations.BaseFrameBarBuilderAxisType

New in version NX8.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature Axis

Parameters:axis (NXOpen.Annotations.BaseFrameBarBuilderAxisType) –

New in version NX8.0.0.

License requirements: nx_ship_drafting (“Ship Drafting”)

Baseline

BaseFrameBarBuilder.Baseline

Returns or sets the baseline

-------------------------------------

Getter Method

Signature Baseline

Returns: Return type:bool

New in version NX8.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature Baseline

Parameters:baseline (bool) –

New in version NX8.0.0.

License requirements: nx_ship_drafting (“Ship Drafting”)

BulkHeads

BaseFrameBarBuilder.BulkHeads

Returns or sets the bulk heads

-------------------------------------

Getter Method

Signature BulkHeads

Returns: Return type:bool

New in version NX8.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature BulkHeads

Parameters:bulkHeads (bool) –

New in version NX8.0.0.

License requirements: nx_ship_drafting (“Ship Drafting”)

Centerline

BaseFrameBarBuilder.Centerline

Returns or sets the centerline

-------------------------------------

Getter Method

Signature Centerline

Returns: Return type:bool

New in version NX8.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature Centerline

Parameters:centerline (bool) –

New in version NX8.0.0.

License requirements: nx_ship_drafting (“Ship Drafting”)

Decks

BaseFrameBarBuilder.Decks

Returns or sets the decks

-------------------------------------

Getter Method

Signature Decks

Returns: Return type:bool

New in version NX8.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature Decks

Parameters:decks (bool) –

New in version NX8.0.0.

License requirements: nx_ship_drafting (“Ship Drafting”)

ForwardPerpendicular

BaseFrameBarBuilder.ForwardPerpendicular

Returns or sets the forward perpendicular

-------------------------------------

Getter Method

Signature ForwardPerpendicular

Returns: Return type:bool

New in version NX8.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature ForwardPerpendicular

Parameters:forwardPerpendicular (bool) –

New in version NX8.0.0.

License requirements: nx_ship_drafting (“Ship Drafting”)

InterTransverseFrames

BaseFrameBarBuilder.InterTransverseFrames

Returns or sets the inter transverse frames

-------------------------------------

Getter Method

Signature InterTransverseFrames

Returns: Return type:bool

New in version NX8.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature InterTransverseFrames

Parameters:interTransverseFrames (bool) –

New in version NX8.0.0.

License requirements: nx_ship_drafting (“Ship Drafting”)

LongitudinalYFrames

BaseFrameBarBuilder.LongitudinalYFrames

Returns or sets the longitudinal yframes

-------------------------------------

Getter Method

Signature LongitudinalYFrames

Returns: Return type:bool

New in version NX8.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature LongitudinalYFrames

Parameters:longitudinalYFrames (bool) –

New in version NX8.0.0.

License requirements: nx_ship_drafting (“Ship Drafting”)

LongitudinalZFrames

BaseFrameBarBuilder.LongitudinalZFrames

Returns or sets the longitudinal zframes

-------------------------------------

Getter Method

Signature LongitudinalZFrames

Returns: Return type:bool

New in version NX8.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature LongitudinalZFrames

Parameters:longitudinalZFrames (bool) –

New in version NX8.0.0.

License requirements: nx_ship_drafting (“Ship Drafting”)

Origin

BaseFrameBarBuilder.Origin

Returns the origin

-------------------------------------

Getter Method

Signature Origin

Returns: Return type:NXOpen.Annotations.OriginBuilder

New in version NX8.0.0.

License requirements: None.

Style

BaseFrameBarBuilder.Style

Returns the style

-------------------------------------

Getter Method

Signature Style

Returns: Return type:NXOpen.Annotations.StyleBuilder

New in version NX8.0.0.

License requirements: None.

TransveralInsertArea

BaseFrameBarBuilder.TransveralInsertArea

Returns or sets the transveral insert area

-------------------------------------

Getter Method

Signature TransveralInsertArea

Returns: Return type:bool

New in version NX8.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature TransveralInsertArea

Parameters:transveralInsertArea (bool) –

New in version NX8.0.0.

License requirements: nx_ship_drafting (“Ship Drafting”)

TransverseFrames

BaseFrameBarBuilder.TransverseFrames

Returns or sets the transverse frames

-------------------------------------

Getter Method

Signature TransverseFrames

Returns: Return type:bool

New in version NX8.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature TransverseFrames

Parameters:transverseFrames (bool) –

New in version NX8.0.0.

License requirements: nx_ship_drafting (“Ship Drafting”)

View

BaseFrameBarBuilder.View

Returns the select view

-------------------------------------

Getter Method

Signature View

Returns: Return type:NXOpen.Drawings.SelectDraftingView

New in version NX8.0.0.

License requirements: None.

Waterline

BaseFrameBarBuilder.Waterline

Returns or sets the waterline

-------------------------------------

Getter Method

Signature Waterline

Returns: Return type:bool

New in version NX8.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature Waterline

Parameters:waterline (bool) –

New in version NX8.0.0.

License requirements: nx_ship_drafting (“Ship Drafting”)

Method Detail

CreateFrameBarObject

BaseFrameBarBuilder.CreateFrameBarObject

Creates frame bar object

Signature CreateFrameBarObject()

New in version NX8.0.0.

License requirements: nx_ship_drafting (“Ship Drafting”)

GetFramebar

BaseFrameBarBuilder.GetFramebar

The frame bar

Signature GetFramebar()

Returns:The frame bar Return type:NXOpen.Annotations.BaseFrameBar

New in version NX8.0.0.

License requirements: None.

ReverseTics

BaseFrameBarBuilder.ReverseTics

This function is used to reverse tics on the framebar

Signature ReverseTics()

New in version NX8.0.0.

License requirements: nx_ship_drafting (“Ship Drafting”)

UpdateFrameBarFromStyle

BaseFrameBarBuilder.UpdateFrameBarFromStyle

Updates frame bar object as per style

Signature UpdateFrameBarFromStyle()

New in version NX8.0.0.

License requirements: nx_ship_drafting (“Ship Drafting”)

UpdateFromConceptModel

BaseFrameBarBuilder.UpdateFromConceptModel

This function is used to update framebar from Concept model

Signature UpdateFromConceptModel()

New in version NX8.0.0.

License requirements: nx_ship_drafting (“Ship Drafting”)

Validate

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