/[escript]/trunk/escript/src/DataEmpty.h
ViewVC logotype

Contents of /trunk/escript/src/DataEmpty.h

Parent Directory Parent Directory | Revision Log Revision Log


Revision 3911 - (show annotations)
Thu Jun 14 01:01:03 2012 UTC (7 years, 5 months ago) by jfenwick
File MIME type: text/plain
File size: 3909 byte(s)
Copyright changes
1
2 /*******************************************************
3 *
4 * Copyright (c) 2003-2012 by University of Queensland
5 * Earth Systems Science Computational Center (ESSCC)
6 * http://www.uq.edu.au/esscc
7 *
8 * Primary Business: Queensland, Australia
9 * Licensed under the Open Software License version 3.0
10 * http://www.opensource.org/licenses/osl-3.0.php
11 *
12 *******************************************************/
13
14
15 #if !defined escript_DataEmpty_20040726_H
16 #define escript_DataEmpty_20040726_H
17 #include "system_dep.h"
18
19 #include "DataReady.h"
20
21 namespace escript {
22
23 /**
24 \brief
25 Implements the DataAbstract interface for an empty Data object.
26
27 Description:
28 Implements the DataAbstract interface for an empty Data object.
29 */
30
31 class DataEmpty : public DataReady {
32 typedef DataReady parent;
33 public:
34
35 /**
36 \brief
37 Default constructor for DataEmpty.
38
39 Description:
40 Default constructor for DataEmpty.
41
42 */
43 ESCRIPT_DLL_API
44 DataEmpty();
45
46 /**
47 \brief
48 Destructor for DataEmpty.
49 */
50 ESCRIPT_DLL_API
51 virtual
52 ~DataEmpty();
53
54 /**
55 \brief
56 Return a textual representation of the Data object.
57 */
58 ESCRIPT_DLL_API
59 virtual
60 std::string
61 toString() const;
62
63 /**
64 \brief Return a deep copy of the current object.
65 */
66 ESCRIPT_DLL_API
67 virtual
68 DataAbstract*
69 deepCopy();
70
71
72 /**
73 \brief
74 Return the offset for the given sample.
75 NB: This will throw an exception as obviously an empty Data object contains no
76 samples. An implementation is required by parent DataAbstract class.
77 \param sampleNo - Input - Sample number.
78 \param dataPointNo - Input - data-point number.
79 */
80 ESCRIPT_DLL_API
81 virtual
82 DataTypes::ValueType::size_type
83 getPointOffset(int sampleNo,
84 int dataPointNo) const;
85
86 ESCRIPT_DLL_API
87 virtual
88 DataTypes::ValueType::size_type
89 getPointOffset(int sampleNo,
90 int dataPointNo);
91
92 /**
93 \brief
94 Return the number of doubles stored for the Data object.
95 As this is an empty Data object, this method will always return 0.
96 */
97 ESCRIPT_DLL_API
98 virtual
99 ValueType::size_type
100 getLength() const;
101
102 /**
103 \brief
104 Factory method that returns a newly created DataEmpty sliced from the
105 current Data object according to the specified region.
106 NB: This will throw an exception as obviously an empty Data object contains no
107 data to slice from. An implementation is required by parent DataAbstract class.
108 */
109 ESCRIPT_DLL_API
110 virtual
111 DataAbstract*
112 getSlice(const DataTypes::RegionType& region) const;
113
114 /**
115 \brief
116 Set the current Data object according to the specified slice from the
117 given input value.
118 NB: This will throw an exception as obviously an empty Data object contains no
119 data to slice to. An implementation is required by parent DataAbstract class.
120 \param value Input - Data to copy from
121 \param region Input - Region to copy.
122 */
123 ESCRIPT_DLL_API
124 virtual
125 void
126 setSlice(const DataAbstract* value,
127 const DataTypes::RegionType& region);
128
129 /**
130 \brief invert square matricies
131 \param out - Where to store the results
132 \return errorcode (0 indicates success)
133 */
134 ESCRIPT_DLL_API
135 int
136 matrixInverse(DataAbstract* out) const;
137
138 void
139 dump(const std::string fileName) const;
140
141 ESCRIPT_DLL_API
142 bool
143 hasNaN() const
144 {
145 return false;
146 }
147 protected:
148
149 /**
150 \brief Provide access to underlying storage. Internal use only!
151 */
152 ESCRIPT_DLL_API
153 virtual DataTypes::ValueType&
154 getVectorRW();
155
156
157 ESCRIPT_DLL_API
158 virtual const DataTypes::ValueType&
159 getVectorRO() const;
160
161
162 private:
163
164 // /**
165 /* \brief
166 Throw a standard exception. This function is called if an attempt
167 is made to use functions of DataEmpty that are not valid.*/
168 // */
169 // void
170 // throwStandardException(const std::string& functionName) const;
171
172 };
173
174 } // end of namespace
175
176 #endif

Properties

Name Value
svn:eol-style native
svn:keywords Author Date Id Revision

  ViewVC Help
Powered by ViewVC 1.1.26