ValueContainers.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_VALUE_CONTAINERS_H__
#define __DOTS_VALUE_CONTAINERS_H__

#include <Safir/Dob/Typesystem/Defs.h>
#include <vector>

#include <Safir/Dob/Typesystem/ContainerBase.h>
#include <Safir/Dob/Typesystem/Exceptions.h>
#include <Safir/Dob/Typesystem/EntityId.h>
#include <Safir/Dob/Typesystem/Utilities.h>
#include <Safir/Dob/Typesystem/ChannelId.h>
#include <Safir/Dob/Typesystem/HandlerId.h>
#include <typeinfo>

namespace Safir
{
namespace Dob
{
namespace Typesystem
{
    template <class T>
    class  ValueContainer : public ContainerBase
    {
    public:
        typedef T ContainedType;

        ValueContainer():ContainerBase(),m_bIsNull(true), m_Value() {}

        void SetVal(const T value)  {m_Value = value; m_bIsNull = false; m_bIsChanged = true;}

        T GetVal() const    {if (m_bIsNull) throw NullException(L"value is null",__WFILE__,__LINE__); return m_Value;}

        //implementation of pure virtual in ContainerBase.
        virtual bool IsNull() const {return m_bIsNull;}

        //implementation of pure virtual in ContainerBase.
        virtual void SetNull()
        {
            m_bIsNull = true;
            m_bIsChanged = true;
        }

        //implementation of pure virtual in ContainerBase.
        virtual void Copy(const ContainerBase & that)
        {
            if (this != &that)
            {
                if (typeid(*this) != typeid(that))
                {
                    throw SoftwareViolationException(L"Invalid call to Copy, containers are not of same type",__WFILE__,__LINE__);
                }
                *this = static_cast<const ValueContainer<T> &>(that);
            }
        }

    private:
        friend class BlobOperations;

        bool m_bIsNull;
        T m_Value;
    };

    class StringContainer : public ContainerBase
    {
    public:
        typedef std::wstring ContainedType;

        StringContainer():ContainerBase(),m_bIsNull(true), m_Value(),m_CachedUtf8String() {}

        void SetVal(const std::wstring & value)  {m_Value = value; m_CachedUtf8String.clear(); m_bIsNull = false; m_bIsChanged = true;}

        const std::wstring & GetVal() const    {if (m_bIsNull) throw NullException(L"value is null",__WFILE__,__LINE__); return m_Value;}

        //implementation of pure virtual in ContainerBase.
        virtual bool IsNull() const {return m_bIsNull;}

        //implementation of pure virtual in ContainerBase.
        virtual void SetNull()
        {
            m_bIsNull = true;
            m_bIsChanged = true;
            m_CachedUtf8String.clear();
        }

        //implementation of pure virtual in ContainerBase.
        virtual void Copy(const ContainerBase & that)
        {
            if (this != &that)
            {
                if (typeid(*this) != typeid(that))
                {
                    throw SoftwareViolationException(L"Invalid call to Copy, containers are not of same type",__WFILE__,__LINE__);
                }
                *this = static_cast<const StringContainer &>(that);
            }
        }

        Int32 Utf8StringLength() const
        {
            if (IsNull())
            {
                return 0;
            }

            if (m_Value.empty())
            {
                return 1;
            }

            if (m_CachedUtf8String.empty())
            {
                m_CachedUtf8String = Utilities::ToUtf8(m_Value);
            }

            return static_cast<Int32>(m_CachedUtf8String.length() + 1);
        }

        const std::string & Utf8String() const
        {
            if (IsNull())
            {
                throw NullException(L"The string is null, cannot convert!",__WFILE__,__LINE__);
            }
            if (!m_Value.empty() && m_CachedUtf8String.empty())
            {
                m_CachedUtf8String = Utilities::ToUtf8(m_Value);
            }
            return m_CachedUtf8String;
        }

    private:
        friend class BlobOperations;

        bool m_bIsNull;
        std::wstring m_Value;
        mutable std::string m_CachedUtf8String;
    };

    class BinaryContainer : public ContainerBase
    {
    public:
        typedef Binary ContainedType;
        BinaryContainer():ContainerBase(),m_bIsNull(true), m_Value() {}

