Methods

{
  "name": "SceneCheckDuplicatedName",
  "namespace": "sofa::_scenechecking_",
  "module": "applications.projects.SceneChecking",
  "include": "SceneChecking/SceneCheckDuplicatedName.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 `SceneCheckDuplicatedName` class is part of the SOFA framework's SceneChecking module and inherits from `sofa::simulation::SceneCheck`. Its primary role is to ensure that there are no duplicate names within the SOFA scenegraph, which can lead to issues in certain operations. It checks for duplicate object and child node names within a specified node.\n\n### Role and Purpose\n- **Role**: To validate the uniqueness of names in the scenegraph nodes and their objects.\n- **Purpose**: Prevent potential crashes or unexpected behavior due to naming conflicts.\n\n### Interactions with Other Components\n- Inherits from `sofa::simulation::SceneCheck`, allowing it to integrate into SOFA's scene-checking mechanisms.\n- Uses `Node` objects to access the scenegraph and perform name checks.\n- Utilizes methods like `doInit`, `doCheckOn`, and `doPrintSummary` to initialize, check nodes for duplicates, and print warnings if needed.\n\n### Practical Usage Guidance\n- The component automatically registers itself via `SceneCheckMainRegistry::addToRegistry`.\n- It returns a descriptive name and description using the `getName()` and `getDesc()` methods.\n- During initialization (`doInit`), it resets its internal state to check for duplicates.\n- In `doCheckOn`, it scans all objects and child nodes of the given node, tracking names with a map. If any name appears more than once, it records these as duplicates.\n- The `doPrintSummary` method prints warnings if duplicate names are found, suggesting renaming them to avoid conflicts.\n\n### Data Fields\n- `m_hasDuplicates`: A boolean flag indicating whether duplicates were detected.\n- `m_duplicatedMsg`: A stringstream for accumulating messages about duplicated names.",
  "maths": "The `SceneCheckDuplicatedName` class is part of the SOFA framework's SceneChecking module, designed to ensure that there are no duplicate names within the SOFA scenegraph. This validation helps prevent potential crashes or unexpected behavior due to naming conflicts. The component primarily operates at a structural level, checking for duplicates among node and object names in the simulation graph rather than directly contributing to the governing equations or operators of FEM simulations such as mass matrix M, stiffness matrix K, internal force f_int, residual R, etc.\n\n### Role in the Global FEM Pipeline\n- **Validation**: The `SceneCheckDuplicatedName` component is not involved in the mathematical formulation or numerical discretization aspects of the Finite Element Method (FEM). Instead, it ensures that the simulation scene's structural integrity is maintained by verifying unique names for nodes and objects.\n- **Initialization and Check Operations**:\n  - **doInit**: This method initializes internal state variables to check for duplicates. It resets `m_hasDuplicates` to false and clears any existing messages in `m_duplicatedMsg`.\n  - **doCheckOn**: Scans all objects and child nodes within a specified node, tracking names with a map (`duplicated`). If any name appears more than once, it records these as duplicates. This method ensures that the scene's naming convention is consistent and avoids potential conflicts during simulation operations.\n- **Reporting**:\n  - **doPrintSummary**: Prints warnings if duplicate names are found. It suggests renaming nodes or objects to avoid naming conflicts that could lead to crashes or unexpected behavior in subsequent simulation steps.\n\n### Mathematical and Physical Content\nThe `SceneCheckDuplicatedName` component does not directly implement any mathematical operators, constitutive laws, kinematic relations, or numerical methods associated with the FEM pipeline. Its primary function is to validate the uniqueness of names within the SOFA scenegraph, ensuring that there are no conflicts that could affect simulation stability and correctness.\n\n### Numerical Methods and Discretization Choices\nSince `SceneCheckDuplicatedName` does not contribute to the numerical discretization or solution process, it does not encode any specific numerical methods or discretization choices. Instead, it focuses on structural validation at the level of the scene graph itself.\n\n### Fit into Variational / Lagrangian Mechanics Framework\nThe component operates outside of the variational and Lagrangian mechanics framework since its primary role is to ensure consistent naming within the scenegraph structure rather than participating in the formulation or solution of physical equations. Its function is more related to ensuring that the simulation environment setup does not contain errors that could compromise the integrity of subsequent FEM-based simulations.",
  "abstract": "The `SceneCheckDuplicatedName` component checks for duplicate object and node names within the SOFA scenegraph, ensuring consistent naming to prevent potential crashes or unexpected behavior.",
  "sheet": "# SceneCheckDuplicatedName\n\n## Overview\nThe `SceneCheckDuplicatedName` class is part of the SOFA framework's SceneChecking module. It inherits from `sofa::simulation::SceneCheck`, allowing it to integrate into SOFA's scene-checking mechanisms. Its primary role is to validate that there are no duplicate names within the scenegraph nodes and their objects, which can lead to issues in certain operations.\n\n## Practical Notes\n- The component automatically registers itself via `SceneCheckMainRegistry::addToRegistry`.\n- It returns a descriptive name and description using the `getName()` and `getDesc()` methods.\n- During initialization (`doInit`), it resets its internal state to check for duplicates.\n- In `doCheckOn`, it scans all objects and child nodes of the given node, tracking names with a map. If any name appears more than once, it records these as duplicates.\n- The `doPrintSummary` method prints warnings if duplicate names are found, suggesting renaming them to avoid conflicts."
}