File: metaForm.h

package info (click to toggle)
paraview 5.13.2%2Bdfsg-3
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 544,220 kB
  • sloc: cpp: 3,374,605; ansic: 1,332,409; python: 150,381; xml: 122,166; sql: 65,887; sh: 7,317; javascript: 5,262; yacc: 4,417; java: 3,977; perl: 2,363; lex: 1,929; f90: 1,397; makefile: 170; objc: 153; tcl: 59; pascal: 50; fortran: 29
file content (223 lines) | stat: -rw-r--r-- 4,286 bytes parent folder | download | duplicates (7)
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
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
/*============================================================================
  MetaIO
  Copyright 2000-2010 Insight Software Consortium

  Distributed under the OSI-approved BSD License (the "License");
  see accompanying file Copyright.txt for details.

  This software is distributed WITHOUT ANY WARRANTY; without even the
  implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
  See the License for more information.
============================================================================*/
#include "metaTypes.h"

#ifndef ITKMetaIO_METAFORM_H
#  define ITKMetaIO_METAFORM_H

#  include "metaUtils.h"
#  include "metaEvent.h"

#  ifdef _MSC_VER
#    pragma warning(disable : 4251)
#  endif

#  if (METAIO_USE_NAMESPACE)
namespace METAIO_NAMESPACE
{
#  endif

class METAIO_EXPORT MetaForm
{
public:
  MetaForm();
  explicit MetaForm(const char * _fileName);

  virtual ~MetaForm();

  virtual void
  PrintInfo() const;

  virtual void
  CopyInfo(const MetaForm * _form);

  virtual void
  Clear();

  void
  ClearFields();

  static bool
  InitializeEssential();

  const char *
  FileName() const;
  void
  FileName(const char * _fileName);


  //    Comment(...)
  //       Optional Field
  //       Arbitrary string
  const char *
  Comment() const;
  void
  Comment(const char * _comment);

  //     FormTypeName()
  //       The intended type: vector, co-vector, matrix....
  const char *
  FormTypeName() const;
  void
  FormTypeName(const char * _formTypeName);

  //    Name(...)
  //       Optional Field
  //       Name of the current metaForm
  const char *
  Name() const;
  void
  Name(const char * _name);

  bool
  BinaryData() const;
  void
  BinaryData(bool _binaryData);

  bool
  BinaryDataByteOrderMSB() const;
  void
  BinaryDataByteOrderMSB(bool _elementByteOrderMSB);

  bool
  CompressedData() const;
  void
  CompressedData(bool _compressedData);

  // Get/Set the double precision for writing
  unsigned int
  DoublePrecision() const;
  unsigned int
  GetDoublePrecision() const
  {
    return this->DoublePrecision();
  }

  void
  DoublePrecision(unsigned int _doublePrecision);
  void
  SetDoublePrecision(unsigned int _doublePrecision)
  {
    this->DoublePrecision(_doublePrecision);
  }

  MetaEvent *
  Event();
  MetaEvent *
  GetEvent()
  {
    return Event();
  }

  void
  Event(MetaEvent * _event);
  void
  SetEvent(MetaEvent * _event)
  {
    Event(_event);
  }

  void
  ClearUserFields();

  void *
  GetUserField(const char * _name);

  template <class TType>
  bool
  AddUserField(const char *      _fieldName,
               MET_ValueEnumType _type,
               int               _length,
               TType *           _v,
               bool              _required = true,
               int               _dependsOn = -1)
  {
    auto * mFw = new MET_FieldRecordType;
    MET_InitWriteField(mFw, _fieldName, _type, static_cast<size_t>(_length), _v);
    m_UserDefinedWriteFields.push_back(mFw);

    auto * mFr = new MET_FieldRecordType;
    MET_InitReadField(mFr, _fieldName, _type, _required, _dependsOn, static_cast<size_t>(_length));
    m_UserDefinedReadFields.push_back(mFr);

    return true;
  }

  static bool
  CanRead(const char * _fileName = nullptr) ;

  bool
  Read(const char * _fileName = nullptr);

  static bool
  CanReadStream(std::ifstream * _stream) ;

  bool
  ReadStream(std::ifstream * _stream);

  bool
  Write(const char * _fileName = nullptr);

  bool
  WriteStream(std::ofstream * _stream);

  // PROTECTED
protected:
  typedef std::vector<MET_FieldRecordType *> FieldsContainerType;

  std::ifstream * m_ReadStream;
  std::ofstream * m_WriteStream;

  std::string m_FileName;

  char m_Comment[255]{};

  char m_FormTypeName[255]{};

  char m_Name[255]{};

  bool m_BinaryData{};
  bool m_BinaryDataByteOrderMSB{};

  bool m_CompressedData{};

  unsigned int m_DoublePrecision;

  MetaEvent * m_Event;

  FieldsContainerType m_Fields;
  FieldsContainerType m_UserDefinedWriteFields;
  FieldsContainerType m_UserDefinedReadFields;

  // protected functions

  static void
  M_Destroy();

  virtual void
  M_SetupReadFields();

  virtual void
  M_SetupWriteFields();

  virtual bool
  M_Read();

  virtual bool
  M_Write();
};

#  if (METAIO_USE_NAMESPACE)
};
#  endif

#endif