cvrResizeType.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   cvrResizeType.h
 *         Contains the enum eResizeType which provides global
 *         constants to control the behaviour of resize methods. The
 *         appropriate read and write functions are also defined.
 * \author Peter Doerfler
 * \date   29.11.2004
 * $Id: cvrResizeType.h,v 1.5 2007/04/18 21:13:40 alvarado Exp $
 */

#ifndef _CVR_RESIZE_TYPE_H_
#define _CVR_RESIZE_TYPE_H_

#include "cvrIoHandler.h"

namespace cvr {

  /**
   * The resize type defines the behaviour of resize member functions found in
   * many containers and other data structures. In most cases the default is
   * Copy, to be compliant with the STL.  Different functions: allocate() and
   * assign() are shortcuts for resize with OnlyAllocate or Init.
   *
   * For this type the methods read(ioHandler&, eResizeType&) and
   * write(ioHandler&, const eResizeType&) are implemented. Note
   * that template functions read(ioHandler&, const std::string&, T&)
   * and write(ioHandler&, const std::string&, const T&) exist. (see
   * Developer's Guide for further information).
   *
   * @ingroup gTypes
   */
  enum eResizeType {
    AllocateOnly, /**< Memory is allocated only, old values are not copied to
                       the new container and new fields are not initialized */
    Copy,         /**< Old values are copied to the resized container but
                       possibly existing new elements are not initialized */
    Init ,        /**< The resized container is completely filled with the
                       given init value.*/
    CopyAndInit   /**< The old data is copied to the resized container and new
                       elements (if existent) are initialized with the
                       init value*/
  };

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

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


}
#endif