Homec4science
Diffusion SpecMiCP / ReactMiCP (chloride) Browse

specmicp/src/specmicp_database/io/hdf5_database.hpp
fcd46f4bbaa8chloride

Last Change
Raw File

hdf5_database.hpp
View Options

/* =============================================================================
Copyright (c) 2014 - 2016
F. Georget <fabieng@princeton.edu> Princeton University
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
1. Redistributions of source code must retain the above copyright notice,
this list of conditions and the following disclaimer.
2. 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.
3. Neither the name of the copyright holder 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 SPECMICP_IO_HDF5_DATABASE_HPP
#define SPECMICP_IO_HDF5_DATABASE_HPP
//! \file hdf5_database.hpp
//! \brief Format the database to hdf5
#include "specmicp_common/types.hpp"
#include <memory>
namespace specmicp {
namespace database {
struct DataContainer;
using RawDatabasePtr = std::shared_ptr<DataContainer>;
} //end namespace Database
namespace io {
namespace hdf5 {
class GroupPath;
} // end namespace hdf5
//! \brief Save the database labels in a HDF5 file
//!
//! \param location where to save the labels
//! \param name A new group 'name' will be created to save the database
//! \param raw_data The database to save
//!
void SPECMICP_DLL_PUBLIC save_database_labels(
hdf5::GroupPath& location,
const std::string& name,
database::RawDatabasePtr raw_data
);
} //end namespace io
} //end namespace specmicp
#endif // SPECMICP_IO_HDF5_DATABASE_HPP
c4science · Help