Methods

{
  "name": "TableDataWidget",
  "namespace": "sofa::qt",
  "module": "sofa.qt.TableDataWidget.cpp",
  "include": "sofa/qt/TableDataWidget.h",
  "doc": "",
  "inherits": [
    "SimpleDataWidget"
  ],
  "templates": [],
  "data_fields": [],
  "links": [],
  "methods": [
    {
      "name": "sizeWidget",
      "return_type": "unsigned int",
      "params": [],
      "is_virtual": true,
      "is_pure_virtual": false,
      "is_static": false,
      "access": "public"
    },
    {
      "name": "numColumnWidget",
      "return_type": "unsigned int",
      "params": [],
      "is_virtual": true,
      "is_pure_virtual": false,
      "is_static": false,
      "access": "public"
    }
  ],
  "description": "The `TableDataWidget` is a widget within the SOFA framework, specifically in the Qt module (`sofa::qt`). This component extends the `SimpleDataWidget`, which suggests that it provides a more specialized interface for displaying tabular data within a graphical user interface. The main purpose of this widget is to visualize and manage data tables interactively.\n\nThe `TableDataWidget` has two public methods: `sizeWidget` and `numColumnWidget`. These methods are likely used to retrieve the size (number of rows) and number of columns in the table, respectively. By inheriting from `SimpleDataWidget`, it interacts with other SOFA components through a common interface that allows for integration within various GUI configurations.\n\nIn practical usage, this widget could be utilized to display simulation data, parameters, or any structured information in an organized tabular format. However, specific details about its configuration and exact interactions are not provided.",
  "maths": "The `TableDataWidget` is a graphical user interface (GUI) component within the SOFA framework, specifically in the Qt module (`sofa::qt`). This widget extends the functionality provided by its parent class `SimpleDataWidget`, which implies that it offers specialized features for displaying tabular data interactively.\n\nFrom a mathematical and physical perspective, the `TableDataWidget` does not directly contribute to any governing equations or operators in the finite element method (FEM) pipeline. It is primarily responsible for visualizing and managing structured datasets such as simulation results, parameters, or other numerical information in an organized tabular format.\n\nThe widget provides two public methods:\n- `sizeWidget` returns the size of the table (number of rows).\n- `numColumnWidget` returns the number of columns in the table.\n\nThese methods facilitate interaction with the underlying data structure, allowing users to retrieve information about the dimensions of the displayed tabular data. However, these operations are purely computational and do not involve any physical or mathematical models related to FEM simulation.\n\nIn summary, the `TableDataWidget` serves as a tool for visualizing and managing structured data in an organized manner within the SOFA framework's GUI environment. It does not contribute to the mathematical formulation or numerical methods of FEM simulations.",
  "abstract": "The `TableDataWidget` extends `SimpleDataWidget` to display tabular data interactively within the SOFA framework's Qt module.",
  "sheet": "\n# TableDataWidget\n\n## Overview\nThe `TableDataWidget` is a graphical user interface (GUI) component in the SOFA framework, specifically within the Qt module (`sofa::qt`). It extends the functionality of its parent class `SimpleDataWidget`, providing specialized features for displaying tabular data interactively. This widget facilitates the visualization and management of structured datasets such as simulation results or parameters.\n\n## Parameters and Data\nThe `TableDataWidget` does not expose any significant Data fields beyond those inherited from `SimpleDataWidget`. It provides two public methods:\n- `sizeWidget`: Returns the number of rows in the table.\n- `numColumnWidget`: Returns the number of columns in the table.\n"
}