Loading...
Searching...
No Matches
FunctionMarshallable.h
Go to the documentation of this file.
//# FunctionMarshallable.h: a class for serializing/reconstituting Function objects to/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_FUNCTIONMARSHALLABLE_H
#define SCIMATH_FUNCTIONMARSHALLABLE_H
#include <casacore/casa/aips.h>
#include <casacore/scimath/Functionals/Function.h>
#include <casacore/scimath/Functionals/FunctionFactoryErrors.h>
#include <casacore/scimath/Functionals/SerialHelper.h>
namespace casacore { //# NAMESPACE CASACORE - BEGIN
// <summary>
// a class for serializing/reconstituting Function objects to/from Records
// </summary>
// <use visibility=export>
// <reviewed reviewer="" date="yyyy/mm/dd" tests="" demos="">
// </reviewed>
// <prerequisite>
// <li> FunctionFactory
// <li> Function
// </prerequisite>
//
// <etymology>
// Marshalling (a.k.a. serialization) is the process of converting the
// state of an object into a transmitable form so that an another object with
// identical state can be created in another execution context. This class
// defines an interface for marshalling Functions.
// </etymology>
//
// <synopsis>
//
//
//
//
// </synopsis>
//
// <example>
//
//
//
// </example>
//
// <motivation>
//
//
//
// </motivation>
//
// <thrown>
// </thrown>
//
// <todo asof="yyyy/mm/dd">
// </todo>
class FunctionMarshallable {
public:
// create a FunctionMarshallable. <em>functype</em> is the name that
// store() will load into the Record's <tt>functype</tt> field.
FunctionMarshallable(const String& functype) : ftype(functype) {}
FunctionMarshallable(const FunctionMarshallable& other) : ftype() {
ftype = other.ftype;
}
virtual ~FunctionMarshallable() {}
// store the state of this Function into a Record
// <thrown>
// <li> InvalidSerializationError if an error during serialization
// </thrown>
virtual void store(Record& gr) const = 0;
virtual FunctionMarshallable&
operator=(const FunctionMarshallable& other)
{
ftype = other.ftype;
return *this;
}
// return the name representing the Function type that will be placed
// in the <tt>functype</tt> field of Record passed to store().
const String& getFuncType() const { return ftype; }
// load functype field into the given Record
void loadFuncType(Record& gr) const {
gr.define(SerialHelper::FUNCTYPE.c_str(), ftype.c_str());
}
private:
FunctionMarshallable() : ftype() {}
String ftype;
};
} //# NAMESPACE CASACORE - END
#endif
casacore::FunctionMarshallable::ftype
String ftype
Definition FunctionMarshallable.h:118
casacore::FunctionMarshallable::FunctionMarshallable
FunctionMarshallable()
Definition FunctionMarshallable.h:116
casacore::FunctionMarshallable::getFuncType
const String & getFuncType() const
return the name representing the Function type that will be placed in the functype field of Record pa...
Definition FunctionMarshallable.h:108
casacore::FunctionMarshallable::loadFuncType
void loadFuncType(Record &gr) const
load functype field into the given Record
Definition FunctionMarshallable.h:111
casacore::FunctionMarshallable::FunctionMarshallable
FunctionMarshallable(const FunctionMarshallable &other)
Definition FunctionMarshallable.h:88
casacore::FunctionMarshallable::operator=
virtual FunctionMarshallable & operator=(const FunctionMarshallable &other)
Definition FunctionMarshallable.h:100
casacore::FunctionMarshallable::~FunctionMarshallable
virtual ~FunctionMarshallable()
Definition FunctionMarshallable.h:91
casacore::FunctionMarshallable::store
virtual void store(Record &gr) const =0
store the state of this Function into a Record
casacore::FunctionMarshallable::FunctionMarshallable
FunctionMarshallable(const String &functype)
create a FunctionMarshallable.
Definition FunctionMarshallable.h:87
casacore::SerialHelper::FUNCTYPE
static const String FUNCTYPE
Definition SerialHelper.h:99
casacore::String
String: the storage and methods of handling collections of characters.
Definition String.h:223
casacore::Record
Record()
casacore
this file contains all the compiler specific defines
Definition mainpage.dox:28