.. include:: ../substitutions

.. oe:namespace:: OEChem

.. meta::
   :keywords: OEIsValid2DRingDictionary

.. oe:function:: OEIsValid2DRingDictionary

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEIsValid2DRingDictionary(oemolistream& ifs)
         bool OEIsValid2DRingDictionary(const std::string& filename)

   .. oe:language:: python

      .. oe:api:: python

         OEIsValid2DRingDictionary(ifs: oemolistream) -> bool
         OEIsValid2DRingDictionary(filename: str) -> bool

   Returns true is the given file is a valid 2D ring dictionary.

   .. seealso::

      * :ref:`OE2DRingDictionary <OEChem_OE2DRingDictionary>` class
      * :ref:`OEInit2DRingDictionary <OEChem_OEInit2DRingDictionary>` class

      2D ring dictionary files can be generated with the following programs:

      .. oe:language:: c++

         * Example program :ref:`createringdict.cpp<section_example_oechem_createringdict>`
         * Example program :ref:`appendringdict.cpp<section_example_oechem_appendringdict>`

      .. oe:language:: python

         * Example program :ref:`createringdict.py<section_example_oechem_createringdict>`
         * Example program :ref:`appendringdict.py<section_example_oechem_appendringdict>`

      .. oe:language:: java

         * Example program :ref:`CreateRingDict.java<section_example_oechem_createringdict>`
         * Example program :ref:`AppendRingDict.java<section_example_oechem_appendringdict>`


      .. oe:language:: csharp

         * Example program :ref:`CreateRingDict.cs<section_example_oechem_createringdict>`
         * Example program :ref:`AppendRingDict.cs<section_example_oechem_appendringdict>`
