libopenms-dev 1.11.1-5 / usr / include / OpenMS / METADATA / MetaInfoInterface.h

// --------------------------------------------------------------------------
//                   OpenMS -- Open-Source Mass Spectrometry
// --------------------------------------------------------------------------
// Copyright The OpenMS Team -- Eberhard Karls University Tuebingen,
// ETH Zurich, and Freie Universitaet Berlin 2002-2013.
//
// This software is released under a three-clause BSD license:
//  * Redistributions of source code must retain the above copyright
//    notice, this list of conditions and the following disclaimer.
//  * Redistributions in binary form must reproduce the above copyright
//    notice, this list of conditions and the following disclaimer in the
//    documentation and/or other materials provided with the distribution.
//  * Neither the name of any author or any participating institution
//    may be used to endorse or promote products derived from this software
//    without specific prior written permission.
// For a full list of authors, refer to the file AUTHORS.
// --------------------------------------------------------------------------
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
// AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
// ARE DISCLAIMED. IN NO EVENT SHALL ANY OF THE AUTHORS OR THE CONTRIBUTING
// INSTITUTIONS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
// OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
// WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
// OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
// ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
// --------------------------------------------------------------------------
// $Maintainer: Andreas Bertsch $
// $Authors: Marc Sturm $
// --------------------------------------------------------------------------

#ifndef OPENMS_METADATA_METAINFOINTERFACE_H
#define OPENMS_METADATA_METAINFOINTERFACE_H

#include <map>
#include <string>

#include <iostream>

#include <OpenMS/METADATA/MetaInfo.h>

namespace OpenMS
{
  class String;

  /**
      @brief Interface for classes that can store arbitrary meta information
      (Type-Name-Value tuples).

      MetaInfoInterface is a base class for all classes that use one MetaInfo
      object as member.  If you want to add meta information to a class, let it
      publically inherit the MetaInfoInterface.  Meta information is an array of
      Type-Name-Value tupels.

      @ingroup Metadata
  */

  class OPENMS_DLLAPI MetaInfoInterface
  {
public:

    ///constructor
    MetaInfoInterface();
    ///copy constructor
    MetaInfoInterface(const MetaInfoInterface & rhs);
    ///destructor
    ~MetaInfoInterface();

    ///assignment operator
    MetaInfoInterface & operator=(const MetaInfoInterface & rhs);

    /// Equality operator
    bool operator==(const MetaInfoInterface & rhs) const;
    /// Equality operator
    bool operator!=(const MetaInfoInterface & rhs) const;

    /// returns the value corresponding to a string
    const DataValue & getMetaValue(const String & name) const;
    /// returns the value corresponding to an index
    const DataValue & getMetaValue(UInt index) const;

    /// returns if this MetaInfo is set
    bool metaValueExists(const String & name) const;
    /// returns if this MetaInfo is set
    bool metaValueExists(UInt index) const;

    /// sets the DataValue corresponding to a name
    void setMetaValue(const String & name, const DataValue & value);
    ///  sets the DataValue corresponding to an index
    void setMetaValue(UInt index, const DataValue & value);

    /// Removes the DataValue corresponding to @p name if it exists
    void removeMetaValue(const String & name);
    /// Removes the DataValue corresponding to @p index if it exists
    void removeMetaValue(UInt index);

    /// retuns a reference to the MetaInfoRegistry
    static MetaInfoRegistry & metaRegistry();

    /// fills the given vector with a list of all keys for which a value is set
    void getKeys(std::vector<String> & keys) const;

    /// fills the given vector with a list of all keys for which a value is set
    void getKeys(std::vector<UInt> & keys) const;

    /// returns if the MetaInfo is empty
    bool isMetaEmpty() const;

    /// removes all meta values
    void clearMetaInfo();

protected:
    /// creates the MetaInfo object if it does not exist
    inline void createIfNotExists_();
    /// pointer to the MetaInfo object. 0 by default
    MetaInfo * meta_;
  };

} // namespace OpenMS

#endif // OPENMS_METADATA_METAINFOINTERFACE_H