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

.. oe:namespace:: OESpruce



.. _OESpruce_OEStructureMetadata:

.. oe:class:: OEStructureMetadata

   .. attention::

      |TWOLANGUAGE|

   .. oe:api::


      class OEStructureMetadata

   This class stores structural information used in design unit preparation within the :oe:func:`OESpruce::OEMakeDesignUnits` function.


   .. oe:method:: Constructors

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

         .. oe:api::

            OEStructureMetadata()
            OEStructureMetadata(const OEStructureMetadata &)
            OEStructureMetadata(const std::vector<OEHeterogenMetadata>& hetData)
            OEStructureMetadata(const std::vector<OEHeterogenMetadata>& hetData,
                                const std::vector<OESequenceMetadata>& seqData)

      .. oe:language:: python

         .. oe:api:: python

            OEStructureMetadata() -> OEStructureMetadata
            OEStructureMetadata(hetData: OEHeterogenMetadataVector) -> OEStructureMetadata
            OEStructureMetadata(hetData: OEHeterogenMetadataVector,
                                seqData: OESequenceMetadataVector) -> OEStructureMetadata
            OEStructureMetadata(arg2: OEStructureMetadata) -> OEStructureMetadata

      Default, copy, and advanced constructor that constructs an `OEStructureMetadata` object. The advanced constructor takes a combination of two separate data classes as arguments: a class that stores the structural metadata (:ref:`OEStructureMetadata <OESpruce_OEStructureMetadata>`), and a class that stores the heterogen metadata (:ref:`OEHeterogenMetadata <OESpruce_OEHeterogenMetadata>`). A separate overload that takes a `std::vector` of each of those data classes is also available.

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

      .. oe:api::

         OEStructureMetadata &operator=(const OEStructureMetadata &)

      Assignment operator.

   .. oe:method:: AddHeterogenMetadata

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

         .. oe:api::

            void AddHeterogenMetadata(const OEHeterogenMetadata& hetData)
            void AddHeterogenMetadata(const std::vector<OEHeterogenMetadata>& hetData)

      .. oe:language:: python

         .. oe:api:: python

            AddHeterogenMetadata(hetData: OEHeterogenMetadataVector) -> None
            AddHeterogenMetadata(hetData: OEHeterogenMetadata) -> None

      Adds the heterogen metadata (:ref:`OEHeterogenMetadata <OESpruce_OEHeterogenMetadata>`) as a single object or as a `std::vector` of objects.

   .. oe:method:: AddKeyword

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

         .. oe:api::

            void AddKeyword(const std::string& keyword)

      .. oe:language:: python

         .. oe:api:: python

            AddKeyword(keyword: str) -> None

      Adds a string keyword.

   .. oe:method:: AddKeywords

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

         .. oe:api::

            void AddKeywords(const std::vector<std::string>& keywords)

      .. oe:language:: python

         .. oe:api:: python

            AddKeywords(keywords: OEStringVector) -> None

      Adds a `std::vector` of string keywords.

   .. oe:method:: AddSequenceMetadata

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

         .. oe:api::

            void AddSequenceMetadata(const OESequenceMetadata& seqData)
            void AddSequenceMetadata(const std::vector<OESequenceMetadata>& seqData)

      .. oe:language:: python

         .. oe:api:: python

            AddSequenceMetadata(seqData: OESequenceMetadataVector) -> None
            AddSequenceMetadata(seqData: OESequenceMetadata) -> None

      Adds the sequence metadata (:ref:`OESequenceMetadata <OESpruce_OESequenceMetadata>`) as a single object or as a `std::vector` of objects.

   .. oe:method:: ClearHeterogenMetadata

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

         .. oe:api::

            void ClearHeterogenMetadata()

      .. oe:language:: python

         .. oe:api:: python

            ClearHeterogenMetadata() -> None

      Clears all heterogen metadata.

   .. oe:method:: ClearKeywords

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

         .. oe:api::

            void ClearKeywords()

      .. oe:language:: python

         .. oe:api:: python

            ClearKeywords() -> None

      Clears all keywords.

   .. oe:method:: ClearSequenceMetadata

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

         .. oe:api::

            void ClearSequenceMetadata()

      .. oe:language:: python

         .. oe:api:: python

            ClearSequenceMetadata() -> None

      Clears all sequence metadata.

   .. oe:method:: GetAuthor

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

         .. oe:api::

            std::string GetAuthor() const

      .. oe:language:: python

         .. oe:api:: python

            GetAuthor() -> str

      Returns the name of the author.

   .. oe:method:: GetExperimentDate

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

         .. oe:api::

            std::string GetExperimentDate() const

      .. oe:language:: python

         .. oe:api:: python

            GetExperimentDate() -> str

      Returns the string version of the experiment date.

   .. oe:method:: GetExperimentType

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

         .. oe:api::

            unsigned GetExperimentType() const

      .. oe:language:: python

         .. oe:api:: python

            GetExperimentType() -> int

      Returns the experiment type as defined by the :oe:constns:`OESpruce::OEExperimentType` namespace.

   .. oe:method:: GetHeterogenMetadata

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

         .. oe:api::

            std::vector<OEHeterogenMetadata>& GetHeterogenMetadata()
            const std::vector<OEHeterogenMetadata>& GetHeterogenMetadata() const

      .. oe:language:: python

         .. oe:api:: python

            GetHeterogenMetadata() -> OEHeterogenMetadataVector

      Returns a reference to the `std::vector` of stored heterogen metadata (:ref:`OEHeterogenMetadata <OESpruce_OEHeterogenMetadata>`) objects.

   .. oe:method:: GetIridiumData

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

         .. oe:api::

            OEBio::OEIridiumData& GetIridiumData()
            const OEBio::OEIridiumData& GetIridiumData() const

      .. oe:language:: python

         .. oe:api:: python

            GetIridiumData() -> OEIridiumData

      Returns a reference to the Iridium data (:ref:`OEIridiumData <OEBio_OEIridiumData>`) object.

   .. oe:method:: GetKeywords

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

         .. oe:api::

            std::vector<std::string>& GetKeywords()
            const std::vector<std::string>& GetKeywords() const

      .. oe:language:: python

         .. oe:api:: python

            GetKeywords() -> OEStringVector

      Returns a reference to the vector of keyword strings.

   .. oe:method:: GetRevision

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

         .. oe:api::

            std::string GetRevision() const

      .. oe:language:: python

         .. oe:api:: python

            GetRevision() -> str

      Returns the revision.

   .. oe:method:: GetRevisionDate

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

         .. oe:api::

            std::string GetRevisionDate() const

      .. oe:language:: python

         .. oe:api:: python

            GetRevisionDate() -> str

      Returns the string version of the revision date.

   .. oe:method:: GetSequenceMetadata

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

         .. oe:api::

            std::vector<OESequenceMetadata>& GetSequenceMetadata()
            const std::vector<OESequenceMetadata>& GetSequenceMetadata() const

      .. oe:language:: python

         .. oe:api:: python

            GetSequenceMetadata() -> OESequenceMetadataVector

   .. oe:method:: GetStructureID

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

         .. oe:api::

            std::string GetStructureID() const

      .. oe:language:: python

         .. oe:api:: python

            GetStructureID() -> str

      Returns the structure's ID.

   .. oe:method:: SetAuthor

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

         .. oe:api::

            void SetAuthor(const std::string& author)

      .. oe:language:: python

         .. oe:api:: python

            SetAuthor(author: str) -> None

      Sets the author's name.

   .. oe:method:: SetExperimentDate

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

         .. oe:api::

            void SetExperimentDate(const std::string& exptDate)

      .. oe:language:: python

         .. oe:api:: python

            SetExperimentDate(exptDate: str) -> None

      Sets the string version of the experiment date.

   .. oe:method:: SetExperimentType

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

         .. oe:api::

            void SetExperimentType(unsigned exprType)

      .. oe:language:: python

         .. oe:api:: python

            SetExperimentType(exprType: int) -> None

      Sets the experiment type as defined by the :oe:constns:`OESpruce::OEExperimentType` namespace.

   .. oe:method:: SetIridiumData

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

         .. oe:api::

            void SetIridiumData(const OEBio::OEIridiumData& iridData)

      .. oe:language:: python

         .. oe:api:: python

            SetIridiumData(iridData: OEIridiumData) -> None

      Sets the Iridium data from an :ref:`OEIridiumData <OEBio_OEIridiumData>` object.

   .. oe:method:: SetRevision

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

         .. oe:api::

            void SetRevision(const std::string& revVersion)

      .. oe:language:: python

         .. oe:api:: python

            SetRevision(revVersion: str) -> None

      Sets the revision.

   .. oe:method:: SetRevisionDate

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

         .. oe:api::

            void SetRevisionDate(const std::string& revDate)

      .. oe:language:: python

         .. oe:api:: python

            SetRevisionDate(revDate: str) -> None

      Sets the string version of the revision date.

   .. oe:method:: SetStructureID

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

         .. oe:api::

            void SetStructureID(const std::string& structureID)

      .. oe:language:: python

         .. oe:api:: python

            SetStructureID(structureID: str) -> None

      Sets the string version of the structure's ID.

