vctDynamicConstVectorRef.h

Go to the documentation of this file.

/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-    */
/* ex: set filetype=cpp softtabstop=4 shiftwidth=4 tabstop=4 cindent expandtab: */

/*

  Author(s):    Ofri Sadowsky, Anton Deguet
  Created on: 2004-07-01

  (C) Copyright 2004-2007 Johns Hopkins University (JHU), All Rights
  Reserved.

--- begin cisst license - do not edit ---

This software is provided "as is" under an open source license, with
no warranty.  The complete license can be found in license.txt and
http://www.cisst.org/cisst/license.txt.

--- end cisst license ---
*/

#pragma once
#ifndef _vctDynamicConstVectorRef_h
#define _vctDynamicConstVectorRef_h

#include <cisstVector/vctDynamicConstVectorBase.h>
#include <cisstVector/vctDynamicVectorRefOwner.h>

template <class _elementType>
class vctDynamicConstVectorRef :
    public vctDynamicConstVectorBase<vctDynamicVectorRefOwner<_elementType>, _elementType>
{
public:
    VCT_CONTAINER_TRAITS_TYPEDEFS(_elementType);
    typedef vctDynamicConstVectorRef<value_type> ThisType;
    typedef vctDynamicVectorRefOwner<value_type> VectorOwnerType;
    typedef vctDynamicConstVectorBase<vctDynamicVectorRefOwner<value_type>, _elementType> BaseType;
    typedef typename BaseType::CopyType CopyType;
    typedef typename VectorOwnerType::iterator iterator;
    typedef typename VectorOwnerType::const_iterator const_iterator;
    typedef typename VectorOwnerType::reverse_iterator reverse_iterator;
    typedef typename VectorOwnerType::const_reverse_iterator const_reverse_iterator;

    vctDynamicConstVectorRef()
    {}

    vctDynamicConstVectorRef(const ThisType & other):
        BaseType()
    {
        SetRef(other.size(), other.Pointer(), other.stride());
    }

    vctDynamicConstVectorRef(size_type size, pointer data, stride_type stride = 1) {
        SetRef(size, data, stride);
    }

    vctDynamicConstVectorRef(size_type size, const_pointer data, stride_type stride = 1) {
        SetRef(size, data, stride);
    }

    template <size_type __size, stride_type __stride, class __dataPtrType>
    vctDynamicConstVectorRef(const vctFixedSizeConstVectorBase<__size, __stride, _elementType, __dataPtrType> & otherVector)
    {
        SetRef(otherVector);
    }

    template <size_type __size, stride_type __stride, class __dataPtrType>
    vctDynamicConstVectorRef(const vctFixedSizeConstVectorBase<__size, __stride, _elementType, __dataPtrType> & otherVector,
                             size_type startPosition, size_type length)
    {
        SetRef(otherVector, startPosition, length);
    }

    template <class __vectorOwnerType>
    vctDynamicConstVectorRef(const vctDynamicConstVectorBase<__vectorOwnerType, _elementType> & otherVector)
    {
        SetRef(otherVector);
    }

    template <class __vectorOwnerType>
    vctDynamicConstVectorRef(const vctDynamicConstVectorBase<__vectorOwnerType, _elementType> & otherVector,
                             size_type startPosition, size_type length)
    {
        SetRef(otherVector, startPosition, length);
    }

    void SetRef(size_type size, const_pointer p, stride_type stride = 1) {
        this->Vector.SetRef(size, const_cast<pointer>(p), stride);
    }

    template <size_type __size, stride_type __stride, class __dataPtrType>
    void SetRef(const vctFixedSizeConstVectorBase<__size, __stride, _elementType, __dataPtrType> & otherVector)
    {
        SetRef(otherVector.size(), otherVector.Pointer(), otherVector.stride());
    }

    template <size_type __size, stride_type __stride, class __dataPtrType>
    void SetRef(const vctFixedSizeConstVectorBase<__size, __stride, _elementType, __dataPtrType> & otherVector,
                size_type startPosition, size_type length) throw(std::out_of_range)
    {
        if (startPosition + length > otherVector.size()) {
            cmnThrow(std::out_of_range("vctDynamicConstVectorRef SetRef out of range"));
        }
        SetRef(length, otherVector.Pointer(startPosition), otherVector.stride());
    }

    template <class __vectorOwnerType>
    void SetRef(const vctDynamicConstVectorBase<__vectorOwnerType, _elementType> & otherVector)
    {
        SetRef(otherVector.size(), otherVector.Pointer(), otherVector.stride());
    }

    template <class __vectorOwnerType>
    void SetRef(const vctDynamicConstVectorBase<__vectorOwnerType, _elementType> & otherVector,
                size_type startPosition, size_type length) throw(std::out_of_range)
    {
        if (startPosition + length > otherVector.size()) {
            cmnThrow(std::out_of_range("vctDynamicConstVectorRef SetRef out of range"));
        }
        SetRef(length, otherVector.Pointer(startPosition), otherVector.stride());
    }

};


#endif // _vctDynamicConstVectorRef_h