Methods

{
  "name": "SceneCheckMissingRequiredPlugin",
  "namespace": "sofa::_scenechecking_",
  "module": "applications.projects.SceneChecking",
  "include": "SceneChecking/SceneCheckMissingRequiredPlugin.h",
  "doc": "",
  "inherits": [
    "SceneCheck"
  ],
  "templates": [],
  "data_fields": [],
  "links": [],
  "methods": [
    {
      "name": "newSPtr",
      "return_type": "SPtr",
      "params": [],
      "is_virtual": false,
      "is_pure_virtual": false,
      "is_static": true,
      "access": "public"
    },
    {
      "name": "getName",
      "return_type": "const int",
      "params": [],
      "is_virtual": false,
      "is_pure_virtual": false,
      "is_static": false,
      "access": "public"
    },
    {
      "name": "getDesc",
      "return_type": "const int",
      "params": [],
      "is_virtual": false,
      "is_pure_virtual": false,
      "is_static": false,
      "access": "public"
    },
    {
      "name": "doInit",
      "return_type": "void",
      "params": [
        {
          "name": "node",
          "type": "sofa::simulation::Node *"
        }
      ],
      "is_virtual": true,
      "is_pure_virtual": false,
      "is_static": false,
      "access": "public"
    },
    {
      "name": "doCheckOn",
      "return_type": "void",
      "params": [
        {
          "name": "node",
          "type": "sofa::simulation::Node *"
        }
      ],
      "is_virtual": true,
      "is_pure_virtual": false,
      "is_static": false,
      "access": "public"
    },
    {
      "name": "printSummary",
      "return_type": "void",
      "params": [
        {
          "name": "sceneLoader",
          "type": "simulation::SceneLoader *"
        }
      ],
      "is_virtual": true,
      "is_pure_virtual": false,
      "is_static": false,
      "access": "public"
    }
  ],
  "description": "The `SceneCheckMissingRequiredPlugin` is a scene-checking tool in the SOFA framework, specifically designed to ensure that all required plugins for components used in a simulation scene are correctly imported. It inherits from `sofa::simulation::SceneCheck`, indicating its role as part of the scene validation system. This component operates by examining each node and object within the scene to identify which plugins are being utilized but not explicitly listed with `<RequiredPlugin>` directives.\n\nThe interactions include:\n- **doInit**: Initializes the plugin state, collecting information about already loaded plugins from `<RequiredPlugin>` nodes in the scene.\n- **doCheckOn**: Inspects each node and its components to determine which plugins are necessary for those components but missing required declarations.\n- **printSummary**: Provides a summary of any issues found, suggesting where `<RequiredPlugin>` directives should be added to ensure the scene is self-contained and compatible with different SOFA environments.\n\nPractical usage involves adding this component to a SOFA simulation scene. It will automatically check for missing plugin requirements during initialization and report any discrepancies. The `doCheckOn` method examines each node, while `printSummary` provides a warning message suggesting the necessary additions to make the scene fully compatible.",
  "maths": "The `SceneCheckMissingRequiredPlugin` component in the SOFA framework does not directly implement any mathematical or physical equations related to the Finite Element Method (FEM) or variational mechanics. Instead, it serves as a utility tool for ensuring that all required plugins are correctly imported into a simulation scene. This is essential for maintaining the integrity and reproducibility of simulations across different environments.\n\n### Role in Global FEM Pipeline\n\nThis component does not contribute to any governing equations (e.g., mass matrix $M$, stiffness matrix $K$, internal force $f_{int}$, residual $R$) or constitutive laws. Instead, it operates at a higher level of the simulation framework by checking for missing plugin dependencies.\n\n### Key Operations\n\n1. **Initialization (`doInit`)**: Collects information about already loaded plugins from `<RequiredPlugin>` nodes in the scene. This helps to establish a baseline of what is currently available and needed.\n\n2. **Scene Checking (`doCheckOn`)**: Iterates through each node and its components, identifying which plugins are necessary but not explicitly listed with `<RequiredPlugin>` directives. It builds a map of required plugins for various components used in the scene.\n\n3. **Summary Reporting (`printSummary`)**: Provides a summary of any issues found, suggesting where `<RequiredPlugin>` directives should be added to ensure that the scene is self-contained and compatible with different SOFA environments.\n\n### Numerical Methods or Discretization Choices\n\nThis component does not involve any numerical methods or discretization choices specific to FEM. Its role is purely in ensuring that the necessary dependencies are accounted for, which indirectly supports robust simulation execution by preventing errors due to missing plugins.\n\n### Variational / Lagrangian Mechanics Framework Fit\n\nThe `SceneCheckMissingRequiredPlugin` does not fit into the variational or Lagrangian mechanics framework directly. However, it ensures that all required components (which might have their own mathematical descriptions) are available and correctly specified in the scene, thus supporting a rigorous and consistent simulation environment.\n\n### Conclusion\n\nIn summary, the `SceneCheckMissingRequiredPlugin` is not involved in any FEM-specific calculations but plays a crucial role in ensuring that simulations are complete and reproducible. It acts as a validator for plugin dependencies within the SOFA framework.",
  "abstract": "The `SceneCheckMissingRequiredPlugin` ensures that all required plugins are correctly imported into a SOFA simulation scene, preventing errors due to missing dependencies.",
  "sheet": "\n# SceneCheckMissingRequiredPlugin\n\n## Overview\n\nThe `SceneCheckMissingRequiredPlugin` is a utility component in the SOFA framework designed to ensure that all required plugins for components used in a simulation scene are correctly imported. It inherits from `sofa::simulation::SceneCheck`, indicating its role as part of the scene validation system.\n\n## Practical Notes\n\nThis component operates by examining each node and object within the scene to identify which plugins are being utilized but not explicitly listed with `<RequiredPlugin>` directives. The `doInit` method initializes the plugin state, collecting information about already loaded plugins from `<RequiredPlugin>` nodes in the scene. The `doCheckOn` method inspects each node and its components to determine which plugins are necessary for those components but missing required declarations. Finally, the `printSummary` method provides a summary of any issues found, suggesting where `<RequiredPlugin>` directives should be added to ensure the scene is self-contained and compatible with different SOFA environments.\n"
}