//=============================================================================================================
/**
 * @file     fiff_dir_entry.h
 * @author   Lorenz Esch <lesch@mgh.harvard.edu>;
 *           Matti Hamalainen <msh@nmr.mgh.harvard.edu>;
 *           Christoph Dinh <chdinh@nmr.mgh.harvard.edu>
 * @since    0.1.0
 * @date     July, 2012
 *
 * @section  LICENSE
 *
 * Copyright (C) 2012, Lorenz Esch, Matti Hamalainen, Christoph Dinh. All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without modification, are permitted provided that
 * the following conditions are met:
 *     * 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 MNE-CPP authors nor the names of its contributors may be used
 *       to endorse or promote products derived from this software without specific prior written permission.
 *
 * 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 THE COPYRIGHT OWNER OR CONTRIBUTORS 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.
 *
 *
 * @brief    FiffDirEntry class declaration.
 *
 */

#ifndef FIFF_DIR_ENTRY_H
#define FIFF_DIR_ENTRY_H

//=============================================================================================================
// INCLUDES
//=============================================================================================================

#include "fiff_global.h"
#include "fiff_types.h"

//=============================================================================================================
// QT INCLUDES
//=============================================================================================================

#include <QSharedPointer>

//=============================================================================================================
// DEFINE NAMESPACE FIFFLIB
//=============================================================================================================

namespace FIFFLIB
{

//=============================================================================================================
/**
 * A FIFF directory entry describing a tag's kind, type, size, and position.
 *
 * @brief Directory entry description.
 **/

class FIFFSHARED_EXPORT FiffDirEntry
{
public:
    typedef QSharedPointer<FiffDirEntry> SPtr;              /**< Shared pointer type for FiffDirEntry. */
    typedef QSharedPointer<const FiffDirEntry> ConstSPtr;   /**< Const shared pointer type for FiffDirEntry. */

    //=========================================================================================================
    /**
     * Constructs the dir entry.
     */
    FiffDirEntry();

    //=========================================================================================================
    /**
     * Copy constructor.
     *
     * @param[in] p_FiffDirEntry   Dir Entry which should be copied.
     */
    FiffDirEntry(const FiffDirEntry& p_FiffDirEntry);

    //=========================================================================================================
    /**
     * Destroys the dir entry.
     */
    ~FiffDirEntry();

    //=========================================================================================================
    /**
     * Size of the old struct (fiffDirEntryRec) 4*int = 4*4 = 16
     *
     * @return the size of the old struct fiffDirEntryRec.
     */
    inline static qint32 storageSize();

public:
    fiff_int_t  kind;   /**< Tag number. */
    fiff_int_t  type;   /**< Data type. */
    fiff_int_t  size;   /**< How many bytes. */
    fiff_int_t  pos;    /**< Location in file; Note: the data is located at pos + FIFFC_DATA_OFFSET: 2GB restriction -> change this to fiff_long_t. */

};

//=============================================================================================================
// INLINE DEFINITIONS
//=============================================================================================================

inline qint32 FiffDirEntry::storageSize()
{
    return sizeof(FiffDirEntry::kind) + sizeof(FiffDirEntry::type)
         + sizeof(FiffDirEntry::size) + sizeof(FiffDirEntry::pos);
}
} // NAMESPACE

#endif // FIFF_DIR_ENTRY_H
