cvrContainer.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   cvrContainer.h
 *         Contains the parent class to all container classes like vectors and
 *         matrices.
 * \author Pablo Alvarado
 * \date   01.04.1999
 *
 * $Id: cvrContainer.h,v 1.4 2005/07/12 16:37:30 gquiros Exp $
 */

#ifndef _CVR_CONTAINER_H_
#define _CVR_CONTAINER_H_

#include "cvrIoObject.h"

namespace cvr {

  /**
   * Abstract base class to all container classes
   *
   * Derived classes must provide:
   * - The name() method (from cvr::object)
   * - The clone() and newInstance() methods (from cvr::object)
   * - The read(ioHandler,const bool complete) method
   * - The write(ioHandler,const bool complete) const method
   *
   * It is highly recommended that the derived classes define the type
   * value_type.
   */
  class container : public ioObject {
  public:

    /**
     * Maximum allowed index
     */
    static const int MaxIndex = 0x7FFFFFFF;

    /**
     * Minimum allowed index
     */
    static const int MinIndex = -0x7FFFFFFF;

    /**
     * Clone method
     */
    container* clone() const = 0;

    /**
     * New instance
     */
    container* newInstance() const = 0;
  };
}

#endif