.. oe:namespace:: OESystem



.. meta::
   :keywords: OEHeader, Header


.. _OESystem_OEHeader:

.. oe:class:: OEHeader

   .. oe:api::


      class OEHeader : public OEContainer

   This class represents `OEHeader`.

   The following methods are publicly inherited from :ref:`OEContainer <OESystem_OEContainer>`:

   ========================================================= ========================================================== =========================================================
   :oe:meth:`operator=<OESystem::OEContainer::operator=>`    :oe:meth:`GetDataType<OESystem::OEContainer::GetDataType>`                                                          
   :oe:meth:`CreateCopy<OESystem::OEContainer::CreateCopy>`  :oe:meth:`IsDataType<OESystem::OEContainer::IsDataType>`                                                            
   ========================================================= ========================================================== =========================================================

   The following methods are publicly inherited from :ref:`OEBase <OESystem_OEBase>`:

   ======================================================== ========================================================= =========================================================
   :oe:meth:`operator=<OESystem::OEBase::operator=>`        :oe:meth:`GetData<OESystem::OEBase::GetData>`             :oe:meth:`IsDataType<OESystem::OEBase::IsDataType>`      
   :oe:meth:`operator+=<OESystem::OEBase::operator+=>`      :oe:meth:`GetDataIter<OESystem::OEBase::GetDataIter>`     :oe:meth:`SetBaseData<OESystem::OEBase::SetBaseData>`    
   :oe:meth:`AddBaseData<OESystem::OEBase::AddBaseData>`    :oe:meth:`GetDataType<OESystem::OEBase::GetDataType>`     :oe:meth:`SetBoolData<OESystem::OEBase::SetBoolData>`    
   :oe:meth:`AddData<OESystem::OEBase::AddData>`            :oe:meth:`GetDoubleData<OESystem::OEBase::GetDoubleData>` :oe:meth:`SetData<OESystem::OEBase::SetData>`            
   :oe:meth:`Clear<OESystem::OEBase::Clear>`                :oe:meth:`GetFloatData<OESystem::OEBase::GetFloatData>`   :oe:meth:`SetDoubleData<OESystem::OEBase::SetDoubleData>`
   :oe:meth:`CreateCopy<OESystem::OEBase::CreateCopy>`      :oe:meth:`GetIntData<OESystem::OEBase::GetIntData>`       :oe:meth:`SetFloatData<OESystem::OEBase::SetFloatData>`  
   :oe:meth:`DeleteData<OESystem::OEBase::DeleteData>`      :oe:meth:`GetStringData<OESystem::OEBase::GetStringData>` :oe:meth:`SetIntData<OESystem::OEBase::SetIntData>`      
   :oe:meth:`GetBoolData<OESystem::OEBase::GetBoolData>`    :oe:meth:`HasData<OESystem::OEBase::HasData>`             :oe:meth:`SetStringData<OESystem::OEBase::SetStringData>`
   ======================================================== ========================================================= =========================================================

   .. oe:method:: Constructors

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

         .. oe:api::

            OEHeader()
            OEHeader(int argc, const char* argv[], const char* appname,
                     const char* version, const char* comment = "",
                     const OEInterface& itf = OEInterface(),
                     const OEHeader* history = 0x0)
            OEHeader(const OEHeader& rhs)

      .. oe:language:: python

         .. oe:api:: python

            OEHeader() -> OEHeader
            OEHeader(argc: int, argv: List[str], appname: str, version: str,
                     comment: str = "", itf: OEInterface = OEInterface(),
                     history: OEHeader = None) -> OEHeader
            OEHeader(rhs: OEHeader) -> OEHeader

      Default and copy constructors.

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

      .. oe:api::

         OEHeader & operator=(const OEHeader &)

      Assignment operator.


   .. oe:method:: AddHistory

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

         .. oe:api::

            void AddHistory(const OEHeader& header)

      .. oe:language:: python

         .. oe:api:: python

            AddHistory(header: OEHeader) -> None

   .. oe:method:: GetCommandLine

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

         .. oe:api::

            std::string GetCommandLine() const

      .. oe:language:: python

         .. oe:api:: python

            GetCommandLine() -> str

   .. oe:method:: GetComment

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

         .. oe:api::

            std::string GetComment() const

      .. oe:language:: python

         .. oe:api:: python

            GetComment() -> str

   .. oe:method:: GetDate

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

         .. oe:api::

            void GetDate(int& day, int& month, int& year) const
            void GetDate(int& day, int& month, int& year, int& hour,
                         int& minute, int& seconds) const

      .. oe:language:: python

         .. oe:api:: python

            GetDate(day: int, month: int, year: int) -> None
            GetDate(day: int, month: int, year: int, hour: int, minute: int,
                    seconds: int) -> None

   .. oe:method:: GetHistory

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

         .. oe:api::

            OEIterBase<OEHeader>* GetHistory() const

      .. oe:language:: python

         .. oe:api:: python

            GetHistory() -> Iterable[OEHeader]

   .. oe:method:: GetInterface

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

         .. oe:api::

            std::string GetInterface() const

      .. oe:language:: python

         .. oe:api:: python

            GetInterface() -> str

   .. oe:method:: GetOERelease

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

         .. oe:api::

            std::string GetOERelease() const

      .. oe:language:: python

         .. oe:api:: python

            GetOERelease() -> str

   .. oe:method:: GetOEVersion

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

         .. oe:api::

            int GetOEVersion() const

      .. oe:language:: python

         .. oe:api:: python

            GetOEVersion() -> int

   .. oe:method:: GetPlatform

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

         .. oe:api::

            std::string GetPlatform() const

      .. oe:language:: python

         .. oe:api:: python

            GetPlatform() -> str

   .. oe:method:: GetProgram

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

         .. oe:api::

            std::string GetProgram() const

      .. oe:language:: python

         .. oe:api:: python

            GetProgram() -> str

   .. oe:method:: GetVersion

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

         .. oe:api::

            std::string GetVersion() const

      .. oe:language:: python

         .. oe:api:: python

            GetVersion() -> str

   .. oe:method:: SetCommandLine

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

         .. oe:api::

            void SetCommandLine(const std::string& comment)

      .. oe:language:: python

         .. oe:api:: python

            SetCommandLine(comment: str) -> None

   .. oe:method:: SetComment

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

         .. oe:api::

            void SetComment(const std::string& comment)

      .. oe:language:: python

         .. oe:api:: python

            SetComment(comment: str) -> None

   .. oe:method:: SetDate

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

         .. oe:api::

            void SetDate()
            void SetDate(int day, int month, int year)
            void SetDate(int day, int month, int year, int hour, int minute,
                         int seconds)

      .. oe:language:: python

         .. oe:api:: python

            SetDate() -> None
            SetDate(day: int, month: int, year: int) -> None
            SetDate(day: int, month: int, year: int, hour: int, minute: int,
                    seconds: int) -> None

   .. oe:method:: SetInterface

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

         .. oe:api::

            void SetInterface(const OEInterface& itf)

      .. oe:language:: python

         .. oe:api:: python

            SetInterface(itf: OEInterface) -> None

   .. oe:method:: SetOERelease

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

         .. oe:api::

            void SetOERelease(const std::string& release)

      .. oe:language:: python

         .. oe:api:: python

            SetOERelease(release: str) -> None

   .. oe:method:: SetOEVersion

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

         .. oe:api::

            void SetOEVersion(int version)

      .. oe:language:: python

         .. oe:api:: python

            SetOEVersion(version: int) -> None

   .. oe:method:: SetPlatform

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

         .. oe:api::

            void SetPlatform(const std::string& platform)

      .. oe:language:: python

         .. oe:api:: python

            SetPlatform(platform: str) -> None

   .. oe:method:: SetProgram

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

         .. oe:api::

            void SetProgram(const std::string& program)

      .. oe:language:: python

         .. oe:api:: python

            SetProgram(program: str) -> None

   .. oe:method:: SetVersion

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

         .. oe:api::

            void SetVersion(const std::string &)

      .. oe:language:: python

         .. oe:api:: python

            SetVersion(arg2: str) -> None

