File: FileOpenOptions.h

package info (click to toggle)
paraview 5.4.1%2Bdfsg4-3.1
  • links: PTS, VCS
  • area: main
  • in suites: buster
  • size: 218,616 kB
  • sloc: cpp: 2,331,508; ansic: 322,365; python: 111,051; xml: 79,203; tcl: 47,013; yacc: 4,877; java: 4,438; perl: 3,238; sh: 2,920; lex: 1,908; f90: 748; makefile: 273; pascal: 228; objc: 83; fortran: 31
file content (170 lines) | stat: -rw-r--r-- 6,551 bytes parent folder | download
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
/*****************************************************************************
*
* Copyright (c) 2000 - 2017, Lawrence Livermore National Security, LLC
* Produced at the Lawrence Livermore National Laboratory
* LLNL-CODE-442911
* 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.
*
*****************************************************************************/

#ifndef FILEOPENOPTIONS_H
#define FILEOPENOPTIONS_H
#include <state_exports.h>
#include <string>
#include <AttributeSubject.h>

class DBOptionsAttributes;
#include <DBPluginInfoAttributes.h>

// ****************************************************************************
// Class: FileOpenOptions
//
// Purpose:
//    This class contains the file opening options for all the database plugins.
//
// Notes:      Autogenerated by xml2atts.
//
// Programmer: xml2atts
// Creation:   omitted
//
// Modifications:
//   
// ****************************************************************************

class STATE_API FileOpenOptions : public AttributeSubject
{
public:
    // These constructors are for objects of this class
    FileOpenOptions();
    FileOpenOptions(const FileOpenOptions &obj);
protected:
    // These constructors are for objects derived from this class
    FileOpenOptions(private_tmfs_t tmfs);
    FileOpenOptions(const FileOpenOptions &obj, private_tmfs_t tmfs);
public:
    virtual ~FileOpenOptions();

    virtual FileOpenOptions& operator = (const FileOpenOptions &obj);
    virtual bool operator == (const FileOpenOptions &obj) const;
    virtual bool operator != (const FileOpenOptions &obj) const;
private:
    void Init();
    void Copy(const FileOpenOptions &obj);
public:

    virtual const std::string TypeName() const;
    virtual bool CopyAttributes(const AttributeGroup *);
    virtual AttributeSubject *CreateCompatible(const std::string &) const;
    virtual AttributeSubject *NewInstance(bool) const;

    // Property selection methods
    virtual void SelectAll();
    void SelectTypeNames();
    void SelectTypeIDs();
    void SelectOpenOptions();
    void SelectEnabled();
    void SelectPreferredIDs();

    // Property setting methods
    void SetTypeNames(const stringVector &typeNames_);
    void SetTypeIDs(const stringVector &typeIDs_);
    void SetEnabled(const intVector &Enabled_);
    void SetPreferredIDs(const stringVector &preferredIDs_);

    // Property getting methods
    const stringVector &GetTypeNames() const;
          stringVector &GetTypeNames();
    const stringVector &GetTypeIDs() const;
          stringVector &GetTypeIDs();
    const AttributeGroupVector &GetOpenOptions() const;
          AttributeGroupVector &GetOpenOptions();
    const intVector    &GetEnabled() const;
          intVector    &GetEnabled();
    const stringVector &GetPreferredIDs() const;
          stringVector &GetPreferredIDs();

    // Persistence methods
    virtual bool CreateNode(DataNode *node, bool completeSave, bool forceAdd);
    virtual void SetFromNode(DataNode *node);


    // Attributegroup convenience methods
    void AddOpenOptions(const DBOptionsAttributes &);
    void ClearOpenOptions();
    void RemoveOpenOptions(int i);
    int  GetNumOpenOptions() const;
    DBOptionsAttributes &GetOpenOptions(int i);
    const DBOptionsAttributes &GetOpenOptions(int i) const;

    DBOptionsAttributes &operator [] (int i);
    const DBOptionsAttributes &operator [] (int i) const;


    // Keyframing methods
    virtual std::string               GetFieldName(int index) const;
    virtual AttributeGroup::FieldType GetFieldType(int index) const;
    virtual std::string               GetFieldTypeName(int index) const;
    virtual bool                      FieldsEqual(int index, const AttributeGroup *rhs) const;

    // User-defined methods
    void MergeNewFromPluginInfo(const DBPluginInfoAttributes*);
    void AddAssumedFormatsToPreferred(const stringVector &formats);
    void AddFallbackFormatsToPreferred(const stringVector &given);
    const DBOptionsAttributes *GetOpenOptionsForID(const std::string&);
    bool IsIDEnabled(const std::string&);

    // IDs that can be used to identify fields in case statements
    enum {
        ID_typeNames = 0,
        ID_typeIDs,
        ID_openOptions,
        ID_Enabled,
        ID_preferredIDs,
        ID__LAST
    };

protected:
    AttributeGroup *CreateSubAttributeGroup(int index);
private:
    stringVector         typeNames;
    stringVector         typeIDs;
    AttributeGroupVector openOptions;
    intVector            Enabled;
    stringVector         preferredIDs;

    // Static class format string for type map.
    static const char *TypeMapFormatString;
    static const private_tmfs_t TmfsStruct;
};
#define FILEOPENOPTIONS_TMFS "s*s*a*i*s*"

#endif