libs/evoral/evoral/TimeConverter.hpp

   1 /* This file is part of Evoral.
   2  * Copyright (C) 2009 Dave Robillard <http://drobilla.net>
   3  * Copyright (C) 2009 Paul Davis
   4  *
   5  * Evoral is free software; you can redistribute it and/or modify it under the
   6  * terms of the GNU General Public License as published by the Free Software
   7  * Foundation; either version 2 of the License, or (at your option) any later
   8  * version.
   9  *
  10  * Evoral is distributed in the hope that it will be useful, but WITHOUT ANY
  11  * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
  12  * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for details.
  13  *
  14  * You should have received a copy of the GNU General Public License along
  15  * with this program; if not, write to the Free Software Foundation, Inc.,
  16  * 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
  17  */
  18
  19 #ifndef EVORAL_TIME_CONVERTER_HPP
  20 #define EVORAL_TIME_CONVERTER_HPP
  21
  22 namespace Evoral {
  23
  24 /** A bidirectional converter between two different time units.
  25  *
  26  * Think of the conversion method names as if they are written in-between
  27  * the two template parameters (i.e. "A <name> B").
  28  */
  29 template<typename A, typename B>
  30 class TimeConverter {
  31 public:
  32         virtual ~TimeConverter() {}
  33
  34         /** Convert A time to B time (A to B) */
  35         virtual B to(A a) const = 0;
  36
  37         /** Convert B time to A time (A from B) */
  38         virtual A from(B b) const = 0;
  39 };
  40
  41 } // namespace Evoral
  42
  43 #endif // EVORAL_TIME_CONVERTER_HPP