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

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

Parent Directory Parent Directory | Revision Log Revision Log


Revision 2005 - (hide annotations)
Mon Nov 10 01:21:39 2008 UTC (11 years, 3 months ago) by jfenwick
File MIME type: text/plain
File size: 4115 byte(s)
Bringing all changes across from schroedinger.
(Note this does not mean development is done, just that it will happen
on the trunk for now).
If anyone notices any problems please contact me.


1 jgs 121
2 ksteube 1312 /*******************************************************
3 ksteube 1811 *
4     * Copyright (c) 2003-2008 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 ksteube 1312
14 ksteube 1811
15 jgs 102 #if !defined escript_DataEmpty_20040726_H
16 jgs 82 #define escript_DataEmpty_20040726_H
17 woo409 757 #include "system_dep.h"
18 jgs 82
19 jfenwick 2005 #include "DataReady.h"
20 jgs 82
21     namespace escript {
22    
23     /**
24     \brief
25 jgs 102 Implements the DataAbstract interface for an empty Data object.
26 jgs 82
27     Description:
28 jgs 102 Implements the DataAbstract interface for an empty Data object.
29 jgs 82 */
30 jgs 121
31 jfenwick 2005 class DataEmpty : public DataReady {
32     typedef DataReady parent;
33 jgs 82 public:
34    
35     /**
36     \brief
37 jgs 102 Default constructor for DataEmpty.
38 jgs 82
39     Description:
40 jgs 102 Default constructor for DataEmpty.
41 jgs 82
42     */
43 woo409 757 ESCRIPT_DLL_API
44 jgs 82 DataEmpty();
45 jgs 102
46 jgs 82 /**
47     \brief
48 jgs 102 Destructor for DataEmpty.
49 jgs 82 */
50 woo409 757 ESCRIPT_DLL_API
51 jgs 102 virtual
52     ~DataEmpty();
53    
54 jgs 82 /**
55     \brief
56 jgs 102 Return a textual representation of the Data object.
57 jgs 82 */
58 woo409 757 ESCRIPT_DLL_API
59 jgs 102 virtual
60     std::string
61     toString() const;
62    
63 jgs 82 /**
64 jfenwick 1799 \brief Return a deep copy of the current object.
65     */
66     ESCRIPT_DLL_API
67     virtual
68     DataAbstract*
69     deepCopy();
70    
71    
72     /**
73 jgs 82 \brief
74 jgs 121 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 jgs 102 \param sampleNo - Input - Sample number.
78     \param dataPointNo - Input - data-point number.
79 jgs 82 */
80 woo409 757 ESCRIPT_DLL_API
81 jgs 102 virtual
82 jfenwick 1796 DataTypes::ValueType::size_type
83 jgs 102 getPointOffset(int sampleNo,
84     int dataPointNo) const;
85    
86 jfenwick 2005 ESCRIPT_DLL_API
87     virtual
88     DataTypes::ValueType::size_type
89     getPointOffset(int sampleNo,
90     int dataPointNo);
91    
92 jfenwick 1796 // /**
93     /* \brief
94 jgs 82 Return a view into the data for the data point specified.
95 jgs 121 NB: This will throw an exception as obviously an empty Data object contains no
96     data points. An implementation is required by parent DataAbstract class.
97 jgs 102 \param sampleNo - Input - Sample number.
98 jfenwick 1796 \param dataPointNo - Input - data-point number.*/
99     // */
100     // ESCRIPT_DLL_API
101     // virtual
102     // DataArrayView
103     // getDataPoint(int sampleNo,
104     // int dataPointNo);
105 jgs 102
106     /**
107 jgs 82 \brief
108 jgs 102 Return the number of doubles stored for the Data object.
109 jgs 121 As this is an empty Data object, this method will always return 0.
110 jgs 82 */
111 woo409 757 ESCRIPT_DLL_API
112 jgs 102 virtual
113     ValueType::size_type
114     getLength() const;
115    
116 jgs 82 /**
117     \brief
118 jgs 102 Factory method that returns a newly created DataEmpty sliced from the
119     current Data object according to the specified region.
120 jgs 121 NB: This will throw an exception as obviously an empty Data object contains no
121     data to slice from. An implementation is required by parent DataAbstract class.
122 jgs 82 */
123 woo409 757 ESCRIPT_DLL_API
124 jgs 102 virtual
125     DataAbstract*
126 jfenwick 1796 getSlice(const DataTypes::RegionType& region) const;
127 jgs 102
128     /**
129 jgs 82 \brief
130 jgs 102 Set the current Data object according to the specified slice from the
131     given input value.
132 jgs 121 NB: This will throw an exception as obviously an empty Data object contains no
133     data to slice to. An implementation is required by parent DataAbstract class.
134 jgs 82 \param value Input - Data to copy from
135     \param region Input - Region to copy.
136     */
137 woo409 757 ESCRIPT_DLL_API
138 jgs 102 virtual
139     void
140     setSlice(const DataAbstract* value,
141 jfenwick 1796 const DataTypes::RegionType& region);
142 jgs 102
143 jfenwick 1803
144     void
145     dump(const std::string fileName) const;
146    
147 jgs 82 protected:
148    
149 jfenwick 1796 /**
150     \brief Provide access to underlying storage. Internal use only!
151     */
152     ESCRIPT_DLL_API
153     virtual DataTypes::ValueType&
154     getVector();
155    
156     ESCRIPT_DLL_API
157     virtual const DataTypes::ValueType&
158     getVector() const;
159    
160 jgs 82 private:
161 jgs 102
162 jfenwick 1796 // /**
163     /* \brief
164 jgs 121 Throw a standard exception. This function is called if an attempt
165 jfenwick 1796 is made to use functions of DataEmpty that are not valid.*/
166     // */
167     // void
168     // throwStandardException(const std::string& functionName) const;
169 jgs 121
170 jgs 82 };
171    
172     } // end of namespace
173 jgs 121
174 jgs 82 #endif

Properties

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

  ViewVC Help
Powered by ViewVC 1.1.26