Methods

{
  "name": "SceneCheckUsingAlias",
  "namespace": "sofa::_scenechecking_",
  "module": "applications.projects.SceneChecking",
  "include": "SceneChecking/SceneCheckUsingAlias.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": "doPrintSummary",
      "return_type": "void",
      "params": [],
      "is_virtual": true,
      "is_pure_virtual": false,
      "is_static": false,
      "access": "public"
    }
  ],
  "description": "The `SceneCheckUsingAlias` is a component in the SOFA ecosystem designed to verify if components have been created using aliases, which can introduce confusion into simulations. It inherits from the `sofa::simulation::SceneCheck` class and provides specific methods for initialization (`doInit`), checking nodes (`doCheckOn`), and printing summaries (`doPrintSummary`). The component tracks instances where a component is instantiated with an alias different from its actual class name, storing this information in a map. During the `doPrintSummary` method execution, it outputs warnings about any components that were created using aliases to alert users of potential issues related to these aliases. The `newSPtr`, `getName`, and `getDesc` methods are utility functions for creating shared pointers, retrieving the component name, and obtaining a description respectively.",
  "maths": "The `SceneCheckUsingAlias` component is not directly involved in the mathematical or physical simulation aspects of FEM. Instead, it serves as a utility for ensuring that components are instantiated correctly within a SOFA scene. It does not contribute to any governing equations, constitutive laws, kinematic models, assembly processes, time integration schemes, nonlinear solve routines, linear solve procedures, constraint handling, or mappings in the context of FEM.\n\nThe primary role of `SceneCheckUsingAlias` is to monitor and report on instances where components are created using aliases that differ from their actual class names. This can help prevent confusion and ensure clarity in simulation setups. Specifically:\n\n- **Tracking Alias Usage**: It stores information about the creation of components with aliases different from their true class names in a map `m_componentsCreatedUsingAlias`.\n- **Initialization (`doInit`)**: The component is initialized by setting up a callback that tracks any instances where a component is created using an alias.\n- **Node Checking (`doCheckOn`)**: This method is invoked to check the components within a specified node, although its implementation currently does nothing (marked with `SOFA_UNUSED(node)`).\n- **Summary Printing (`doPrintSummary`)**: It prints warnings summarizing all instances where aliases were used during component creation. The warnings highlight potential confusion and provide information on the number of times each alias was used for a given class.\n\nIn summary, while `SceneCheckUsingAlias` plays an important role in maintaining clarity within SOFA simulations by monitoring alias usage, it does not participate in any mathematical or physical simulation processes.",
  "abstract": "The `SceneCheckUsingAlias` component monitors and reports on instances where SOFA components are instantiated with aliases differing from their true class names to prevent confusion in simulation setups.",
  "sheet": "# SceneCheckUsingAlias\n\n## Overview\nThe `SceneCheckUsingAlias` is a utility component that inherits from the `sofa::simulation::SceneCheck` class. It monitors and reports on instances where components are created using aliases different from their actual class names, which can help prevent confusion in simulation setups.\n\n## Parameters and Data\n- **m_componentsCreatedUsingAlias**: A map storing information about components instantiated with aliases differing from their true class names. This map is used to track alias usage and provide warnings during the `doPrintSummary` method execution."
}