cvrDataRepresentationType.h

Go to the documentation of this file.

/*
 * Copyright (C) 1998-2004
 * Lehrstuhl fuer Technische Informatik, RWTH-Aachen, Germany
 *
 *
 * 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   cvrDataRepresentationType.h
 *         Contains the enum eDataRepresentationType.
 * \author Jochen Wickel
 * \author Peter Doerfler
 * \date   25.09.2000
 *
 * $Id: cvrDataRepresentationType.h,v 1.1 2005/07/19 18:23:25 gquiros Exp $
 */

#ifndef _CVR_DATA_REPRESENTATION_TYPE_H_
#define _CVR_DATA_REPRESENTATION_TYPE_H_

#include "cvrIoHandler.h"

namespace cvr {

  /**
   * Determines how a data sample is represented when a matrix is
   * given. In the CVR-Lib a row in a matrix usually corresponds to
   * a data sample or point. Choose Rows for this
   * behaviour. However, you can also choose Columns for the
   * opposite.
   */
  enum eDataRepresentationType {
    Rows,   /**< Data samples are in each row of a matrix */
    Columns /**< Data samples are in each column of a matrix */
  };

  /**
   * read function for eDataRepresentationType.
   *
   * @ingroup gStorable
   */
  bool read(ioHandler& handler,eDataRepresentationType& data);

  /**
   * write function for eDataRepresentationType.
   *
   * @ingroup gStorable
   */
  bool write(ioHandler& handler,const eDataRepresentationType& data);

}

#endif