/[escript]/trunk/esys2/escript/inc/esys/DataFactory.h
ViewVC logotype

Contents of /trunk/esys2/escript/inc/esys/DataFactory.h

Parent Directory Parent Directory | Revision Log Revision Log


Revision 82 - (show annotations)
Tue Oct 26 06:53:54 2004 UTC (15 years, 11 months ago) by jgs
File MIME type: text/plain
File size: 2180 byte(s)
Initial revision

1 /*=============================================================================
2
3 ******************************************************************************
4 * *
5 * COPYRIGHT ??????? - All Rights Reserved *
6 * *
7 * This software is the property of ??????????????. No part of this code *
8 * may be copied in any form or by any means without the expressed written *
9 * consent of ???????????. Copying, use or modification of this software *
10 * by any unauthorised person is illegal unless that *
11 * person has a software license agreement with ?????????????. *
12 * *
13 ******************************************************************************
14
15 *********************************************************************************/
16
17 #ifndef DATAFACTORY_H
18 #define DATAFACTORY_H
19
20 #include <string>
21 #include <Python.h>
22 #include <boost/python/object.hpp>
23 #include <boost/python/list.hpp>
24 #include <boost/python/numeric.hpp>
25 #include "esys/DataAbstract.h"
26 /**
27 @memo
28 Data
29
30 @version 1.0.0
31
32 @doc
33
34 Class Description:
35 DataFactory is a class which can not be instantiated. It is simply
36 a holder for various static factory methods that create Data objects.
37
38 Class Limitations:
39 None
40
41 Class Conditions of Use:
42 None
43
44 Throws:
45 None
46
47 */
48 class DataFactory {
49 public:
50 /**
51 @memo
52 Factory method which creates a Data object with only a constant value
53
54 @param constValue Input - The constant value
55 */
56 static DataAbstract* createData(double constValue);
57 /**
58 @memo
59 Factory method which copies data from a python numarray.
60
61 @param data Input - The input data.
62 */
63 static DataAbstract* createData(const boost::python::numeric::array& data);
64
65 private:
66 /**
67 @memo
68 Don't allow construction.
69
70 @param exceptionReason Input - Exception message.
71 */
72 DataFactory();
73
74 };
75
76 #endif
77
78
79
80
81
82

Properties

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

  ViewVC Help
Powered by ViewVC 1.1.26