{
  "name": "DataLink",
  "main": {
    "name": "DataLink",
    "namespace": "sofa::core::objectmodel",
    "module": "Sofa.framework.Core",
    "include": "sofa/core/objectmodel/DataLink.h",
    "doc": "DataLink stores a connection between two object of type Data<XXX>\nThe class is templated by the Data type to connect.\nThe class implements the AbstractDataLink interface.",
    "inherits": [
      "AbstractDataLink",
      "BaseData"
    ],
    "templates": [],
    "data_fields": [],
    "links": [],
    "methods": [
      {
        "name": "getTarget",
        "return_type": "T *",
        "params": [],
        "is_virtual": false,
        "is_pure_virtual": false,
        "is_static": false,
        "access": "public"
      },
      {
        "name": "unSet",
        "return_type": "void",
        "params": [],
        "is_virtual": false,
        "is_pure_virtual": false,
        "is_static": false,
        "access": "public"
      },
      {
        "name": "isSet",
        "return_type": "bool",
        "params": [],
        "is_virtual": false,
        "is_pure_virtual": false,
        "is_static": false,
        "access": "public"
      },
      {
        "name": "setTarget",
        "return_type": "void",
        "params": [
          {
            "name": "target",
            "type": "T *"
          }
        ],
        "is_virtual": false,
        "is_pure_virtual": false,
        "is_static": false,
        "access": "public"
      },
      {
        "name": "getOwner",
        "return_type": "T &",
        "params": [],
        "is_virtual": false,
        "is_pure_virtual": false,
        "is_static": false,
        "access": "public"
      }
    ]
  },
  "desc": {
    "description": "The `DataLink` class in the SOFA framework is responsible for establishing and managing connections between two objects of type `Data<XXX>`. It implements the `AbstractDataLink` interface, providing functionality to set and get the target object (`T*`) and its owner (`T&`). The class is templated by the Data type it connects. Key methods include `setTarget`, which establishes a connection to another Data object, `getTarget`, which retrieves the connected target object, `isSet`, which checks if a target has been set, and `unSet`, which clears any existing connections. It also provides `_doSetTarget_` and `_doGetTarget_` methods for internal use in casting between base data types and their specific instances.\n\n**Interactions with other components:**\nThe `DataLink` class interacts primarily with the `AbstractDataLink` interface, ensuring that it can be used within a larger framework of data management. It is designed to connect Data objects of any type, which are fundamental for representing simulation state in SOFA, enabling dynamic and flexible connections between different parts of a simulation.\n\n**Practical usage guidance:**\nThe `DataLink` class should be instantiated with an owner object (`T&`) and used to establish links to other data objects. The methods provided allow for easy setting and checking of these connections, which is crucial for maintaining consistency and interaction within complex simulations."
  },
  "maths": {
    "maths": "The `DataLink` class in the SOFA framework does not directly involve mathematical or physical computations. Instead, it serves a foundational role in establishing and managing connections between two objects of type `Data<XXX>`. This connection mechanism is essential for maintaining consistency and interaction within complex simulations but does not itself contain any mathematical content.\n\nKey functionalities include:\n- **Setting Targets**: The method `setTarget(T* target)` establishes a connection to another Data object, enabling dynamic interactions between different parts of the simulation.\n- **Retrieving Targets**: The method `getTarget()` retrieves the connected target object, allowing for querying and manipulation of linked data objects.\n- **Checking Connections**: The method `isSet()` checks whether a target has been set, ensuring that connections are properly managed.\n- **Clearing Connections**: The method `unSet()` clears any existing connections, facilitating the reconfiguration of simulation components as needed.\n\nThese functionalities ensure that the simulation state is consistently maintained and that interactions between different parts of the simulation can be dynamically established and modified. However, no direct mathematical or physical equations are involved in these operations."
  },
  "summary": {
    "abstract": "`DataLink` manages connections between two `Data<XXX>` objects in the SOFA framework, providing methods to set, retrieve, check, and clear these connections.",
    "sheet": "# DataLink\n\n## Overview\nThe `DataLink` class is responsible for establishing and managing connections between two objects of type `Data<XXX>`. It implements the `AbstractDataLink` interface and provides functionality to set and get the target object (`T*`) and its owner (`T&`). This component ensures dynamic and flexible interactions within complex simulations by maintaining consistency in the simulation state.\n\n## Dependencies and Connections\nThe `DataLink` class interacts primarily with the `AbstractDataLink` interface, ensuring that it can be used within a larger framework of data management. It is designed to connect Data objects of any type, which are fundamental for representing simulation state in SOFA."
  }
}