Checker.h

Go to the documentation of this file.

/***************************************************************************
 *
 * Copyright (C) 2009-2010 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_KEY_CHECKER_H_
#define KEYVALUE_KEY_CHECKER_H_

#include "keyvalue/value/Single.h"
#include "keyvalue/value/Vector.h"
#include "keyvalue/value/Matrix.h"

namespace keyvalue {
namespace key {

#if DOXYGEN
template <typename ConverterType,
  typename InputType = typename ConverterType::InputType_>
class Checker {};
#endif

template <typename ConverterType,
  typename InputType = typename ConverterType::InputType_>
class Checker;

template <typename ConverterType>
class Checker<ConverterType, value::Single> {

public:

  typedef typename ConverterType::OutputType_ OutputType_;

  void
  checkInput(const value::Single& input) const;

  void
  checkSoFar(const ConverterType& container) const;

  void
  checkOutput(const OutputType_& output) const;

private :

  virtual string
  getName() const = 0;

};

/*--------------------------------------------------------------------------
 * checkInput()
 *------------------------------------------------------------------------*/

template <typename ConverterType>
void
Checker<ConverterType, value::Single>::checkInput(const value::Single&
  /* input */) const {
}

/*--------------------------------------------------------------------------
 * checkSoFar()
 *------------------------------------------------------------------------*/

template <typename ConverterType>
void
Checker<ConverterType, value::Single>::checkSoFar(const ConverterType&
  /* container */) const {
}

/*--------------------------------------------------------------------------
 * checkOutput()
 *------------------------------------------------------------------------*/

template <typename ConverterType>
void
Checker<ConverterType, value::Single>::checkOutput(const OutputType_&
  /* output */) const {
}

template <typename ConverterType>
class Checker<ConverterType, value::Vector> {

public:

  typedef typename ConverterType::OutputType_ OutputType_;

  void
  checkInput(const value::Vector& input) const;

  void
  checkSoFar(const ConverterType& container) const;

  void
  checkOutput(const OutputType_& output) const;

private:

  virtual string
  getName() const = 0;

  virtual void
  checkSize(size_t size) const;

};

/*--------------------------------------------------------------------------
 * checkInput()
 *------------------------------------------------------------------------*/

template <typename ConverterType>
void
Checker<ConverterType, value::Vector>::checkInput(const value::Vector&
  input) const {
  this->checkSize(input.getSize());
}

/*--------------------------------------------------------------------------
 * checkSoFar()
 *------------------------------------------------------------------------*/

template <typename ConverterType>
void
Checker<ConverterType, value::Vector>::checkSoFar(const ConverterType&
  /* ConverterType */) const {
}

/*--------------------------------------------------------------------------
 * checkOutput()
 *------------------------------------------------------------------------*/

template <typename ConverterType>
void
Checker<ConverterType, value::Vector>::checkOutput(const OutputType_&
  /* output*/) const {
}

/*--------------------------------------------------------------------------
 * checkSize()
 *------------------------------------------------------------------------*/

template <typename ConverterType>
void
Checker<ConverterType, value::Vector>::checkSize(const size_t /* size */)
  const {
}

template <typename ConverterType>
class Checker<ConverterType, value::Matrix> {

public:

  typedef typename ConverterType::OutputType_ OutputType_;

  void
  checkInput(const value::Matrix& input) const;

  void
  checkSoFar(const ConverterType& container) const;

  void
  checkOutput(const OutputType_& output) const;

private:

  virtual string
  getName() const = 0;

  virtual void
  checkSize(size_t nRows, size_t nCols) const;

};

/*--------------------------------------------------------------------------
 * checkInput()
 *------------------------------------------------------------------------*/

template <typename ConverterType>
void
Checker<ConverterType, value::Matrix>::checkInput(const value::Matrix&
  input) const {
  this->checkSize(input.getNRows(), input.getNCols());
}

/*--------------------------------------------------------------------------
 * checkSoFar()
 *------------------------------------------------------------------------*/

template <typename ConverterType>
void
Checker<ConverterType, value::Matrix>::checkSoFar(const ConverterType&
  /* ConverterType */) const {
}

/*--------------------------------------------------------------------------
 * checkOutput()
 *------------------------------------------------------------------------*/

template <typename ConverterType>
void
Checker<ConverterType, value::Matrix>::checkOutput(const OutputType_&
  /* output*/) const {
}

/*--------------------------------------------------------------------------
 * checkSize()
 *------------------------------------------------------------------------*/

template <typename ConverterType>
void
Checker<ConverterType, value::Matrix>::checkSize(const size_t /* nRows */,
  const size_t /* nCols */) const {
}

} // namespace key
} // namespace keyvalue

#endif // KEYVALUE_KEY_CHECKER_H_