CamiTKFile.h

Go to the documentation of this file.

/*****************************************************************************
 * $CAMITK_LICENCE_BEGIN$
 *
 * CamiTK - Computer Assisted Medical Intervention ToolKit
 * (c) 2001-2025 Univ. Grenoble Alpes, CNRS, Grenoble INP - UGA, TIMC, 38000 Grenoble, France
 *
 * Visit http://camitk.imag.fr for more information
 *
 * This file is part of CamiTK.
 *
 * CamiTK is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * CamiTK 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 Lesser General Public License version 3 for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with CamiTK.  If not, see <http://www.gnu.org/licenses/>.
 *
 * $CAMITK_LICENCE_END$
 ****************************************************************************/
 
#ifndef CAMITKFILE_H
#define CAMITKFILE_H
 
#include "CamiTKAPI.h"
 
#include <QVariant>
class QString;
class QUrl;
class QDateTime;
 
namespace camitk {

class CAMITK_API CamiTKFile {
public:
    static CamiTKFile load(QString filepath);
    static CamiTKFile load(QUrl url);

    // new changes to the camitk file format
    static const char* version;

    static const int maxFileSize;

    CamiTKFile();

    bool save(QString filepath);

    bool save(QUrl url);
 
    bool isValid();
    QString getVersion();
    QDateTime getTimestamp();
 
    void setCurrentTimestamp();
    void setCurrentVersion();

    void addContent(QString key, const QVariant);
 
    bool hasContent(QString key);
 
    QVariant getContent(QString key);
 
private:
    QVariantMap content;
 
};
 
 
} // camitk namespace
 
 
#endif // CAMITKFILE_H