src.dackar.utils.mbse.customMBSEparser
======================================

.. py:module:: src.dackar.utils.mbse.customMBSEparser

.. autoapi-nested-parse::

   Created on February, 2024

   @author: mandd



Attributes
----------

.. autoapisummary::

   src.dackar.utils.mbse.customMBSEparser.logger
   src.dackar.utils.mbse.customMBSEparser.c_handler


Classes
-------

.. autoapisummary::

   src.dackar.utils.mbse.customMBSEparser.customMBSEobject


Module Contents
---------------

.. py:data:: logger

.. py:data:: c_handler

.. py:class:: customMBSEobject(nodesFilename, edgesFilename)

   Bases: :py:obj:`object`


   Class designed to process the a custom MBSE model from file.


   .. py:attribute:: nodesFilename


   .. py:attribute:: edgesFilename


   .. py:attribute:: listIDs
      :value: []



   .. py:attribute:: allowedNodeTypes
      :value: ['entity']



   .. py:attribute:: allowedEdgeTypes
      :value: ['link', 'composition', 'support']



   .. py:attribute:: allowedNodeCols
      :value: ['label', 'ID', 'type']



   .. py:attribute:: allowed_edge_cols
      :value: ['sourceNodeId', 'targetNodeId', 'type', 'medium']



   .. py:method:: checkModel()

      Method designed to pcheck model consistency

      :param None:

      :returns: None



   .. py:method:: parseFiles()

      Method designed to parse the node and edge files

      :param None:

      :returns: None



   .. py:method:: checkNodes()

      Method designed to check the node file

      :param None:

      :returns: None



   .. py:method:: checkEdges()

      Methods designed to check the edge file

      :param None:

      :returns: None



   .. py:method:: returnIDs()

      Method designed to return list of IDs included in the model

      :param None:

      :returns: self.listIDs, list, list of IDs specified in the MBSE model



   .. py:method:: addNodesEdges(new_node_dict, new_edge_dicts)

      Method designed to return list of IDs included in the model

      :param None:

      :returns: self.listIDs, list, list of IDs specified in the MBSE model



   .. py:method:: printOnFiles(nodes_file, edges_file)

      Method designed to print on file the set of nodes and edges

      :param None:

      :returns: self.listIDs, list, list of IDs specified in the MBSE model