DAFFMetadata.h

Go to the documentation of this file.

/*
 * -------------------------------------------------------------------------------------
 *
 *  OpenDAFF - A free, open source software package for directional audio data
 *  Copyright 2016 Institute of Technical Acoustics, RWTH Aachen University
 *  OpenDAFF is distributed under the Apache License Version 2.0.
 *
 *  ------------------------------------------------------------------------------------
 *
 */

#ifndef IW_DAFF_METADATA
#define IW_DAFF_METADATA

#include <DAFFDefs.h>
#include <string>
#include <vector>


class DAFF_API DAFFMetadata
{
public:
    enum {
        DAFF_BOOL=0,    //<! Boolean (true|false, yes|no)
        DAFF_INT=1,     //<! Integer number
        DAFF_FLOAT=2,  //<! Floating-point number
        DAFF_STRING=3  //<! String
    };

    inline virtual ~DAFFMetadata() {};

    static inline std::string GetKeyTypeString( int iType )
    {
        switch( iType )
        {
        case DAFFMetadata::DAFF_STRING:
            return "String";
        case DAFFMetadata::DAFF_BOOL:
            return "Bool";
        case DAFFMetadata::DAFF_FLOAT:
            return "Float";
        case DAFFMetadata::DAFF_INT:
            return "Integer";
        default:
            return "Unkown";
        }
    };

    virtual bool isEmpty() const=0;

    virtual bool hasKey(const std::string& sKey) const=0;

    virtual void getKeys(std::vector< std::string >& vsKeyList) const=0;

    virtual int getKeyType(const std::string& sKey) const=0;


    virtual std::string getKeyString(const std::string& sKey) const=0;

    virtual bool getKeyBool(const std::string& sKey) const=0;

    virtual int getKeyInt(const std::string& sKey) const=0;


    virtual double getKeyFloat(const std::string& sKey) const=0;

    virtual std::string toString() const=0;
};

#endif // IW_DAFF_METADATA