GeneralScalarTable Class — NXOpen Python API Reference 12.0.0 documentation

# GeneralScalarTable Class

class `NXOpen.``GeneralScalarTable`

  Bases: `NXOpen.TransientObject`

  Represents a General M x N table of scalar (real) values.

  This is an abstract class

  New in version NX6.0.0.

# Properties

Property | Description
--- | ---
NumCols | Returns the numuber of columns
NumRows | Returns the number of rows

# Methods

Method | Description
--- | ---
Dispose | Destroys the object
GetCellValue | Returns the cell value
GetNthColumn | Returns the entire Nth column of values.
GetNthColumnUnits | Returns the entire Nth column of values.
GetNthRow | Returns the entire Nth row of values.
SetCellNoValue | Sets cell as having no value
SetCellValue | Sets cell value
SetNthColumn | Sets the entire Nth column of values.
SetNthColumnUnits | Sets the entire Nth column of values.
SetNthRow | Sets the entire Nth row of values.
SetNumberOfRows | Sets the number of rows
SetTableSize | Sets the table size

# Property Detail

## NumCols

`GeneralScalarTable.``NumCols`

  Returns the numuber of columns

  `-------------------------------------`

  Getter Method

  Signature `NumCols`

  Returns: | Number of Columns
  Return type: | int

  New in version NX6.0.0.

  License requirements: None.

## NumRows

`GeneralScalarTable.``NumRows`

  Returns the number of rows

  `-------------------------------------`

  Getter Method

  Signature `NumRows`

  Returns: | Number of Rows
  Return type: | int

  New in version NX6.0.0.

  License requirements: None.

# Method Detail

## Dispose

`GeneralScalarTable.``Dispose`

  Destroys the object

  Signature `Dispose()`

  New in version NX6.0.0.

  License requirements: None.

## GetCellValue

`GeneralScalarTable.``GetCellValue`

  Returns the cell value

  Signature `GetCellValue(iRow, iCol)`

  Parameters:

  - iRow (int) – Row Index
  - iCol (int) – Column Index

  Returns: |
  Return type: | float

  New in version NX6.0.0.

  License requirements: None.

## GetNthColumn

`GeneralScalarTable.``GetNthColumn`

  Returns the entire Nth column of values.

  Output array will be as long as the number of rows `GeneralScalarTable.NumRows()`

  Signature `GetNthColumn(iCol)`

  Parameters: | iCol (int) – Column Index
  Returns: | Column Values
  Return type: | list of float

  New in version NX6.0.0.

  License requirements: None.

## GetNthColumnUnits

`GeneralScalarTable.``GetNthColumnUnits`

  Returns the entire Nth column of values.

  Output array will be as long as the number of rows `GeneralScalarTable.NumRows()`

  Signature `GetNthColumnUnits(iCol)`

  Parameters: | iCol (int) – Column Index
  Returns: | Unit type for the column None if the Column has no units
  Return type: | `NXOpen.Unit`

  New in version NX6.0.0.

  License requirements: None.

## GetNthRow

`GeneralScalarTable.``GetNthRow`

  Returns the entire Nth row of values.

  Output array will be as long as the number of columns `GeneralScalarTable.NumCols()`

  Signature `GetNthRow(iRow)`

  Parameters: | iRow (int) – Row Index
  Returns: | Row Values
  Return type: | list of float

  New in version NX6.0.0.

  License requirements: None.

## SetCellNoValue

`GeneralScalarTable.``SetCellNoValue`

  Sets cell as having no value

  Signature `SetCellNoValue(iRow, iCol)`

  Parameters:

  - iRow (int) – Row Index
  - iCol (int) – Column Index

  New in version NX11.0.0.

  License requirements: None.

## SetCellValue

`GeneralScalarTable.``SetCellValue`

  Overloaded method SetCellValue

  - `SetCellValue(iRow, iCol, cellValue)`
  - `SetCellValue(iRow, iCol, cellValue)`

  `-------------------------------------`

  Sets cell value

  Signature `SetCellValue(iRow, iCol, cellValue)`

  Parameters:

  - iRow (int) – Row Index
  - iCol (int) – Column Index
  - cellValue (float) – Value to store in the cell

  New in version NX6.0.0.

  License requirements: None.

  `-------------------------------------`

  Sets cell value

  Signature `SetCellValue(iRow, iCol, cellValue)`

  Parameters:

  - iRow (int) – Row Index
  - iCol (int) – Column Index
  - cellValue (int) – Value to store in the cell

  New in version NX10.0.0.

  License requirements: None.

  `-------------------------------------`

## SetNthColumn

`GeneralScalarTable.``SetNthColumn`

  Sets the entire Nth column of values.

  Input array must be as long as the number of rows `GeneralScalarTable.NumRows()`

  Signature `SetNthColumn(iCol, columnValues)`

  Parameters:

  - iCol (int) – Column Index
  - columnValues (list of float) – Column values

  New in version NX6.0.0.

  License requirements: None.

## SetNthColumnUnits

`GeneralScalarTable.``SetNthColumnUnits`

  Sets the entire Nth column of values.

  Input array must be as long as the number of rows `GeneralScalarTable.NumRows()`

  Signature `SetNthColumnUnits(iCol, unitType)`

  Parameters:

  - iCol (int) – Column Index
  - unitType (`NXOpen.Unit`) – Unit type for the column

  New in version NX6.0.0.

  License requirements: None.

## SetNthRow

`GeneralScalarTable.``SetNthRow`

  Sets the entire Nth row of values.

  Input array must be as long as the number of columns `GeneralScalarTable.NumCols()`

  Signature `SetNthRow(iRow, rowValues)`

  Parameters:

  - iRow (int) – Row Index
  - rowValues (list of float) – Row Values

  New in version NX6.0.0.

  License requirements: None.

## SetNumberOfRows

`GeneralScalarTable.``SetNumberOfRows`

  Sets the number of rows

  Signature `SetNumberOfRows(nRows, dDefaultValue)`

  Parameters:

  - nRows (int) – Number of Rows
  - dDefaultValue (float) – Default Value

  New in version NX10.0.0.

  License requirements: None.

## SetTableSize

`GeneralScalarTable.``SetTableSize`

  Sets the table size

  Signature `SetTableSize(nRows, nCols, dDefaultValue)`

  Parameters:

  - nRows (int) – Number of Rows
  - nCols (int) – Number of Columns
  - dDefaultValue (float) – Default Value

  New in version NX6.0.0.

  License requirements: None.