File: dVACEngine.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 (170 lines) | stat: -rw-r--r-- 5,520 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
158
159
160
161
162
163
164
165
166
167
168
169
170
//# dVACEngine.h: Example virtual column engine to handle data type A
//# Copyright (C) 1994,1995,1996,2001
//# 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 TABLES_DVACENGINE_H
#define TABLES_DVACENGINE_H


//# Includes
#include <casacore/tables/DataMan/VACEngine.h>
#include <casacore/tables/Tables/ArrayColumn.h>


#include <casacore/casa/namespace.h>
class VACExample
{
public:
    VACExample(): x_p(0), y_p(0) {}
    VACExample(Int x, float y, const String& z) : x_p(x), y_p(y), z_p(z) {}
    static String dataTypeId()
	{ return "VACExample"; }
    Int x() const
	{ return x_p; }
    float y() const
	{ return y_p; }
  
    const String& z() const
	{ return z_p; }
    Int& x()
	{ return x_p; }
    float& y()
	{ return y_p; }
    String& z()
	{ return z_p; }
    int operator== (const VACExample& that) const
	{ return x_p==that.x_p && y_p==that.y_p && z_p==that.z_p; }
    int operator< (const VACExample& that) const
	{ return x_p<that.x_p || (x_p==that.x_p && y_p<that.y_p) ||
            (x_p==that.x_p && y_p==that.y_p && z_p<that.z_p); }
private:
    Int    x_p;
    float  y_p;
    String z_p;
};


// <summary>
// Example virtual column engine to handle data type VACExample
// </summary>

// <use visibility=export>

// <reviewed reviewer="GvD" date="2004/07/09" tests="">

// <prerequisite>
//# Classes you should understand before using this one.
//   <li> VirtualColumnEngine
//   <li> VirtualArrayColumn
// </prerequisite>

// <synopsis> 
// VACExampleVACEngine is an example showing how to use the templated
// class VACEngine to handle table data with an arbitrary type.
// Data of columns with the standard data types can directly be
// stored using a storage manager, but data of column with non-standard
// types have to be stored in another way.
//
// The normal way of doing this is to split the object of the non-standard
// type into its elementary types.
// This eample uses the class VACExample as the data type to be handled.
// It consists of 2 data fields, which will transparently be stored in
// 2 separate columns.
// </synopsis> 


class VACExampleVACEngine : public VACEngine<VACExample>
{
public:

    // The default constructor is required for reconstruction of the
    // engine when a table is read back.
    // It is also used to construct an engine, which does not check
    // the source column name.
    VACExampleVACEngine();

    // Construct the engine for the given source column and storing
    // the result in the given target columns for the data members
    // x and y of class VACExample.
    VACExampleVACEngine (const String& sourceColumnName,
			 const String& xTargetColumnName,
			 const String& yTargetColumnname,
			 const String& zTargetColumnname);

    // Destructor is mandatory.
    virtual ~VACExampleVACEngine();

    // Assignment is not needed and therefore forbidden.
    VACExampleVACEngine& operator= (const VACExampleVACEngine&) = delete;

    // Clone the object.
    DataManager* clone() const;

    // Store the target column names in the source column keywords.
    virtual void create64 (rownr_t);

    // Prepare the engine by allocating column objects
    // for the target columns.
    virtual void prepare();

    virtual void setShape (rownr_t rownr, const IPosition& shape);
    virtual Bool isShapeDefined (rownr_t rownr);
    virtual IPosition shape (rownr_t rownr);

    // Get the data from a row.
    virtual void getArray (rownr_t rownr, Array<VACExample>& value);

    // Put the data in a row.
    virtual void putArray (rownr_t rownr, const Array<VACExample>& value);

    // Register the class name and the static makeObject "constructor".
    // This will make the engine known to the table system.
    static void registerClass();

private:
    // Copy constructor is only used by clone().
    // (so it is made private).
    VACExampleVACEngine (const VACExampleVACEngine&);


    // The target column names.
    String xTargetName_p;
    String yTargetName_p;
    String zTargetName_p;
    // Objects for the target columns.
    ArrayColumn<Int>    colx;
    ArrayColumn<float>  coly;
    ArrayColumn<String> colz;

public:
    //*display 4
    // Define the "constructor" to construct this engine when a
    // table is read back.
    // This "constructor" has to be registered by the user of the engine.
    static DataManager* makeObject (const String& dataManagerName,
				    const Record& spec);
};


#endif