Methods

{
  "name": "SceneCheckDeprecatedComponents",
  "namespace": "sofa::_scenechecking_",
  "module": "applications.projects.SceneChecking",
  "include": "SceneChecking/SceneCheckDeprecatedComponents.h",
  "doc": "",
  "inherits": [
    "SceneCheck"
  ],
  "templates": [],
  "data_fields": [],
  "links": [],
  "methods": [
    {
      "name": "newSPtr",
      "return_type": "int",
      "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": "doPrintSummary",
      "return_type": "void",
      "params": [],
      "is_virtual": true,
      "is_pure_virtual": false,
      "is_static": false,
      "access": "public"
    }
  ],
  "description": "The `SceneCheckDeprecatedComponents` is a utility component in the SOFA ecosystem, specifically within the `sofa::_scenechecking_` namespace and part of the `applications.projects.SceneChecking` module. This component inherits from `sofa::simulation::SceneCheck`, indicating its role in performing checks on the simulation scene.\n\nIts primary purpose is to identify and report deprecated components within a SOFA scenegraph, helping users maintain up-to-date simulations by highlighting obsolete elements that might need replacement or updating.\n\nThe component interacts with other SOFA components through its methods:\n- `doInit`: Initializes the check process for a given node in the simulation scene.\n- `doCheckOn`: Executes the actual check on the specified node, iterating over all objects within it to detect deprecated components.\n- `doPrintSummary`: Provides a summary of the findings but is currently empty and does not generate any output.\n\nThe component uses the `sofa::helper::ComponentChange` namespace to access information about deprecated components. It checks each object in the specified node to see if its class name appears in the list of deprecated components and logs messages for such objects using SOFA's logging mechanism (`msg_deprecated`).\n\nUsers can integrate this component into their scenes to ensure that their simulations do not contain any deprecated elements, facilitating better maintenance and future compatibility.",
  "maths": "The `SceneCheckDeprecatedComponents` is a utility component in the SOFA framework designed to identify deprecated components within a simulation scene. It does not directly contribute to any governing equations or operators such as mass matrix \\(M\\), stiffness matrix \\(K\\), internal force \\(f_{int}\\), residual \\(R\\), etc., which are typical of FEM simulations. Instead, it serves a role in maintaining the integrity and up-to-date status of SOFA simulation scenes by identifying and logging any deprecated components found within the scene graph.\n\n### Governing Equations or Operators Involved:\n- **None**: The `SceneCheckDeprecatedComponents` does not implement or contribute to any governing equations or operators relevant to FEM simulations. Its role is purely in checking for deprecated components, which does not involve numerical simulation or physics modeling.\n\n### Constitutive or Kinematic Laws Involved:\n- **None**: There are no constitutive or kinematic laws involved as the component's primary function is to check for deprecated components within a scene graph and report them. It does not model any physical behavior of deformable bodies or simulate mechanical interactions.\n\n### Role in the Global FEM Pipeline:\n- **Scene Graph Integrity Check**: The `SceneCheckDeprecatedComponents` operates outside the core FEM simulation pipeline but is crucial for maintaining the integrity and up-to-date status of a SOFA scene. It ensures that any deprecated components are identified, helping users to maintain compatibility with newer versions of the framework.\n\n### Numerical Methods or Discretization Choices Encoded:\n- **None**: The component does not employ any numerical methods or discretization choices as it is not involved in simulation or solving equations. Instead, it relies on SOFA's logging mechanism (`msg_deprecated`) to report deprecated components found within the scene graph.\n\n### Integration into Variational / Lagrangian Mechanics Framework:\n- **None**: The `SceneCheckDeprecatedComponents` does not integrate into the variational or Lagrangian mechanics framework. Its role is purely in identifying and reporting deprecated components, which helps maintain the overall health of SOFA simulations but does not contribute to any physical modeling or simulation processes.\n\n### Summary:\nThe component `SceneCheckDeprecatedComponents` plays a supportive role in maintaining up-to-date and functional SOFA scenes by checking for and logging any deprecated components found within the scene graph. It ensures that users are aware of any outdated elements that may need updating, thereby facilitating better maintenance and future compatibility of simulations.",
  "abstract": "The `SceneCheckDeprecatedComponents` identifies and reports deprecated components in a SOFA scenegraph to maintain up-to-date simulations.",
  "sheet": "<h1>SceneCheckDeprecatedComponents</h1>\n\n<h2>Overview</h2>\n<p>The <code>SceneCheckDeprecatedComponents</code> is a utility component that inherits from <code>sofa::simulation::SceneCheck</code>. Its primary role is to identify and report deprecated components within the SOFA scenegraph, ensuring simulations remain up-to-date by highlighting obsolete elements.</p>\n\n<h2>Practical Notes</h2>\n<p>The component does not generate any output through its <code>doPrintSummary</code> method. Users should integrate this component into their scenes to ensure that no deprecated components are present, facilitating better maintenance and future compatibility of simulations.</p>"
}