Calculator.h

Go to the documentation of this file.

/***************************************************************************
 *
 * Copyright (C) 2009 Cassio Neri Moreira
 *
 * This file is part of the KeyValue library.
 *
 * The KeyValue library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License as published
 * by the Free Software Foundation, either version 3 of the License, or (at
 * your option) any later version.
 *
 * The KeyValue 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 General
 * Public License for more details.
 *
 * You should have received a copy of the GNU General Public License along
 * with KeyValue. If not, see <http://www.gnu.org/licenses/>.
 *
 * If you modify this library, or any covered work, by linking or combining
 * it with Excel (or a modified version of that program), containing parts
 * covered by the terms of End-User License Agreement for Microsoft
 * Software, the licensors of KeyValue grant you additional permission to
 * convey the resulting work.
 *
 **************************************************************************/

#ifndef KEYVALUE_MNGT_CALCULATOR_H_
#define KEYVALUE_MNGT_CALCULATOR_H_

// Includes many Calculator related header files for users' convenience.

#include "keyvalue/extern/Ptime.h"
#include "keyvalue/extern/SharedPtr.h"
#include "keyvalue/extern/String.h"
#include "keyvalue/mngt/Command.h"
#include "keyvalue/mngt/DataSet.h"
#include "keyvalue/mngt/Processor.h"
#include "keyvalue/mngt/ProcessorInstantiator.h"
#include "keyvalue/mngt/ProcessorMngr.h"
#include "keyvalue/sys/exception/Exception.h"
#include "keyvalue/util/Global.h"
#include "keyvalue/value/Result.h"
#include "keyvalue/value/Value.h"

namespace keyvalue {

#ifdef DOXYGEN
  template <typename Tag>
  class Calculator :

    public Processor {

  public:

    const char*
    getName() const;

    value::Result
    getResult(const DataSet& data) const;

    value::Value
    getValue(const DataSet& data) const;

  };
#endif

template <typename Tag>
class Calculator;

} // namespace keyvalue

#endif // KEYVALUE_MNGT_CALCULATOR_H_