{
  "name": "FileAccess",
  "main": {
    "name": "FileAccess",
    "namespace": "sofa::helper::io",
    "module": "Sofa.framework.Helper",
    "include": "sofa/helper/io/FileAccess.h",
    "doc": "",
    "inherits": [
      "BaseFileAccess"
    ],
    "templates": [],
    "data_fields": [],
    "links": [],
    "methods": [
      {
        "name": "open",
        "return_type": "bool",
        "params": [
          {
            "name": "filename",
            "type": "const int &"
          },
          {
            "name": "openMode",
            "type": "int"
          }
        ],
        "is_virtual": true,
        "is_pure_virtual": false,
        "is_static": false,
        "access": "public"
      },
      {
        "name": "close",
        "return_type": "void",
        "params": [],
        "is_virtual": true,
        "is_pure_virtual": false,
        "is_static": false,
        "access": "public"
      },
      {
        "name": "streambuf",
        "return_type": "int *",
        "params": [],
        "is_virtual": false,
        "is_pure_virtual": false,
        "is_static": false,
        "access": "public"
      },
      {
        "name": "readAll",
        "return_type": "int",
        "params": [],
        "is_virtual": false,
        "is_pure_virtual": false,
        "is_static": false,
        "access": "public"
      },
      {
        "name": "write",
        "return_type": "void",
        "params": [
          {
            "name": "data",
            "type": "const int &"
          }
        ],
        "is_virtual": true,
        "is_pure_virtual": false,
        "is_static": false,
        "access": "public"
      }
    ]
  },
  "desc": {
    "description": "The `FileAccess` class in the `sofa::helper::io` namespace is part of the Sofa framework and provides functionality for reading from and writing to files. It inherits from `BaseFileAccess`. The primary methods include opening a file (`open`), closing it (`close`), accessing its stream buffer (`streambuf`), reading all data (`readAll`), and writing data (`write`). This component enables file I/O operations within the SOFA ecosystem, facilitating the management of input/output data in simulations. It interacts with other components by providing essential file access functionalities that can be utilized for loading simulation parameters or saving results."
  },
  "maths": {
    "maths": "The `FileAccess` class in the `sofa::helper::io` namespace is primarily designed for file input/output operations. It provides essential functionalities such as opening, closing, reading from, and writing to files. However, it does not directly contribute to any mathematical or physical aspects of the FEM (Finite Element Method) pipeline within SOFA. The methods provided by `FileAccess` are mainly utility functions that enable other components in the SOFA framework to manage data input and output efficiently.\n\n- **Role in the Global FEM Pipeline**: \n  - **Assembly**: Not directly involved.\n  - **Time Integration**: Not directly involved.\n  - **Nonlinear Solve**: Not directly involved.\n  - **Linear Solve**: Not directly involved.\n  - **Constraint Handling**: Not directly involved.\n  - **Mapping**: Not directly involved.\n- **Numerical Methods or Discretization Choices**: None. This component is purely for I/O operations and does not encode any specific numerical methods or discretization choices.\n- **Variational / Lagrangian Mechanics Framework**: The `FileAccess` class does not contribute to the variational or Lagrangian mechanics framework; it serves as a utility class for file management.\n\nIn summary, `FileAccess` is a utility component that facilitates file operations and does not have any direct mathematical or physical content related to FEM simulations."
  },
  "summary": {
    "abstract": "The `FileAccess` component provides file input/output operations within the SOFA framework, enabling reading from and writing to files for data management in simulations.",
    "sheet": "\n# FileAccess\n\n**Overview**\nThe `FileAccess` component is a utility class in the `sofa::helper::io` namespace that facilitates file I/O operations. It inherits from `BaseFileAccess` and provides methods such as `open`, `close`, `streambuf`, `readAll`, and `write`. This component enables other components within the SOFA framework to manage input/output data efficiently, supporting tasks like loading simulation parameters or saving results.\n"
  }
}