metadatum.hpp

Go to the documentation of this file.

// ***************************************************************** -*- C++ -*-
/*
 * Copyright (C) 2004-2018 Exiv2 authors
 * This program is part of the Exiv2 distribution.
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, 5th Floor, Boston, MA 02110-1301 USA.
 */
#ifndef METADATUM_HPP_
#define METADATUM_HPP_

// *****************************************************************************
#include "exiv2lib_export.h"

// included header files
#include "value.hpp"

// *****************************************************************************
// namespace extensions
namespace Exiv2 {

// *****************************************************************************
// class declarations
    class ExifData;

// *****************************************************************************
// class definitions

    class EXIV2API Key {
    public:
        typedef std::auto_ptr<Key> AutoPtr;


        virtual ~Key();



        virtual std::string key() const =0;
        virtual const char* familyName() const =0;
        virtual std::string groupName() const =0;
        virtual std::string tagName() const =0;
        virtual std::string tagLabel() const =0;
        virtual uint16_t tag() const =0;
        AutoPtr clone() const;
        std::ostream& write(std::ostream& os) const { return os << key(); }

    protected:


        Key& operator=(const Key& rhs);

    private:
        virtual Key* clone_() const =0;

    }; // class Key

    inline std::ostream& operator<<(std::ostream& os, const Key& key)
    {
        return key.write(os);
    }

    class EXIV2API Metadatum {
    public:

        Metadatum();
        Metadatum(const Metadatum& rhs);
        virtual ~Metadatum();



        virtual void setValue(const Value* pValue) =0;
        virtual int setValue(const std::string& buf) =0;



        std::string print(const ExifData* pMetadata =0) const;
        virtual long copy(byte* buf, ByteOrder byteOrder) const =0;
        virtual std::ostream& write(
                  std::ostream& os,
            const ExifData*     pMetadata =0
        ) const =0;
        virtual std::string key() const =0;
        virtual const char* familyName() const =0;
        virtual std::string groupName() const =0;
        virtual std::string tagName() const =0;
        virtual std::string tagLabel() const =0;
        virtual uint16_t tag() const =0;
        virtual TypeId typeId() const =0;
        virtual const char* typeName() const =0;
        virtual long typeSize() const =0;
        virtual long count() const =0;
        virtual long size() const =0;
        virtual std::string toString() const =0;
        virtual std::string toString(long n) const =0;
        virtual long toLong(long n =0) const =0;
        virtual float toFloat(long n =0) const =0;
        virtual Rational toRational(long n =0) const =0;
        virtual Value::AutoPtr getValue() const =0;
        virtual const Value& value() const =0;

    protected:


        Metadatum& operator=(const Metadatum& rhs);

    }; // class Metadatum

    inline std::ostream& operator<<(std::ostream& os, const Metadatum& md)
    {
        return md.write(os);
    }

    EXIV2API bool cmpMetadataByTag(const Metadatum& lhs, const Metadatum& rhs);
    EXIV2API bool cmpMetadataByKey(const Metadatum& lhs, const Metadatum& rhs);

}                                       // namespace Exiv2

#endif                                  // #ifndef METADATUM_HPP_