.. include:: ../../toolkit-substitutions

.. oe:namespace:: OESpruce



.. _OESpruce_OESequenceMetadata:

.. oe:class:: OESequenceMetadata

   .. attention::

      |TWOLANGUAGE|

   .. oe:api::


      class OESequenceMetadata

   This class stores the sequence data used in biomolecule rebuilding in the :oe:func:`OESpruce::OEMakeDesignUnits` function.


   .. oe:method:: Constructors

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

         .. oe:api::

            OESequenceMetadata()
            OESequenceMetadata(const OESequenceMetadata &)

      .. oe:language:: python

         .. oe:api:: python

            OESequenceMetadata() -> OESequenceMetadata
            OESequenceMetadata(arg2: OESequenceMetadata) -> OESequenceMetadata

      Default and copy constructors.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OESequenceMetadata &operator=(const OESequenceMetadata &)

      Assignment operator.

   .. oe:method:: GetChainID

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

         .. oe:api::

            std::string GetChainID() const

      .. oe:language:: python

         .. oe:api:: python

            GetChainID() -> str

      Returns the string of the chain ID of the sequence.

   .. oe:method:: GetEndResidueInsertCode

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

         .. oe:api::

            char GetEndResidueInsertCode() const

      .. oe:language:: python

         .. oe:api:: python

            GetEndResidueInsertCode() -> str

      Returns a char representing the insertion code of the last residue.

   .. oe:method:: GetEndResidueNumber

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

         .. oe:api::

            int GetEndResidueNumber() const

      .. oe:language:: python

         .. oe:api:: python

            GetEndResidueNumber() -> int

      Returns the residue number.

   .. oe:method:: GetSequence

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

         .. oe:api::

            std::string GetSequence() const

      .. oe:language:: python

         .. oe:api:: python

            GetSequence() -> str

      Returns the string sequence.

   .. oe:method:: GetStartResidueInsertCode

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

         .. oe:api::

            char GetStartResidueInsertCode() const

      .. oe:language:: python

         .. oe:api:: python

            GetStartResidueInsertCode() -> str

      Returns a char representing the insertion code of the first residue.

   .. oe:method:: GetStartResidueNumber

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

         .. oe:api::

            int GetStartResidueNumber() const

      .. oe:language:: python

         .. oe:api:: python

            GetStartResidueNumber() -> int

      Returns the residue number (`int`) of the first residue.

   .. oe:method:: SetChainID

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

         .. oe:api::

            void SetChainID(const std::string& cid)

      .. oe:language:: python

         .. oe:api:: python

            SetChainID(cid: str) -> None

      Sets the string of the chain ID of the sequence.

   .. oe:method:: SetEndResidueInsertCode

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

         .. oe:api::

            void SetEndResidueInsertCode(const char endInsCode)

      .. oe:language:: python

         .. oe:api:: python

            SetEndResidueInsertCode(endInsCode: str) -> None

      Sets the char representing the insertion code of the last residue.

   .. oe:method:: SetEndResidueNumber

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

         .. oe:api::

            void SetEndResidueNumber(const int endResNum)

      .. oe:language:: python

         .. oe:api:: python

            SetEndResidueNumber(endResNum: int) -> None

      Sets the residue number (`int`) of the last residue.

   .. oe:method:: SetSequence

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

         .. oe:api::

            void SetSequence(const std::string& seq)

      .. oe:language:: python

         .. oe:api:: python

            SetSequence(seq: str) -> None

      Sets the string of the sequence. The format should be a three letter code per residue separated by spaces.

   .. oe:method:: SetStartResidueInsertCode

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

         .. oe:api::

            void SetStartResidueInsertCode(const char startInsCode)

      .. oe:language:: python

         .. oe:api:: python

            SetStartResidueInsertCode(startInsCode: str) -> None

      Sets the char representing the insertion code of the first residue.

   .. oe:method:: SetStartResidueNumber

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

         .. oe:api::

            void SetStartResidueNumber(const int startResNum)

      .. oe:language:: python

         .. oe:api:: python

            SetStartResidueNumber(startResNum: int) -> None

      Sets the residue number (`int`) of the first residue.
