File: EclecticFunctionFactory.h

package info (click to toggle)
casacore 3.8.0-3
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 51,912 kB
  • sloc: cpp: 471,569; fortran: 16,372; ansic: 7,416; yacc: 4,714; lex: 2,346; sh: 1,865; python: 629; perl: 531; sed: 499; csh: 201; makefile: 32
file content (157 lines) | stat: -rw-r--r-- 4,623 bytes parent folder | download | duplicates (2)
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
//# EclecticFunctionFactory.cc: a class for creating various Function objects from Records
//# Copyright (C) 2002
//# Associated Universities, Inc. Washington DC, USA.
//#
//# This library is free software; you can redistribute it and/or modify it
//# under the terms of the GNU Library General Public License as published by
//# the Free Software Foundation; either version 2 of the License, or (at your
//# option) any later version.
//#
//# This library is distributed in the hope that it will be useful, but WITHOUT
//# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
//# FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Library General Public
//# License for more details.
//#
//# You should have received a copy of the GNU Library General Public License
//# along with this library; if not, write to the Free Software Foundation,
//# Inc., 675 Massachusetts Ave, Cambridge, MA 02139, USA.
//#
//# Correspondence concerning AIPS++ should be addressed as follows:
//#        Internet email: casa-feedback@nrao.edu.
//#        Postal address: AIPS++ Project Office
//#                        National Radio Astronomy Observatory
//#                        520 Edgemont Road
//#                        Charlottesville, VA 22903-2475 USA

#ifndef SCIMATH_ECLECTICFUNCTIONFACTORY_H
#define SCIMATH_ECLECTICFUNCTIONFACTORY_H

#include <casacore/casa/aips.h>
#include <casacore/scimath/Functionals/Function.h>
#include <casacore/casa/Containers/OrderedMap.h>
#include <casacore/casa/Containers/OrderedPair.h>
#include <casacore/casa/Exceptions/Error.h>
#include <casacore/scimath/Functionals/AbstractFunctionFactory.h>

namespace casacore { //# NAMESPACE CASACORE - BEGIN

//# Forward Declarations

class Record;

// <summary>
//
//
//
//
//
// </summary>

// <use visibility=export>

// <reviewed reviewer="" date="yyyy/mm/dd" tests="" demos="">
// </reviewed>

// <prerequisite>
//   <li> FunctionFactory
// </prerequisite>
//
// <etymology>
// This class is based on the Factory pattern, similar to the 
// ApplicationObjectFactory
// </etymology>
//
// <synopsis>
//
//
//
//
// </synopsis>
//
// <example>
//
//
//
// </example>
//
// <motivation>
//
//
//
// </motivation>
//
// <templating arg=T>
//    <li> Function must have a constructor for the form T(const Record&)
// </templating>
//
// <thrown>
//    <li> UnrecognizedFunctionError by create() if the Record field 
//         "functype" does not match a Function added via addFactory()
//    <li> InvalidSerializationError by create() if 
//         <ul>
//            <li> Record does not contain a "functype" field containing
//                 a string
//            <li> the associated specific factory throws an
//                 InvalidSerializationError
//         </ul>
// </thrown>
//
// <todo asof="yyyy/mm/dd">
//   <li> 
//   <li> 
//   <li> 
// </todo>

template<class T> 
class EclecticFunctionFactory : public FunctionFactory<T>
{
public:

    // create an empty EclecticFunctionFactory
    EclecticFunctionFactory();

    // create a shallow copy of another EclecticFunctionFactory
    EclecticFunctionFactory(const EclecticFunctionFactory& factory);

    // delete this EclecticFunctionFactory.  Those specific factories added
    // via addFactory() with <em>own=True</em> will be deleted.
    virtual ~EclecticFunctionFactory();

    // create the Function object described in the given Record.  This
    // implementation will use the value of the "functype" field to lookup
    // the specific factory to use to create the function.  That is, the 
    // the "functype" value will be matched against the type names loaded 
    // via addFactory().
    virtual Function<T> *create(const Record&) const
	throw(FunctionFactoryError);

    // add a factory for creating a specific type of function, associating
    // it with a given "functype" name.
    void addFactory(const String& type, FunctionFactory<T> *factory,
		    Bool own=True);

    // return the number of factories that have been loaded thus far.
    Int ndefined() { return lookup.ndefined(); }

    // return True if a factory with a given "functype" name has been 
    // loaded.
    Bool isDefined(const String& type) { return lookup.isDefined(type); }

    // a shallow assignment operator
    EclecticFunctionFactory& operator=(const EclecticFunctionFactory& factory);

protected:

private:
    OrderedMap<String, OrderedPair<FunctionFactory<T>*, Bool> > lookup;
};


} //# NAMESPACE CASACORE - END

#ifndef CASACORE_NO_AUTO_TEMPLATES
#include <casacore/scimath/Functionals/EclecticFunctionFactory.tcc>
#endif //# CASACORE_NO_AUTO_TEMPLATES
#endif