ArrayContainer.h

Go to the documentation of this file.

/******************************************************************************
*
* Copyright Saab AB, 2006-2013 (http://safir.sourceforge.net)
* 
* Created by: Lars Hagström / stlrha
*
*******************************************************************************
*
* This file is part of Safir SDK Core.
*
* Safir SDK Core is free software: you can redistribute it and/or modify
* it under the terms of version 3 of the GNU General Public License as
* published by the Free Software Foundation.
*
* Safir SDK Core is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with Safir SDK Core.  If not, see <http://www.gnu.org/licenses/>.
*
******************************************************************************/

#ifndef __DOTS_ARRAY_CONTAINER_H__
#define __DOTS_ARRAY_CONTAINER_H__

#include <Safir/Dob/Typesystem/ValueContainers.h>
#include <Safir/Dob/Typesystem/ObjectContainer.h>
#include <Safir/Dob/Typesystem/Exceptions.h>

namespace Safir
{
namespace Dob
{
namespace Typesystem
{
    template <class T>
    class ArrayContainer : private std::vector<T>
    {
    private:
        typedef std::vector<T> Vector;
    public:

        explicit ArrayContainer(const Int32 size):
            std::vector<T>(size),
            m_size(size)
        {
            if (size <= 0)
            {
                throw IllegalValueException(L"Arrays must be at least one in length!",__WFILE__,__LINE__);
            }
        }

        ArrayContainer(const ArrayContainer & other):
            std::vector<T>(other),
            m_size(other.m_size)
        {

        }

        ArrayContainer & operator= (const ArrayContainer & other)
        {
            if (other.size() != size())
            {
                throw SoftwareViolationException(L"You are not allowed to copy arrays of different sizes",__WFILE__,__LINE__);
            }
            std::vector<T>::operator=(other);
            m_size = other.size();
            return *this;
        }

        //This may change to become a bidirectional iterator in the future (it is random access now)
        typedef typename Vector::iterator iterator;
        typedef typename Vector::const_iterator const_iterator;
        typedef typename Vector::reference reference;
        typedef typename Vector::const_reference const_reference;

        using Vector::begin;
        using Vector::end;

        Int32 size() const {return m_size;}

        reference operator[](const Int32 index)
        {
            if (index < 0 || index >= m_size)
            {
                throw IllegalValueException(L"Illegal array index!",__WFILE__,__LINE__);
            }
            return Vector::operator[](index);
        }

        const_reference operator[](const Int32 index) const
        {
            if (index < 0 || index >= m_size)
            {
                throw IllegalValueException(L"Illegal array index!",__WFILE__,__LINE__);
            }
            return Vector::operator[](index);
        }

        bool IsChanged() const
        {
            return end() != std::find_if(begin(),end(),&Typesystem::IsChanged);
        }

        void SetChanged(bool changed)
        {
            const_iterator e = end();
            for (iterator it = begin(); it!=e;++it)
            {
                it->SetChanged(changed);
            }
        }
    private:
        Int32 m_size;
    };


    typedef ArrayContainer<BooleanContainer> BooleanContainerArray;

    typedef ArrayContainer<Int32Container> Int32ContainerArray;

    typedef ArrayContainer<Int64Container> Int64ContainerArray;

    typedef ArrayContainer<Float32Container> Float32ContainerArray;

    typedef ArrayContainer<Float64Container> Float64ContainerArray;

    typedef ArrayContainer<TypeIdContainer> TypeIdContainerArray;

    typedef ArrayContainer<InstanceIdContainer> InstanceIdContainerArray;

    typedef ArrayContainer<EntityIdContainer> EntityIdContainerArray;

    typedef ArrayContainer<ChannelIdContainer> ChannelIdContainerArray;

    typedef ArrayContainer<HandlerIdContainer> HandlerIdContainerArray;

    typedef ArrayContainer<StringContainer> StringContainerArray;

    typedef Safir::Dob::Typesystem::ArrayContainer<ObjectContainer> ObjectContainerArray;

    typedef Safir::Dob::Typesystem::ArrayContainer<BinaryContainer> BinaryContainerArray;

    //--------------------------------------------------
    // SI-types (32-bits)
    //--------------------------------------------------
    namespace Si32
    {
        typedef ArrayContainer<AmpereContainer> AmpereContainerArray;

        typedef ArrayContainer<CubicMeterContainer> CubicMeterContainerArray;

        typedef ArrayContainer<HertzContainer> HertzContainerArray;

        typedef ArrayContainer<JouleContainer> JouleContainerArray;

        typedef ArrayContainer<KelvinContainer> KelvinContainerArray;

        typedef ArrayContainer<KilogramContainer> KilogramContainerArray;

        typedef ArrayContainer<MeterContainer> MeterContainerArray;

        typedef ArrayContainer<MeterPerSecondContainer> MeterPerSecondContainerArray;

        typedef ArrayContainer<MeterPerSecondSquaredContainer> MeterPerSecondSquaredContainerArray;

        typedef ArrayContainer<NewtonContainer> NewtonContainerArray;

        typedef ArrayContainer<PascalContainer> PascalContainerArray;

        typedef ArrayContainer<RadianContainer> RadianContainerArray;

        typedef ArrayContainer<RadianPerSecondContainer> RadianPerSecondContainerArray;

        typedef ArrayContainer<RadianPerSecondSquaredContainer> RadianPerSecondSquaredContainerArray;

        typedef ArrayContainer<SecondContainer> SecondContainerArray;

        typedef ArrayContainer<SquareMeterContainer> SquareMeterContainerArray;

        typedef ArrayContainer<SteradianContainer> SteradianContainerArray;

        typedef ArrayContainer<VoltContainer> VoltContainerArray;

        typedef ArrayContainer<WattContainer> WattContainerArray;
    }

    //--------------------------------------------------
    // SI-types (64-bits)
    //--------------------------------------------------
    namespace Si64
    {
        typedef ArrayContainer<AmpereContainer> AmpereContainerArray;

        typedef ArrayContainer<CubicMeterContainer> CubicMeterContainerArray;

        typedef ArrayContainer<HertzContainer> HertzContainerArray;

        typedef ArrayContainer<JouleContainer> JouleContainerArray;

        typedef ArrayContainer<KelvinContainer> KelvinContainerArray;

        typedef ArrayContainer<KilogramContainer> KilogramContainerArray;

        typedef ArrayContainer<MeterContainer> MeterContainerArray;

        typedef ArrayContainer<MeterPerSecondContainer> MeterPerSecondContainerArray;

        typedef ArrayContainer<MeterPerSecondSquaredContainer> MeterPerSecondSquaredContainerArray;

        typedef ArrayContainer<NewtonContainer> NewtonContainerArray;

        typedef ArrayContainer<PascalContainer> PascalContainerArray;

        typedef ArrayContainer<RadianContainer> RadianContainerArray;

        typedef ArrayContainer<RadianPerSecondContainer> RadianPerSecondContainerArray;

        typedef ArrayContainer<RadianPerSecondSquaredContainer> RadianPerSecondSquaredContainerArray;

        typedef ArrayContainer<SecondContainer> SecondContainerArray;

        typedef ArrayContainer<SquareMeterContainer> SquareMeterContainerArray;

        typedef ArrayContainer<SteradianContainer> SteradianContainerArray;

        typedef ArrayContainer<VoltContainer> VoltContainerArray;

        typedef ArrayContainer<WattContainer> WattContainerArray;
    }
}
}
}
#endif