ShipDimensionBuilder Class

class NXOpen.Annotations.ShipDimensionBuilder

Bases: NXOpen.Builder

Represents a NXOpen.Annotations.Dimension builder

To create a new instance of this class, use NXOpen.Annotations.ShipDimensionCollection.CreateShipDimensionBuilder()

New in version NX9.0.0.

Properties

Property	Description
AppendedText	Returns the appended text
Element	Returns or sets the element
ElementName	Returns or sets the element name
FirstAssociativity	Returns the first associativity
Group	Returns or sets the group
Inherit	Returns the inherit
Origin	Returns the origin
Style	Returns the style
Tag	Returns the Tag for this object.

Methods

Method	Description
Commit	Commits any edits that have been applied to the builder.
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.
ShowResults	Updates the model to reflect the result of an edit to the model for all builders that support showing results.
Validate	Validate whether the inputs to the component are sufficient for commit to be called.

Enumerations

ShipDimensionBuilderGroupType Enumeration

The enum represents group type from concept model

Property Detail

AppendedText

ShipDimensionBuilder.AppendedText

Returns the appended text

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

Getter Method

Signature AppendedText

Returns: Return type:NXOpen.Annotations.AppendedTextBuilder

New in version NX9.0.0.

License requirements: None.

Element

ShipDimensionBuilder.Element

Returns or sets the element

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

Getter Method

Signature Element

Returns: Return type:int

New in version NX9.0.0.

License requirements: None.

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

Setter Method

Signature Element

Parameters:element (int) –

New in version NX9.0.0.

License requirements: drafting (“DRAFTING”)

ElementName

ShipDimensionBuilder.ElementName

Returns or sets the element name

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

Getter Method

Signature ElementName

Returns: Return type:str

New in version NX9.0.0.

License requirements: drafting (“DRAFTING”)

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

Setter Method

Signature ElementName

Parameters:elementName (str) –

New in version NX9.0.0.

License requirements: drafting (“DRAFTING”)

FirstAssociativity

ShipDimensionBuilder.FirstAssociativity

Returns the first associativity

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

Getter Method

Signature FirstAssociativity

Returns: Return type:NXOpen.SelectDisplayableObject

New in version NX9.0.0.

License requirements: None.

Group

ShipDimensionBuilder.Group

Returns or sets the group

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

Getter Method

Signature Group

Returns: Return type:NXOpen.Annotations.ShipDimensionBuilderGroupType

New in version NX9.0.0.

License requirements: None.

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

Setter Method

Signature Group

Parameters:group (NXOpen.Annotations.ShipDimensionBuilderGroupType) –

New in version NX9.0.0.

License requirements: drafting (“DRAFTING”)

Inherit

ShipDimensionBuilder.Inherit

Returns the inherit

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

Getter Method

Signature Inherit

Returns: Return type:NXOpen.SelectDisplayableObject

New in version NX9.0.0.

License requirements: None.

Origin

ShipDimensionBuilder.Origin

Returns the origin

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

Getter Method

Signature Origin

Returns: Return type:NXOpen.Annotations.OriginBuilder

New in version NX9.0.0.

License requirements: None.

Style

ShipDimensionBuilder.Style

Returns the style

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

Getter Method

Signature Style

Returns: Return type:NXOpen.Annotations.StyleBuilder

New in version NX9.0.0.

License requirements: None.

Method Detail

Validate

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