cvrGenericChannel.h

Go to the documentation of this file.

/*
 * Copyright (C) 2007
 * ITCR, Pablo Alvarado
 *
 *
 * This file is part of the Computer Vision and Robotics Library (CVR-Lib)
 *
 * The CVR-Lib is free software; you can redistribute it and/or
 * modify it under the terms of the BSD License.
 *
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright notice,
 *    this list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright notice,
 *    this list of conditions and the following disclaimer in the documentation
 *    and/or other materials provided with the distribution.
 *
 * 3. Neither the name of the authors nor the names of its contributors may be
 *    used to endorse or promote products derived from this software without
 *    specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */


/**
 * \file   cvrGenericChannel.h
 *         Definition of a meta-programming type which provides the channel
 *         corresponding to a specific type
 *
 * \author Pablo Alvarado
 * \date   23.09.2007
 *
 * revisions ..: $Id: cvrGenericChannel.h,v 1.1 2007/10/14 02:45:37 alvarado Exp $
 */

#ifndef _CVR_GENERIC_CHANNEL_H_
#define _CVR_GENERIC_CHANNEL_H_

#include "cvrChannel.h"
#include "cvrChannel8.h"
#include "cvrChannel32.h"
#include "cvrChannelC.h"

namespace cvr {

  /**
   * Class genericChannel
   *
   * This is a meta-programming class that allows to obtain the corresponding
   * channel from the type of the contained elements.  Thus:
   *
   * - cvr::genericChannel<ubyte>::type equals cvr::channel8
   * - cvr::genericChannel<float>::type equals cvr::channel
   * - cvr::genericChannel<int32>::type equals cvr::channel32
   * - cvr::genericChannel<cvr::fcomplex>::type equals cvr::channelC
   *
   * Other types will produce a compiler error.
   *
   * \ingroup gInterfaces
   */
  template<typename T>
  class genericChannel {
    // the default implementation does not have an internal type, so that
    // the compiler will generate an error.
  };

  template<>
  class genericChannel<ubyte> {
  public:
    typedef channel8 type;
  };

  template<>
  class genericChannel<float> {
  public:
    typedef channel type;
  };

  template<>
  class genericChannel<int32> {
  public:
    typedef channel32 type;
  };

  template<>
  class genericChannel< complex<float> > {
  public:
    typedef channelC type;
  };

}

#endif