IOSS 2.0

Ioss_IOFactory.h
Go to the documentation of this file.
1 // Copyright(C) 1999-2017 National Technology & Engineering Solutions
2 // of Sandia, LLC (NTESS). Under the terms of Contract DE-NA0003525 with
3 // NTESS, the U.S. Government retains certain rights in this software.
4 //
5 // Redistribution and use in source and binary forms, with or without
6 // modification, are permitted provided that the following conditions are
7 // met:
8 //
9 // * Redistributions of source code must retain the above copyright
10 // notice, this list of conditions and the following disclaimer.
11 //
12 // * Redistributions in binary form must reproduce the above
13 // copyright notice, this list of conditions and the following
14 // disclaimer in the documentation and/or other materials provided
15 // with the distribution.
16 //
17 // * Neither the name of NTESS nor the names of its
18 // contributors may be used to endorse or promote products derived
19 // from this software without specific prior written permission.
20 //
21 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22 // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23 // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
24 // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
25 // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
26 // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
27 // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
28 // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
29 // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
30 // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
31 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
32
33 #ifndef IOSS_Ioss_IOFactory_h
34 #define IOSS_Ioss_IOFactory_h
35
36 #include <Ioss_CodeTypes.h>
37 #include <string>
38
39 #include <Ioss_DBUsage.h>
40 #include <Ioss_PropertyManager.h>
41
42 #include <map>
43 #include <vector>
44
45 /** \brief The main namespace for the Ioss library.
46 */
47 namespace Ioss {
48
49 class IOFactory;
50
51 using NameList = std::vector<std::string>;
52 using IOFactoryMap = std::map<std::string, IOFactory *, std::less<std::string>>;
53
54 class DatabaseIO;
55
56 /** \brief The main public user interface for creating Ioss::DatabaseIO objects.
57 */
58 class IOFactory
59 {
60 public:
61 virtual ~IOFactory() = default;
62 static DatabaseIO *create(const std::string &type, const std::string &filename,
63 DatabaseUsage db_usage, MPI_Comm communicator = MPI_COMM_WORLD,
64 const Ioss::PropertyManager &properties = Ioss::PropertyManager());
65
66 static int describe(NameList *names);
67 static void clean();
68 static void show_configuration();
69
70 protected:
71 explicit IOFactory(const std::string &type);
72
73 virtual DatabaseIO *make_IO(const std::string &filename, DatabaseUsage db_usage,
74 MPI_Comm communicator,
75 const Ioss::PropertyManager &properties) const = 0;
76
77 virtual void show_config() const { return; }
78
79 static void alias(const std::string &base, const std::string &syn);
80
81 private:
82 static IOFactoryMap *registry();
83 };
84 } // namespace Ioss
85 #endif
Ioss::NameList
std::vector< std::string > NameList
Definition: Ioss_CodeTypes.h:45
Ioss_CodeTypes.h
MPI_COMM_WORLD
#define MPI_COMM_WORLD
Definition: Ut_ioad.C:65
Ioss::IOFactory::describe
static int describe(NameList *names)
Get the names of database formats known to IOSS.
Definition: Ioss_IOFactory.C:131
Ioss
The main namespace for the Ioss library.
Definition: Ioad_DatabaseIO.C:66
Ioss::DatabaseIO
An input or output Database.
Definition: Ioss_DatabaseIO.h:82
Ioss_DBUsage.h
Ioss::IOFactory::show_config
virtual void show_config() const
Definition: Ioss_IOFactory.h:77
Ioss_PropertyManager.h
Ioss::IOFactory::IOFactory
IOFactory(const std::string &type)
Definition: Ioss_IOFactory.C:162
Ioss::IOFactory
The main public user interface for creating Ioss::DatabaseIO objects.
Definition: Ioss_IOFactory.h:58
Ioss::IOFactory::clean
static void clean()
Empty method.
Definition: Ioss_IOFactory.C:181
Ioss::IOFactory::make_IO
virtual DatabaseIO * make_IO(const std::string &filename, DatabaseUsage db_usage, MPI_Comm communicator, const Ioss::PropertyManager &properties) const =0
Ioss::DatabaseUsage
DatabaseUsage
Specifies how an Ioss::DatabaseIO object will be used.
Definition: Ioss_DBUsage.h:40
Ioss::IOFactory::create
static DatabaseIO * create(const std::string &type, const std::string &filename, DatabaseUsage db_usage, MPI_Comm communicator=MPI_COMM_WORLD, const Ioss::PropertyManager &properties=Ioss::PropertyManager())
Create an IO database.
Definition: Ioss_IOFactory.C:89
Ioss::IOFactoryMap
std::map< std::string, IOFactory *, std::less< std::string > > IOFactoryMap
Definition: Ioss_IOFactory.h:52
Ioss::IOFactory::registry
static IOFactoryMap * registry()
Definition: Ioss_IOFactory.C:173
Ioss::IOFactory::show_configuration
static void show_configuration()
Definition: Ioss_IOFactory.C:137
Ioss::IOFactory::alias
static void alias(const std::string &base, const std::string &syn)
Definition: Ioss_IOFactory.C:167
MPI_Comm
int MPI_Comm
Definition: Ioss_CodeTypes.h:88
Ioss::IOFactory::~IOFactory
virtual ~IOFactory()=default
Ioss::PropertyManager
A collection of Ioss::Property objects.
Definition: Ioss_PropertyManager.h:49