{
  "name": "BaseFileAccess",
  "main": {
    "name": "BaseFileAccess",
    "namespace": "sofa::helper::io",
    "module": "Sofa.framework.Helper",
    "include": "sofa/helper/io/BaseFileAccess.h",
    "doc": "",
    "inherits": [],
    "templates": [],
    "data_fields": [],
    "links": [],
    "methods": [
      {
        "name": "SetDefaultCreator",
        "return_type": "void",
        "params": [],
        "is_virtual": false,
        "is_pure_virtual": false,
        "is_static": true,
        "access": "public"
      },
      {
        "name": "SetCreator",
        "return_type": "void",
        "params": [
          {
            "name": "baseFileAccessCreator",
            "type": "BaseFileAccessCreator *"
          }
        ],
        "is_virtual": false,
        "is_pure_virtual": false,
        "is_static": true,
        "access": "public"
      },
      {
        "name": "SetCreator",
        "return_type": "void",
        "params": [],
        "is_virtual": false,
        "is_pure_virtual": false,
        "is_static": true,
        "access": "public"
      },
      {
        "name": "Create",
        "return_type": "BaseFileAccess *",
        "params": [],
        "is_virtual": false,
        "is_pure_virtual": false,
        "is_static": true,
        "access": "public"
      },
      {
        "name": "open",
        "return_type": "bool",
        "params": [
          {
            "name": "filename",
            "type": "const int &"
          },
          {
            "name": "openMode",
            "type": "int"
          }
        ],
        "is_virtual": true,
        "is_pure_virtual": true,
        "is_static": false,
        "access": "public"
      },
      {
        "name": "close",
        "return_type": "void",
        "params": [],
        "is_virtual": true,
        "is_pure_virtual": true,
        "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": true,
        "is_static": false,
        "access": "public"
      }
    ]
  },
  "desc": {
    "description": "The `BaseFileAccess` class in the SOFA framework is designed to provide a unified interface for file access operations within Sofa simulations. This abstraction allows different methods or implementations of file handling to be used transparently based on the needs of the end-user application. It supports setting default creators and custom creators, which define how file accesses are created. Methods include opening and closing files, accessing stream buffers, reading all contents from a file, and writing data to a file. These functionalities help ensure that file operations can be performed consistently across different parts of Sofa applications."
  },
  "maths": {
    "maths": "The `BaseFileAccess` class in the SOFA framework is primarily an abstract base class designed to provide a unified interface for file access operations. It does not directly involve mathematical or physical concepts related to simulations, but rather serves as a foundational utility for managing file interactions within the software environment. Here are some key points about its functionality and role:\n\n1. **Unified Interface**: The `BaseFileAccess` class provides a consistent way of handling files across different parts of the Sofa simulation framework. This abstraction ensures that any changes in file access methods can be made transparently without affecting other components.\n\n2. **Creators and Factories**:\n   - **SetDefaultCreator()**: Sets a default factory for creating instances of `BaseFileAccess`.\n   - **SetCreator(BaseFileAccessCreator*)**: Allows setting a custom factory to create specific implementations of `BaseFileAccess`, which can be useful for different file access strategies or formats.\n\n3. **Abstract Methods**:\n   - The class defines several pure virtual methods that any derived concrete implementation must provide, ensuring the consistency of file handling operations:\n     - `open(const std::string& filename, std::ios_base::openmode openMode)`: Opens a file with specified mode.\n     - `close()`: Closes an open file.\n     - `streambuf() const`: Returns a stream buffer for the file.\n     - `readAll()`: Reads all contents of the file into memory as a string.\n     - `write(const std::string& data)`: Writes data to the file.\n\n4. **Utility Methods**:\n   - **Create()**: Static method that returns an instance of `BaseFileAccess` created by the factory set using `SetCreator()` or `SetDefaultCreator()`.\n\n5. **Static Factory Management**:\n   - The class manages a static pointer to a creator object (`OurCreator`) which is responsible for creating instances of derived classes implementing the abstract interface.\n\nIn summary, while `BaseFileAccess` does not directly contribute mathematical or physical concepts, it plays a critical role in ensuring that file operations are consistent and can be customized according to specific needs within Sofa simulations."
  },
  "summary": {
    "abstract": "`BaseFileAccess` provides a unified interface for file access operations in SOFA simulations, supporting opening, closing, reading, and writing files through abstract methods.",
    "sheet": "# BaseFileAccess\n\n## Overview\n\nThe `BaseFileAccess` class is an abstract base class designed to provide a consistent interface for file access operations within the SOFA framework. It supports setting default creators and custom creators to define how instances of `BaseFileAccess` are created, ensuring that file handling can be customized according to specific needs.\n\n## Parameters and Data\n\nThe `BaseFileAccess` class does not expose any significant data fields or parameters directly related to its functionality.\n\n## Dependencies and Connections\n\nThis component is typically used by other parts of the SOFA framework for managing file interactions. It requires derived classes that implement the pure virtual methods defined in this abstract base class, such as `open`, `close`, `readAll`, and `write`.\n\n## Practical Notes\n\nThe primary practical consideration when using `BaseFileAccess` is ensuring that a concrete implementation of its interface is provided through a custom creator. This allows for consistent file handling across different parts of Sofa applications."
  }
}