cvrConstantReferenceType.h

Go to the documentation of this file.

/*
 * Copyright (C) 2006
 * Pablo Alvarado, Instituto Tecnológico de Costa Rica
 *
 *
 * 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   cvrConstantReferenceType.h
 *         Contains the enum eConstantReferece which provides global
 *         constants to control the behaviour of memory allocation. The
 *         appropriate read and write functions are also defined.
 * \author Pablo Alvarado
 * \date   09.09.2006
 * $Id: cvrConstantReferenceType.h,v 1.3 2007/04/18 21:13:40 alvarado Exp $
f */

#ifndef _CVR_CONSTANT_REFERENCE_H_
#define _CVR_CONSTANT_REFERENCE_H_

#include "cvrIoHandler.h"

namespace cvr {

  /**
   * The constant reference type is used to indicate if the memory allocated
   * by vectors, matrices and tensors can be modified or not.
   *
   * It is used to avoid that the subtensors (or vectors) of tensors (or
   * matrices) modified the memory they use, because it is allocated outside.
   *
   * @ingroup gTypes
   */
  enum eConstantReference {
    VariableReference, /**< Referece is allowed to be modified */
    ConstantReference  /**< Reference cannot be modified */
  };

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

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


}
#endif