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 value of bubble diameter in column grid |
BubbleExtension | Returns or sets the value of bubble extension of column grid |
BubbleExtensionOffset | Returns or sets the bubble extension offset value of column grid |
BubbleLeader | Returns or sets the bubble leader |
BubblesUnallowedChars | Returns or sets the bubbles unallowed characters in column grid |
ColumnBaseCrossSection | Returns the column base cross section of column grid |
ColumnBaseDepth | Returns the column base depth of column grid |
ColumnBaseDiameter | Returns the column base diameter of column grid |
ColumnBaseHeight | Returns the column base height of column grid |
ColumnBaseLowerDiameter | Returns the column base lower diameter of column grid |
ColumnBaseTypeEnum | Returns or sets the column base type of column grid |
ColumnBaseUpperDiameter | Returns the column base upper diameter of column grid |
ColumnBaseWidth | Returns the column base width of column grid |
ColumnCrossSection | Returns the column cross section of columns of column grid |
ColumnDataList | Returns the column data list |
ColumnDepth | Returns the column depth of column grid |
ColumnDiameter | Returns the column diameter of column grid |
ColumnDisplayIDs | Returns or sets the status of column display ids in column grid |
ColumnElevation | Returns the column elevation of column grid |
ColumnHeight | Returns the column height of columns of column grid |
ColumnRotate90Degrees | Returns or sets the status of 90 degree column rotation for column grid |
ColumnSpacingDouble | Returns or sets the spacing between columns |
ColumnThickness | Returns the column thickness of coulmn grid |
ColumnTypeEnum | Returns or sets the column type of column grid |
ColumnWideNumber | Returns or sets the number of column of columns in column grid |
ColumnWidth | Returns the column width of column grid |
CreateBottomBubblesToggle | Returns or sets the status to create bottom bubbles of column grid |
CreateLeftBubblesToggle | Returns or sets the status to create left bubbles of column grid |
CreateRightBubblesToggle | Returns or sets the status to create right bubbles of column grid |
CreateTopBubblesToggle | Returns or sets the status to create top bubbles in column grid |
DefineGlobalSizeToggle | Returns or sets the define global size toggle of column grid |
DisplayGridToggle | Returns or sets the display grid status of column grid |
KfObject | Returns the kf object |
RowDataList | Returns the row data list |
RowDeepNumber | Returns or sets the number of rows of columns in column grid |
RowSpacingDouble | Returns or sets the value of row spacing between columns |
SelectGridArea | Returns or sets the selected grid area of column grid |
Tag | Returns the Tag for this object. |
UseSpacingToggle | Returns or sets the status for using column row spacing of column grid |
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 | This enum is providing possible column base types |
ColumnGridEquipmentBuilderColumnType Enumeration | This enum is providing possible column types |
Property Detail¶
BubbleDiameter¶
-
ColumnGridEquipmentBuilder.
BubbleDiameter
¶ Returns or sets the value of bubble diameter in column grid
-------------------------------------
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
Parameters: bubbleDiameter (float) – New in version NX9.0.0.
License requirements: ld_line_designer (“FULL LINE DESIGNER”)
BubbleExtension¶
-
ColumnGridEquipmentBuilder.
BubbleExtension
¶ Returns or sets the value of bubble extension of column grid
-------------------------------------
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
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 value of column grid
-------------------------------------
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
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
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 characters in column grid
-------------------------------------
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
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 of column grid
-------------------------------------
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 of column grid
-------------------------------------
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 of column grid
-------------------------------------
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 of column grid
-------------------------------------
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 of column grid
-------------------------------------
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 of column grid
-------------------------------------
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
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 of column grid
-------------------------------------
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 of column grid
-------------------------------------
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 of columns of column grid
-------------------------------------
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 of column grid
-------------------------------------
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 of column grid
-------------------------------------
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 status of column display ids in column grid
-------------------------------------
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
Parameters: columnDisplayIDs (bool) – New in version NX9.0.0.
License requirements: ld_line_designer (“FULL LINE DESIGNER”)
ColumnElevation¶
-
ColumnGridEquipmentBuilder.
ColumnElevation
¶ Returns the column elevation of column grid
-------------------------------------
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 of columns of column grid
-------------------------------------
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 status of 90 degree column rotation for column grid
-------------------------------------
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
Parameters: columnRotate90Degrees (bool) – New in version NX9.0.0.
License requirements: ld_line_designer (“FULL LINE DESIGNER”)
ColumnSpacingDouble¶
-
ColumnGridEquipmentBuilder.
ColumnSpacingDouble
¶ Returns or sets the spacing between columns
-------------------------------------
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
Parameters: columnSpacingDouble (float) – New in version NX9.0.0.
License requirements: ld_line_designer (“FULL LINE DESIGNER”)
ColumnThickness¶
-
ColumnGridEquipmentBuilder.
ColumnThickness
¶ Returns the column thickness of coulmn grid
-------------------------------------
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 of column grid
-------------------------------------
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
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 number of column of columns in column grid
-------------------------------------
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
Parameters: columnWideNumber (int) – New in version NX9.0.0.
License requirements: ld_line_designer (“FULL LINE DESIGNER”)
ColumnWidth¶
-
ColumnGridEquipmentBuilder.
ColumnWidth
¶ Returns the column width of column grid
-------------------------------------
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 status to create bottom bubbles of column grid
-------------------------------------
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
Parameters: createBottomBubblesToggle (bool) – New in version NX9.0.0.
License requirements: ld_line_designer (“FULL LINE DESIGNER”)
CreateLeftBubblesToggle¶
-
ColumnGridEquipmentBuilder.
CreateLeftBubblesToggle
¶ Returns or sets the status to create left bubbles of column grid
-------------------------------------
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
Parameters: createLeftBubblesToggle (bool) – New in version NX9.0.0.
License requirements: ld_line_designer (“FULL LINE DESIGNER”)
CreateRightBubblesToggle¶
-
ColumnGridEquipmentBuilder.
CreateRightBubblesToggle
¶ Returns or sets the status to create right bubbles of column grid
-------------------------------------
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
Parameters: createRightBubblesToggle (bool) – New in version NX9.0.0.
License requirements: ld_line_designer (“FULL LINE DESIGNER”)
CreateTopBubblesToggle¶
-
ColumnGridEquipmentBuilder.
CreateTopBubblesToggle
¶ Returns or sets the status to create top bubbles in column grid
-------------------------------------
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
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 of column grid
-------------------------------------
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
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 status of column grid
-------------------------------------
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
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 number of rows of columns in column grid
-------------------------------------
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
Parameters: rowDeepNumber (int) – New in version NX9.0.0.
License requirements: ld_line_designer (“FULL LINE DESIGNER”)
RowSpacingDouble¶
-
ColumnGridEquipmentBuilder.
RowSpacingDouble
¶ Returns or sets the value of row spacing between columns
-------------------------------------
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
Parameters: rowSpacingDouble (float) – New in version NX9.0.0.
License requirements: ld_line_designer (“FULL LINE DESIGNER”)
SelectGridArea¶
-
ColumnGridEquipmentBuilder.
SelectGridArea
¶ Returns or sets the selected grid area of column grid
-------------------------------------
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
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 status for using column row spacing of column grid
-------------------------------------
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
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.