-
Notifications
You must be signed in to change notification settings - Fork 3
/
Copy pathXdmfTime.hpp
165 lines (136 loc) · 4.59 KB
/
XdmfTime.hpp
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
/*****************************************************************************/
/* XDMF */
/* eXtensible Data Model and Format */
/* */
/* Id : XdmfTime.hpp */
/* */
/* Author: */
/* Kenneth Leiter */
/* [email protected] */
/* US Army Research Laboratory */
/* Aberdeen Proving Ground, MD */
/* */
/* Copyright @ 2011 US Army Research Laboratory */
/* All Rights Reserved */
/* See 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 above copyright notice */
/* for more information. */
/* */
/*****************************************************************************/
#ifndef XDMFTIME_HPP_
#define XDMFTIME_HPP_
// C Compatible Includes
#include "Xdmf.hpp"
#include "XdmfItem.hpp"
#ifdef __cplusplus
/**
* @brief Time specification for an XdmfGrid.
*
* An XdmfTime sets a time value for an XdmfGrid.
*/
class XDMF_EXPORT XdmfTime : public XdmfItem {
public:
/**
* Create a new XdmfTime.
*
* Example of use:
*
* C++
*
* @dontinclude ExampleXdmfTime.cpp
* @skipline //#initialization
* @until //#initialization
*
* Python
*
* @dontinclude XdmfExampleTime.py
* @skipline #//initialization
* @until #//initialization
*
* @param value The timeValue of the XdmfTime to create.
* @return The new XdmfTime.
*/
static shared_ptr<XdmfTime> New(const double & value = 0);
virtual ~XdmfTime();
LOKI_DEFINE_VISITABLE(XdmfTime, XdmfItem)
static const std::string ItemTag;
std::map<std::string, std::string> getItemProperties() const;
std::string getItemTag() const;
/**
* Get the time value associated with this XdmfTime.
*
* Example of use:
*
* C++
*
* @dontinclude ExampleXdmfTime.cpp
* @skipline //#initialization
* @until //#initialization
* @skipline //#getValue
* @until //#getValue
*
* Python
*
* @dontinclude XdmfExampleTime.py
* @skipline #//initialization
* @until #//initialization
* @skipline #//getValue
* @until #//getValue
*
* @return A double containing the time value.
*/
double getValue() const;
/**
* Set the time value associated with this XdmfTime.
*
* Example of use:
*
* C++
*
* @dontinclude ExampleXdmfTime.cpp
* @skipline //#initialization
* @until //#initialization
* @skipline //#setValue
* @until //#setValue
*
* Python
*
* @dontinclude XdmfExampleTime.py
* @skipline #//initialization
* @until #//initialization
* @skipline #//setValue
* @until #//setValue
*
* @param time A double containing the time value.
*/
void setValue(const double & time);
XdmfTime(XdmfTime &);
protected:
XdmfTime(const double & value);
virtual void
populateItem(const std::map<std::string, std::string> & itemProperties,
const std::vector<shared_ptr<XdmfItem> > & childItems,
const XdmfCoreReader * const reader);
private:
XdmfTime(const XdmfTime &); // Not implemented.
void operator=(const XdmfTime &); // Not implemented.
double mValue;
};
#endif
#ifdef __cplusplus
extern "C" {
#endif
// C wrappers go here
struct XDMFTIME; // Simply as a typedef to ensure correct typing
typedef struct XDMFTIME XDMFTIME;
XDMF_EXPORT XDMFTIME * XdmfTimeNew(double value);
XDMF_EXPORT double XdmfTimeGetValue(XDMFTIME * timePointer);
XDMF_EXPORT void XdmfTimeSetValue(XDMFTIME * timePointer, double time);
XDMF_ITEM_C_CHILD_DECLARE(XdmfTime, XDMFTIME, XDMF)
#ifdef __cplusplus
}
#endif
#endif /* XDMFTIME_HPP_ */