        const Binary& GetVal() const    {if (m_bIsNull) throw NullException(L"value is null",__WFILE__,__LINE__); return m_Value;}

        void SetVal(const Binary & value)  {m_Value = value; m_bIsNull = false; m_bIsChanged = true;}


        //implementation of pure virtual in ContainerBase.
        virtual bool IsNull() const {return m_bIsNull;}

        //implementation of pure virtual in ContainerBase.
        virtual void SetNull()
        {
            m_bIsNull = true;
            m_bIsChanged = true;
        }

        //implementation of pure virtual in ContainerBase.
        virtual void Copy(const ContainerBase & that)
        {
            if (this != &that)
            {
                if (typeid(*this) != typeid(that))
                {
                    throw SoftwareViolationException(L"Invalid call to Copy, containers are not of same type",__WFILE__,__LINE__);
                }
                *this = static_cast<const BinaryContainer &>(that);
            }
        }

    private:
        friend class BlobOperations;

        bool m_bIsNull;
        Binary m_Value;
    };

    typedef ValueContainer<bool> BooleanContainer;

    typedef ValueContainer<Int32> Int32Container;

    typedef ValueContainer<Int64> Int64Container;

    typedef ValueContainer<Float32> Float32Container;

    typedef ValueContainer<Float64> Float64Container;

    typedef ValueContainer<TypeId> TypeIdContainer;

    typedef ValueContainer<InstanceId> InstanceIdContainer;

    typedef ValueContainer<EntityId> EntityIdContainer;

    typedef ValueContainer<ChannelId> ChannelIdContainer;

    typedef ValueContainer<HandlerId> HandlerIdContainer;


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

        typedef ValueContainer<CubicMeter> CubicMeterContainer;

        typedef ValueContainer<Hertz> HertzContainer;

        typedef ValueContainer<Joule> JouleContainer;

        typedef ValueContainer<Kelvin> KelvinContainer;

        typedef ValueContainer<Kilogram> KilogramContainer;

        typedef ValueContainer<Meter> MeterContainer;

        typedef ValueContainer<MeterPerSecond> MeterPerSecondContainer;

        typedef ValueContainer<MeterPerSecondSquared> MeterPerSecondSquaredContainer;

        typedef ValueContainer<Newton> NewtonContainer;

        typedef ValueContainer<Pascal> PascalContainer;

        typedef ValueContainer<Radian> RadianContainer;

        typedef ValueContainer<RadianPerSecond> RadianPerSecondContainer;

        typedef ValueContainer<RadianPerSecondSquared> RadianPerSecondSquaredContainer;

        typedef ValueContainer<Second> SecondContainer;

        typedef ValueContainer<SquareMeter> SquareMeterContainer;

        typedef ValueContainer<Steradian> SteradianContainer;

        typedef ValueContainer<Volt> VoltContainer;

        typedef ValueContainer<Watt> WattContainer;
    }

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

        typedef ValueContainer<CubicMeter> CubicMeterContainer;

        typedef ValueContainer<Hertz> HertzContainer;

        typedef ValueContainer<Joule> JouleContainer;

        typedef ValueContainer<Kelvin> KelvinContainer;

        typedef ValueContainer<Kilogram> KilogramContainer;

        typedef ValueContainer<Meter> MeterContainer;

        typedef ValueContainer<MeterPerSecond> MeterPerSecondContainer;

        typedef ValueContainer<MeterPerSecondSquared> MeterPerSecondSquaredContainer;

        typedef ValueContainer<Newton> NewtonContainer;

        typedef ValueContainer<Pascal> PascalContainer;

        typedef ValueContainer<Radian> RadianContainer;

        typedef ValueContainer<RadianPerSecond> RadianPerSecondContainer;

        typedef ValueContainer<RadianPerSecondSquared> RadianPerSecondSquaredContainer;

        typedef ValueContainer<Second> SecondContainer;

        typedef ValueContainer<SquareMeter> SquareMeterContainer;

        typedef ValueContainer<Steradian> SteradianContainer;

        typedef ValueContainer<Volt> VoltContainer;

        typedef ValueContainer<Watt> WattContainer;
    }


}
}
}
#endif