1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
|
/*****************************************************************************
*
* Copyright (c) 2000 - 2010, Lawrence Livermore National Security, LLC
* Produced at the Lawrence Livermore National Laboratory
* LLNL-CODE-400124
* All rights reserved.
*
* This file is part of VisIt. For details, see https://visit.llnl.gov/. The
* full copyright notice is contained in the file COPYRIGHT located at the root
* of the VisIt distribution or at http://www.llnl.gov/visit/copyright.html.
*
* 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 disclaimer below.
* - Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the disclaimer (as noted below) in the
* documentation and/or other materials provided with the distribution.
* - Neither the name of the LLNS/LLNL 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 LAWRENCE LIVERMORE NATIONAL SECURITY,
* LLC, THE U.S. DEPARTMENT OF ENERGY 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.
*
*****************************************************************************/
// ************************************************************************* //
// DatabasePluginInfo.h //
// ************************************************************************* //
#ifndef DATABASE_PLUGIN_INFO_H
#define DATABASE_PLUGIN_INFO_H
#include <plugin_exports.h>
#include <stdio.h>
#include <string>
#include <vector>
enum DatabaseType
{
DB_TYPE_STSD,
DB_TYPE_STMD,
DB_TYPE_MTSD,
DB_TYPE_MTMD,
DB_TYPE_CUSTOM
};
// Forward declarations.
class avtDatabase;
class avtDatabaseWriter;
class DBOptionsAttributes;
class DatabasePluginManager;
// ****************************************************************************
// Class: *DatabasePluginInfo
//
// Purpose:
// Classes that provide all the information about the database plugin.
// Portions are separated into pieces relevant to the appropriate
// components of VisIt.
//
// Programmer: Jeremy Meredith
// Creation: August 21, 2002
//
// Modifications:
//
// Hank Childs, Wed Sep 10 07:05:54 PDT 2003
// Added DatabaseWriter.
//
// Jeremy Meredith, Wed Nov 5 10:28:29 PST 2003
// Added ability to disable plugins by default.
//
// Hank Childs, Thu Feb 19 10:01:47 PST 2004
// Added GetFilenames. Made GetDefaultExtensions not be pure virtual.
//
// Jeremy Meredith, Tue Feb 22 18:36:54 PST 2005
// Moved GetWriter to the engine so the mdserver doesn't need it.
// Added the general plugin info method HasWriter so the mdserver
// can still check if it is supported by the given plugin.
//
// Hank Childs, Tue Mar 22 16:06:15 PST 2005
// Make destructor virtual.
//
// Hank Childs, Mon May 23 16:31:36 PDT 2005
// Add DBOptions.
//
// Mark C. Miller, Mon Aug 6 13:36:16 PDT 2007
// Added GetDfltExtsFromGen and GetFilenamesFromGen as newer ways to
// obtain this information instead of GetDefaultExtensions and GetFilenames
// on CommonDatabasePluginInfo. Note, however, we will leave the older
// methods around for backward compatibility for plugins VisIt does not own.
//
// Brad Whitlock, Tue Jun 24 16:22:13 PDT 2008
// Added a pointer back to the plugin manager in the common info because
// certain database readers need to access the plugin manager and it's
// no longer a singleton. The plugin manager will add a pointer to itself
// into the common info when it reads the info.
//
// Jeremy Meredith, Thu Aug 7 16:22:24 EDT 2008
// Use const char* for the functions likely to return a string literal.
//
// Jeremy Meredith, Mon Dec 28 15:08:45 EST 2009
// Changed file matching behavior to use patterns and a strictness
// flag. Made pure virtual so plugin developers will know to re-run info
// xml code generation tool. Removed deprecated versions of this code.
//
// ****************************************************************************
class PLUGIN_API GeneralDatabasePluginInfo
{
public:
virtual ~GeneralDatabasePluginInfo() {;};
virtual const char *GetName() const = 0;
virtual const char *GetVersion() const = 0;
virtual const char *GetID() const = 0;
virtual bool EnabledByDefault() const { return true; }
virtual bool HasWriter() const { return false; }
virtual std::vector<std::string> GetDefaultFilePatterns() const = 0;
virtual bool AreDefaultFilePatternsStrict() const { return false; }
virtual bool OpensWholeDirectory() const { return false; }
};
class PLUGIN_API CommonDatabasePluginInfo : public virtual GeneralDatabasePluginInfo
{
public:
CommonDatabasePluginInfo();
virtual ~CommonDatabasePluginInfo();
virtual DatabaseType GetDatabaseType() = 0;
virtual avtDatabase *SetupDatabase(const char * const *list,
int nList, int nBlock) = 0;
virtual DBOptionsAttributes *GetReadOptions(void) const;
virtual DBOptionsAttributes *GetWriteOptions(void) const;
virtual void SetReadOptions(DBOptionsAttributes *);
virtual void SetWriteOptions(DBOptionsAttributes *);
void SetPluginManager(DatabasePluginManager *ptr);
DatabasePluginManager *GetPluginManager() const;
protected:
DBOptionsAttributes *readOptions;
DBOptionsAttributes *writeOptions;
DatabasePluginManager *pluginManager;
};
class PLUGIN_API MDServerDatabasePluginInfo : public virtual CommonDatabasePluginInfo
{
public:
// this makes compilers happy... remove if we ever have functions here
virtual void dummy() = 0;
};
class PLUGIN_API EngineDatabasePluginInfo : public virtual CommonDatabasePluginInfo
{
public:
virtual avtDatabaseWriter *GetWriter(void) { return NULL; };
};
#endif
|
