ModelInfo.h

/*
 * This file is part of the statismo library.
 *
 * Author: Marcel Luethi (marcel.luethi@unibas.ch)
 *
 * Copyright (c) 2011 University of Basel
 * 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 the project's author 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
 * HOLDER 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.
 *
 */



#ifndef MODELINFO_H_
#define MODELINFO_H_

#include <ctime>

#include <memory>

#include "CommonTypes.h"
#include "H5Cpp.h"

namespace statismo {

class BuilderInfo; // forward declaration

class ModelInfo {
  public:

    typedef std::vector<BuilderInfo> BuilderInfoList;

    ModelInfo();

    ModelInfo(const MatrixType& scores, const BuilderInfoList& builderInfos);

    ModelInfo(const MatrixType& scores);


    virtual ~ModelInfo();

    ModelInfo& operator=(const ModelInfo& rhs);

    ModelInfo(const ModelInfo& orig) {
        operator=(orig);
    }

    BuilderInfoList GetBuilderInfoList() const;

    const MatrixType& GetScoresMatrix() const;

    virtual void Save(const H5::CommonFG& publicFg) const;

    virtual void Load(const H5::CommonFG& publicFg);


  private:

    BuilderInfo LoadDataInfoOldStatismoFormat(const H5::CommonFG& publicFg) const;

    MatrixType m_scores;
    BuilderInfoList m_builderInfo;
};

class BuilderInfo {

    friend class ModelInfo;

  public:
    typedef std::pair<std::string, std::string> KeyValuePair;
    typedef std::list<KeyValuePair> KeyValueList;

    // Currently all the info entries are just simple list of string pairs.
    // We  don't want to use maps, as this would sort the items according to the key.
    typedef KeyValueList DataInfoList;
    typedef KeyValueList ParameterInfoList;

    BuilderInfo(const std::string& modelBuilderName, const std::string& buildTime, const DataInfoList& di,  const ParameterInfoList& pi);

    BuilderInfo(const std::string& modelBuilderName, const DataInfoList& di, const ParameterInfoList& pi);

    BuilderInfo();

    virtual ~BuilderInfo();

    BuilderInfo& operator=(const BuilderInfo& rhs);

    BuilderInfo(const BuilderInfo& orig);


    virtual void Save(const H5::CommonFG& publicFg) const;

    virtual void Load(const H5::CommonFG& publicFg);

    const DataInfoList& GetDataInfo() const;

    const ParameterInfoList& GetParameterInfo() const;

  private:



    static void FillKeyValueListFromInfoGroup(const H5::CommonFG& group, KeyValueList& keyValueList);

    std::string m_modelBuilderName;
    std::string m_buildtime;
    DataInfoList m_dataInfo;
    ParameterInfoList m_parameterInfo;
};

} // namespace statismo

#endif /* MODELINFO_H_ */