ColumnGridEquipmentBuilder Class¶
-
class
NXOpen.LineDesigner.
ColumnGridEquipmentBuilder
¶ Bases:
NXOpen.Builder
Represents a LineDesigner.
ColumnGridEquipment builder
To create a new instance of this class, use
NXOpen.LineDesigner.LineDesignerManager.CreateColumnGridEquipmentBuilder
Default values.
Property Value BubbleDiameter 1200 BubbleExtension 750 BubbleExtensionOffset 400 BubbleLeader 750 ColumnBaseDepth.Value 800 (millimeters part), 32 (inches part) ColumnBaseDiameter.Value 800 (millimeters part), 32 (inches part) ColumnBaseHeight.Value 900 (millimeters part), 35 (inches part) ColumnBaseLowerDiameter.Value 900 (millimeters part), 32 (inches part) ColumnBaseTypeEnum None ColumnBaseUpperDiameter.Value 800 (millimeters part), 32 (inches part) ColumnBaseWidth.Value 800 (millimeters part), 35 (inches part) ColumnDepth.Value 600 (millimeters part), 25 (inches part) ColumnDiameter.Value 800 (millimeters part), 25 (inches part) ColumnDisplayIDs 1 ColumnElevation.Value 0 (millimeters part), 0 (inches part) ColumnHeight.Value 3000 (millimeters part), 120 (inches part) ColumnRotate90Degrees 0 ColumnSpacingDouble 15000 ColumnThickness.Value 30 (millimeters part), 2 (inches part) ColumnTypeEnum IBeam ColumnWideNumber 1 ColumnWidth.Value 600 (millimeters part), 12 (inches part) CreateBottomBubblesToggle 1 CreateLeftBubblesToggle 1 CreateRightBubblesToggle 1 CreateTopBubblesToggle 1 DefineGlobalSizeToggle 1 DisplayGridToggle 1 RowDeepNumber 1 RowSpacingDouble 15000 SelectGridArea.AllowRotation 1 UseSpacingToggle 1 New in version NX9.0.0.
Properties¶
Property | Description |
---|---|
BubbleDiameter | Returns or sets the bubble diameter |
BubbleExtension | Returns or sets the bubble extension |
BubbleExtensionOffset | Returns or sets the bubble extension offset |
BubbleLeader | Returns or sets the bubble leader |
BubblesUnallowedChars | Returns or sets the bubbles unallowed chars |
ColumnBaseCrossSection | Returns the column base cross section |
ColumnBaseDepth | Returns the column base depth |
ColumnBaseDiameter | Returns the column base diameter |
ColumnBaseHeight | Returns the column base height |
ColumnBaseLowerDiameter | Returns the column base lower diameter |
ColumnBaseTypeEnum | Returns or sets the column base type enum |
ColumnBaseUpperDiameter | Returns the column base upper diameter |
ColumnBaseWidth | Returns the column base width |
ColumnCrossSection | Returns the column cross section |
ColumnDataList | Returns the column data list |
ColumnDepth | Returns the column depth |
ColumnDiameter | Returns the column diameter |
ColumnDisplayIDs | Returns or sets the column display ids |
ColumnElevation | Returns the column elevation |
ColumnHeight | Returns the column height |
ColumnRotate90Degrees | Returns or sets the column rotate90 degrees |
ColumnSpacingDouble | Returns or sets the column spacing double |
ColumnThickness | Returns the column thickness |
ColumnTypeEnum | Returns or sets the column type enum |
ColumnWideNumber | Returns or sets the column wide number |
ColumnWidth | Returns the column width |
CreateBottomBubblesToggle | Returns or sets the create bottom bubbles toggle |
CreateLeftBubblesToggle | Returns or sets the create left bubbles toggle |
CreateRightBubblesToggle | Returns or sets the create right bubbles toggle |
CreateTopBubblesToggle | Returns or sets the create top bubbles toggle |
DefineGlobalSizeToggle | Returns or sets the define global size toggle |
DisplayGridToggle | Returns or sets the display grid toggle |
KfObject | Returns the kf object |
RowDataList | Returns the row data list |
RowDeepNumber | Returns or sets the row deep number |
RowSpacingDouble | Returns or sets the row spacing double |
SelectGridArea | Returns or sets the select grid area |
Tag | Returns the Tag for this object. |
UseSpacingToggle | Returns or sets the use spacing toggle |
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. |
ModifyColumnsButton | TODO: fill in a description for this |
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¶
ColumnGridEquipmentBuilderColumnBaseType Enumeration | |
ColumnGridEquipmentBuilderColumnType Enumeration |
Property Detail¶
BubbleDiameter¶
-
ColumnGridEquipmentBuilder.
BubbleDiameter
¶ Returns or sets the bubble diameter
-------------------------------------
Getter Method
Signature
BubbleDiameter()
Returns: Return type: float New in version NX9.0.0.
License requirements: ld_line_designer (“FULL LINE DESIGNER”)
-------------------------------------
Setter Method
Signature
BubbleDiameter(bubbleDiameter)
Parameters: bubbleDiameter (float) – New in version NX9.0.0.
License requirements: ld_line_designer (“FULL LINE DESIGNER”)
BubbleExtension¶
-
ColumnGridEquipmentBuilder.
BubbleExtension
¶ Returns or sets the bubble extension
-------------------------------------
Getter Method
Signature
BubbleExtension()
Returns: Return type: float New in version NX9.0.0.
License requirements: ld_line_designer (“FULL LINE DESIGNER”)
-------------------------------------
Setter Method
Signature
BubbleExtension(bubbleExtension)
Parameters: bubbleExtension (float) – New in version NX9.0.0.
License requirements: ld_line_designer (“FULL LINE DESIGNER”)
BubbleExtensionOffset¶
-
ColumnGridEquipmentBuilder.
BubbleExtensionOffset
¶ Returns or sets the bubble extension offset
-------------------------------------
Getter Method
Signature
BubbleExtensionOffset()
Returns: Return type: float New in version NX9.0.0.
License requirements: ld_line_designer (“FULL LINE DESIGNER”)
-------------------------------------
Setter Method
Signature
BubbleExtensionOffset(bubbleExtensionOffset)
Parameters: bubbleExtensionOffset (float) – New in version NX9.0.0.
License requirements: ld_line_designer (“FULL LINE DESIGNER”)
BubbleLeader¶
-
ColumnGridEquipmentBuilder.
BubbleLeader
¶ Returns or sets the bubble leader
-------------------------------------
Getter Method
Signature
BubbleLeader()
Returns: Return type: float New in version NX9.0.0.
License requirements: ld_line_designer (“FULL LINE DESIGNER”)
-------------------------------------
Setter Method
Signature
BubbleLeader(bubbleLeader)
Parameters: bubbleLeader (float) – New in version NX9.0.0.
License requirements: ld_line_designer (“FULL LINE DESIGNER”)
BubblesUnallowedChars¶
-
ColumnGridEquipmentBuilder.
BubblesUnallowedChars
¶ Returns or sets the bubbles unallowed chars
-------------------------------------
Getter Method
Signature
BubblesUnallowedChars()
Returns: Return type: str New in version NX9.0.0.
License requirements: ld_line_designer (“FULL LINE DESIGNER”)
-------------------------------------
Setter Method
Signature
BubblesUnallowedChars(bubblesUnallowedChars)
Parameters: bubblesUnallowedChars (str) – New in version NX9.0.0.
License requirements: ld_line_designer (“FULL LINE DESIGNER”)
ColumnBaseCrossSection¶
-
ColumnGridEquipmentBuilder.
ColumnBaseCrossSection
¶ Returns the column base cross section
-------------------------------------
Getter Method
Signature
ColumnBaseCrossSection()
Returns: Return type: NXOpen.Section
New in version NX9.0.0.
License requirements: ld_line_designer (“FULL LINE DESIGNER”)
ColumnBaseDepth¶
-
ColumnGridEquipmentBuilder.
ColumnBaseDepth
¶ Returns the column base depth
-------------------------------------
Getter Method
Signature
ColumnBaseDepth()
Returns: Return type: NXOpen.Expression
New in version NX9.0.0.
License requirements: ld_line_designer (“FULL LINE DESIGNER”)
ColumnBaseDiameter¶
-
ColumnGridEquipmentBuilder.
ColumnBaseDiameter
¶ Returns the column base diameter
-------------------------------------
Getter Method
Signature
ColumnBaseDiameter()
Returns: Return type: NXOpen.Expression
New in version NX9.0.0.
License requirements: ld_line_designer (“FULL LINE DESIGNER”)
ColumnBaseHeight¶
-
ColumnGridEquipmentBuilder.
ColumnBaseHeight
¶ Returns the column base height
-------------------------------------
Getter Method
Signature
ColumnBaseHeight()
Returns: Return type: NXOpen.Expression
New in version NX9.0.0.
License requirements: ld_line_designer (“FULL LINE DESIGNER”)
ColumnBaseLowerDiameter¶
-
ColumnGridEquipmentBuilder.
ColumnBaseLowerDiameter
¶ Returns the column base lower diameter
-------------------------------------
Getter Method
Signature
ColumnBaseLowerDiameter()
Returns: Return type: NXOpen.Expression
New in version NX9.0.0.
License requirements: ld_line_designer (“FULL LINE DESIGNER”)
ColumnBaseTypeEnum¶
-
ColumnGridEquipmentBuilder.
ColumnBaseTypeEnum
¶ Returns or sets the column base type enum
-------------------------------------
Getter Method
Signature
ColumnBaseTypeEnum()
Returns: Return type: NXOpen.LineDesigner.ColumnGridEquipmentBuilderColumnBaseType
New in version NX9.0.0.
License requirements: ld_line_designer (“FULL LINE DESIGNER”)
-------------------------------------
Setter Method
Signature
ColumnBaseTypeEnum(columnBaseTypeEnum)
Parameters: columnBaseTypeEnum ( NXOpen.LineDesigner.ColumnGridEquipmentBuilderColumnBaseType
) –New in version NX9.0.0.
License requirements: ld_line_designer (“FULL LINE DESIGNER”)
ColumnBaseUpperDiameter¶
-
ColumnGridEquipmentBuilder.
ColumnBaseUpperDiameter
¶ Returns the column base upper diameter
-------------------------------------
Getter Method
Signature
ColumnBaseUpperDiameter()
Returns: Return type: NXOpen.Expression
New in version NX9.0.0.
License requirements: ld_line_designer (“FULL LINE DESIGNER”)
ColumnBaseWidth¶
-
ColumnGridEquipmentBuilder.
ColumnBaseWidth
¶ Returns the column base width
-------------------------------------
Getter Method
Signature
ColumnBaseWidth()
Returns: Return type: NXOpen.Expression
New in version NX9.0.0.
License requirements: ld_line_designer (“FULL LINE DESIGNER”)
ColumnCrossSection¶
-
ColumnGridEquipmentBuilder.
ColumnCrossSection
¶ Returns the column cross section
-------------------------------------
Getter Method
Signature
ColumnCrossSection()
Returns: Return type: NXOpen.Section
New in version NX9.0.0.
License requirements: ld_line_designer (“FULL LINE DESIGNER”)
ColumnDataList¶
-
ColumnGridEquipmentBuilder.
ColumnDataList
¶ Returns the column data list
-------------------------------------
Getter Method
Signature
ColumnDataList()
Returns: Return type: NXOpen.NXObjectList
New in version NX9.0.0.
License requirements: ld_line_designer (“FULL LINE DESIGNER”)
ColumnDepth¶
-
ColumnGridEquipmentBuilder.
ColumnDepth
¶ Returns the column depth
-------------------------------------
Getter Method
Signature
ColumnDepth()
Returns: Return type: NXOpen.Expression
New in version NX9.0.0.
License requirements: ld_line_designer (“FULL LINE DESIGNER”)
ColumnDiameter¶
-
ColumnGridEquipmentBuilder.
ColumnDiameter
¶ Returns the column diameter
-------------------------------------
Getter Method
Signature
ColumnDiameter()
Returns: Return type: NXOpen.Expression
New in version NX9.0.0.
License requirements: ld_line_designer (“FULL LINE DESIGNER”)
ColumnDisplayIDs¶
-
ColumnGridEquipmentBuilder.
ColumnDisplayIDs
¶ Returns or sets the column display ids
-------------------------------------
Getter Method
Signature
ColumnDisplayIDs()
Returns: Return type: bool New in version NX9.0.0.
License requirements: ld_line_designer (“FULL LINE DESIGNER”)
-------------------------------------
Setter Method
Signature
ColumnDisplayIDs(columnDisplayIDs)
Parameters: columnDisplayIDs (bool) – New in version NX9.0.0.
License requirements: ld_line_designer (“FULL LINE DESIGNER”)
ColumnElevation¶
-
ColumnGridEquipmentBuilder.
ColumnElevation
¶ Returns the column elevation
-------------------------------------
Getter Method
Signature
ColumnElevation()
Returns: Return type: NXOpen.Expression
New in version NX9.0.0.
License requirements: ld_line_designer (“FULL LINE DESIGNER”)
ColumnHeight¶
-
ColumnGridEquipmentBuilder.
ColumnHeight
¶ Returns the column height
-------------------------------------
Getter Method
Signature
ColumnHeight()
Returns: Return type: NXOpen.Expression
New in version NX9.0.0.
License requirements: ld_line_designer (“FULL LINE DESIGNER”)
ColumnRotate90Degrees¶
-
ColumnGridEquipmentBuilder.
ColumnRotate90Degrees
¶ Returns or sets the column rotate90 degrees
-------------------------------------
Getter Method
Signature
ColumnRotate90Degrees()
Returns: Return type: bool New in version NX9.0.0.
License requirements: ld_line_designer (“FULL LINE DESIGNER”)
-------------------------------------
Setter Method
Signature
ColumnRotate90Degrees(columnRotate90Degrees)
Parameters: columnRotate90Degrees (bool) – New in version NX9.0.0.
License requirements: ld_line_designer (“FULL LINE DESIGNER”)
ColumnSpacingDouble¶
-
ColumnGridEquipmentBuilder.
ColumnSpacingDouble
¶ Returns or sets the column spacing double
-------------------------------------
Getter Method
Signature
ColumnSpacingDouble()
Returns: Return type: float New in version NX9.0.0.
License requirements: ld_line_designer (“FULL LINE DESIGNER”)
-------------------------------------
Setter Method
Signature
ColumnSpacingDouble(columnSpacingDouble)
Parameters: columnSpacingDouble (float) – New in version NX9.0.0.
License requirements: ld_line_designer (“FULL LINE DESIGNER”)
ColumnThickness¶
-
ColumnGridEquipmentBuilder.
ColumnThickness
¶ Returns the column thickness
-------------------------------------
Getter Method
Signature
ColumnThickness()
Returns: Return type: NXOpen.Expression
New in version NX9.0.0.
License requirements: ld_line_designer (“FULL LINE DESIGNER”)
ColumnTypeEnum¶
-
ColumnGridEquipmentBuilder.
ColumnTypeEnum
¶ Returns or sets the column type enum
-------------------------------------
Getter Method
Signature
ColumnTypeEnum()
Returns: Return type: NXOpen.LineDesigner.ColumnGridEquipmentBuilderColumnType
New in version NX9.0.0.
License requirements: ld_line_designer (“FULL LINE DESIGNER”)
-------------------------------------
Setter Method
Signature
ColumnTypeEnum(columnTypeEnum)
Parameters: columnTypeEnum ( NXOpen.LineDesigner.ColumnGridEquipmentBuilderColumnType
) –New in version NX9.0.0.
License requirements: ld_line_designer (“FULL LINE DESIGNER”)
ColumnWideNumber¶
-
ColumnGridEquipmentBuilder.
ColumnWideNumber
¶ Returns or sets the column wide number
-------------------------------------
Getter Method
Signature
ColumnWideNumber()
Returns: Return type: int New in version NX9.0.0.
License requirements: ld_line_designer (“FULL LINE DESIGNER”)
-------------------------------------
Setter Method
Signature
ColumnWideNumber(columnWideNumber)
Parameters: columnWideNumber (int) – New in version NX9.0.0.
License requirements: ld_line_designer (“FULL LINE DESIGNER”)
ColumnWidth¶
-
ColumnGridEquipmentBuilder.
ColumnWidth
¶ Returns the column width
-------------------------------------
Getter Method
Signature
ColumnWidth()
Returns: Return type: NXOpen.Expression
New in version NX9.0.0.
License requirements: ld_line_designer (“FULL LINE DESIGNER”)
CreateBottomBubblesToggle¶
-
ColumnGridEquipmentBuilder.
CreateBottomBubblesToggle
¶ Returns or sets the create bottom bubbles toggle
-------------------------------------
Getter Method
Signature
CreateBottomBubblesToggle()
Returns: Return type: bool New in version NX9.0.0.
License requirements: ld_line_designer (“FULL LINE DESIGNER”)
-------------------------------------
Setter Method
Signature
CreateBottomBubblesToggle(createBottomBubblesToggle)
Parameters: createBottomBubblesToggle (bool) – New in version NX9.0.0.
License requirements: ld_line_designer (“FULL LINE DESIGNER”)
CreateLeftBubblesToggle¶
-
ColumnGridEquipmentBuilder.
CreateLeftBubblesToggle
¶ Returns or sets the create left bubbles toggle
-------------------------------------
Getter Method
Signature
CreateLeftBubblesToggle()
Returns: Return type: bool New in version NX9.0.0.
License requirements: ld_line_designer (“FULL LINE DESIGNER”)
-------------------------------------
Setter Method
Signature
CreateLeftBubblesToggle(createLeftBubblesToggle)
Parameters: createLeftBubblesToggle (bool) – New in version NX9.0.0.
License requirements: ld_line_designer (“FULL LINE DESIGNER”)
CreateRightBubblesToggle¶
-
ColumnGridEquipmentBuilder.
CreateRightBubblesToggle
¶ Returns or sets the create right bubbles toggle
-------------------------------------
Getter Method
Signature
CreateRightBubblesToggle()
Returns: Return type: bool New in version NX9.0.0.
License requirements: ld_line_designer (“FULL LINE DESIGNER”)
-------------------------------------
Setter Method
Signature
CreateRightBubblesToggle(createRightBubblesToggle)
Parameters: createRightBubblesToggle (bool) – New in version NX9.0.0.
License requirements: ld_line_designer (“FULL LINE DESIGNER”)
CreateTopBubblesToggle¶
-
ColumnGridEquipmentBuilder.
CreateTopBubblesToggle
¶ Returns or sets the create top bubbles toggle
-------------------------------------
Getter Method
Signature
CreateTopBubblesToggle()
Returns: Return type: bool New in version NX9.0.0.
License requirements: ld_line_designer (“FULL LINE DESIGNER”)
-------------------------------------
Setter Method
Signature
CreateTopBubblesToggle(createTopBubblesToggle)
Parameters: createTopBubblesToggle (bool) – New in version NX9.0.0.
License requirements: ld_line_designer (“FULL LINE DESIGNER”)
DefineGlobalSizeToggle¶
-
ColumnGridEquipmentBuilder.
DefineGlobalSizeToggle
¶ Returns or sets the define global size toggle
-------------------------------------
Getter Method
Signature
DefineGlobalSizeToggle()
Returns: Return type: bool New in version NX9.0.0.
License requirements: ld_line_designer (“FULL LINE DESIGNER”)
-------------------------------------
Setter Method
Signature
DefineGlobalSizeToggle(defineGlobalSizeToggle)
Parameters: defineGlobalSizeToggle (bool) – New in version NX9.0.0.
License requirements: ld_line_designer (“FULL LINE DESIGNER”)
DisplayGridToggle¶
-
ColumnGridEquipmentBuilder.
DisplayGridToggle
¶ Returns or sets the display grid toggle
-------------------------------------
Getter Method
Signature
DisplayGridToggle()
Returns: Return type: bool New in version NX9.0.0.
License requirements: ld_line_designer (“FULL LINE DESIGNER”)
-------------------------------------
Setter Method
Signature
DisplayGridToggle(displayGridToggle)
Parameters: displayGridToggle (bool) – New in version NX9.0.0.
License requirements: ld_line_designer (“FULL LINE DESIGNER”)
KfObject¶
-
ColumnGridEquipmentBuilder.
KfObject
¶ Returns the kf object
-------------------------------------
Getter Method
Signature
KfObject()
Returns: Return type: NXOpen.KFObject
New in version NX9.0.0.
License requirements: ld_line_designer (“FULL LINE DESIGNER”)
RowDataList¶
-
ColumnGridEquipmentBuilder.
RowDataList
¶ Returns the row data list
-------------------------------------
Getter Method
Signature
RowDataList()
Returns: Return type: NXOpen.NXObjectList
New in version NX9.0.0.
License requirements: ld_line_designer (“FULL LINE DESIGNER”)
RowDeepNumber¶
-
ColumnGridEquipmentBuilder.
RowDeepNumber
¶ Returns or sets the row deep number
-------------------------------------
Getter Method
Signature
RowDeepNumber()
Returns: Return type: int New in version NX9.0.0.
License requirements: ld_line_designer (“FULL LINE DESIGNER”)
-------------------------------------
Setter Method
Signature
RowDeepNumber(rowDeepNumber)
Parameters: rowDeepNumber (int) – New in version NX9.0.0.
License requirements: ld_line_designer (“FULL LINE DESIGNER”)
RowSpacingDouble¶
-
ColumnGridEquipmentBuilder.
RowSpacingDouble
¶ Returns or sets the row spacing double
-------------------------------------
Getter Method
Signature
RowSpacingDouble()
Returns: Return type: float New in version NX9.0.0.
License requirements: ld_line_designer (“FULL LINE DESIGNER”)
-------------------------------------
Setter Method
Signature
RowSpacingDouble(rowSpacingDouble)
Parameters: rowSpacingDouble (float) – New in version NX9.0.0.
License requirements: ld_line_designer (“FULL LINE DESIGNER”)
SelectGridArea¶
-
ColumnGridEquipmentBuilder.
SelectGridArea
¶ Returns or sets the select grid area
-------------------------------------
Getter Method
Signature
SelectGridArea()
Returns: Return type: NXOpen.LineDesigner.PickRectanglePointsBuilder
New in version NX9.0.0.
License requirements: ld_line_designer (“FULL LINE DESIGNER”)
-------------------------------------
Setter Method
Signature
SelectGridArea(selectGridArea)
Parameters: selectGridArea ( NXOpen.LineDesigner.PickRectanglePointsBuilder
) –New in version NX9.0.0.
License requirements: ld_line_designer (“FULL LINE DESIGNER”)
UseSpacingToggle¶
-
ColumnGridEquipmentBuilder.
UseSpacingToggle
¶ Returns or sets the use spacing toggle
-------------------------------------
Getter Method
Signature
UseSpacingToggle()
Returns: Return type: bool New in version NX9.0.0.
License requirements: ld_line_designer (“FULL LINE DESIGNER”)
-------------------------------------
Setter Method
Signature
UseSpacingToggle(useSpacingToggle)
Parameters: useSpacingToggle (bool) – New in version NX9.0.0.
License requirements: ld_line_designer (“FULL LINE DESIGNER”)
Method Detail¶
ModifyColumnsButton¶
-
ColumnGridEquipmentBuilder.
ModifyColumnsButton
¶ TODO: fill in a description for this
Signature
ModifyColumnsButton()
New in version NX9.0.0.
License requirements: ld_line_designer (“FULL LINE DESIGNER”)
Validate¶
-
ColumnGridEquipmentBuilder.
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.