ObjectContainer.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_OBJECT_CONTAINER_H__
#define __DOTS_OBJECT_CONTAINER_H__


#include <Safir/Dob/Typesystem/Defs.h>
#include <Safir/Dob/Typesystem/ContainerBase.h>
#include <Safir/Dob/Typesystem/Object.h>
#include <Safir/Dob/Typesystem/Exceptions.h>
#include <typeinfo>

namespace Safir
{
namespace Dob
{
namespace Typesystem
{
    class ObjectContainerBase: public ContainerBase
    {
    public:
        ObjectContainerBase():ContainerBase() {}

        virtual void SetPtr(const ObjectPtr & ptr) = 0;

        bool IsChangedHere() const {return m_bIsChanged;}

        void SetChangedHere(const bool changed) {m_bIsChanged = changed;}

        virtual       ContainerBase & GetMember(const int member, const int index)       = 0;

        virtual const ContainerBase & GetMember(const int member, const int index) const = 0;

        virtual const ObjectPtr GetObjectPointer() const = 0;

        virtual void SetObjectPointer(const ObjectPtr ptr) = 0;

        virtual void ResetObjectPointer() = 0;


    protected:
        ObjectContainerBase & operator=(const ObjectContainerBase & other)
        {ContainerBase::operator =(other); return *this;}
    };

    template <class T>
    class ObjectContainerImpl : public ObjectContainerBase
    {
    public:
        typedef boost::shared_ptr<T> T_Ptr;

        ObjectContainerImpl():ObjectContainerBase() {}

        ObjectContainerImpl(const ObjectContainerImpl & other):
            ObjectContainerBase(other) //make sure we use copy constructor of parent
        {
            if (!other.IsNull())
            {
                m_pObject = boost::dynamic_pointer_cast<T>(other.m_pObject->Clone());
                if (m_pObject == NULL)
                {
                    throw IncompatibleTypesException(L"The types are not compatible!",__WFILE__,__LINE__);
                }
            }
        }

        ObjectContainerImpl & operator=(const ObjectContainerImpl & other)
        {
            ObjectContainerBase::operator=(other);//make sure we use copy assignment of parent
            if (other.IsNull())
            {
                m_pObject.reset();
            }
            else
            {
                m_pObject = boost::dynamic_pointer_cast<T>(other.m_pObject->Clone());
                if (m_pObject == NULL)
                {
                    throw IncompatibleTypesException(L"The types are not compatible!",__WFILE__,__LINE__);
                }
            }
            return *this;
        }

        void SetPtr(const T_Ptr & ptr)
        {
            m_bIsChanged = true;
            m_pObject = ptr;
        }

        //implementation of pure virtual method.
        virtual void SetPtr(const ObjectPtr & ptr)
        {
            m_bIsChanged = true;
            m_pObject = boost::dynamic_pointer_cast<T>(ptr);
            if (m_pObject == NULL)
            {
                throw IncompatibleTypesException(L"The types are not compatible!",__WFILE__,__LINE__);
            }
        }

        const T_Ptr & GetPtr() const {if (IsNull()) throw NullException(L"Object is null",__WFILE__,__LINE__); return m_pObject;}

        T * const operator->() const
        { if (IsNull()) throw NullException(L"Object is null",__WFILE__,__LINE__); return m_pObject.operator->(); }


        //Override of inherited method. Parent comment describes this behaviour too..
        virtual void SetChanged(const bool changed) {m_bIsChanged = changed; if (!IsNull()) m_pObject->SetChanged(changed);}

        //Override of inherited method. Parent comment describes this behaviour too..
        virtual bool IsChanged() const {return m_bIsChanged || (!IsNull() && m_pObject->IsChanged());}

        //override of pure virtual method
        virtual bool IsNull() const {return m_pObject == NULL;}

        //override of pure virtual method
        virtual void SetNull()
        {
            m_bIsChanged = true;
            m_pObject.reset();
        }

        //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__);
                }
                const ObjectContainerImpl<T> & castedThat = static_cast<const ObjectContainerImpl<T> &>(that);
                m_bIsChanged = castedThat.m_bIsChanged;
                if (that.IsNull())
                {
                    m_pObject.reset();
                }
                else
                {
                    SetObjectPointer(castedThat.m_pObject->Clone());
                }
            }
        }
        //Reflection part (Don't use unless you really know what you're doing!!)
        //Comments are in ObjectContainerBase.
        virtual       ContainerBase & GetMember(const int member, const int index)
        {if (IsNull()) throw NullException(L"Object is null",__WFILE__,__LINE__); return m_pObject->GetMember(member,index);}
        virtual const ContainerBase & GetMember(const int member, const int index) const
        {if (IsNull()) throw NullException(L"Object is null",__WFILE__,__LINE__); return m_pObject->GetMember(member,index);}


        Int32 CalculateBlobSize() const {if (IsNull()) return 0; else return m_pObject->CalculateBlobSize();}

        virtual const ObjectPtr GetObjectPointer() const {return boost::static_pointer_cast<Object>(m_pObject);}
        virtual void SetObjectPointer(const ObjectPtr ptr)
        {
#ifndef NDEBUG
            m_pObject = boost::dynamic_pointer_cast<T>(ptr);
            if(m_pObject == NULL)
            {
                throw SoftwareViolationException(L"Failed to cast object pointer to expected type",__WFILE__,__LINE__);
            }
#else
            m_pObject = boost::static_pointer_cast<T>(ptr);
#endif
        }
        virtual void ResetObjectPointer(){m_pObject.reset();}
    private:

        T_Ptr m_pObject;
    };

    template <>
    class ObjectContainerImpl<Object> : public ObjectContainerBase
    {
    public:
        typedef boost::shared_ptr<Object> T_Ptr;

        ObjectContainerImpl():ObjectContainerBase() {}


        ObjectContainerImpl(const ObjectContainerImpl & other):
            ObjectContainerBase(other) //make sure we use copy constructor of parent
        {
            if (!other.IsNull())
            {
                m_pObject = other.m_pObject->Clone();
            }
        }

        ObjectContainerImpl & operator=(const ObjectContainerImpl & other)
        {
            ObjectContainerBase::operator =(other);//make sure we use copy assignment of parent
            if (other.IsNull())
            {
                m_pObject.reset();
            }
            else
            {
                m_pObject = other.m_pObject->Clone();
            }
            return *this;
        }


        //implementation of pure virtual method.
        virtual void SetPtr(const ObjectPtr & ptr)
        {
            m_bIsChanged = true;
            m_pObject = ptr;
        }

        const T_Ptr & GetPtr() const {if (IsNull()) throw NullException(L"Object is null",__WFILE__,__LINE__); return m_pObject;}

        Object * const operator->() const
        {
            if (IsNull()) throw NullException(L"Object is null",__WFILE__,__LINE__); return m_pObject.operator->();
        }

        //Override of inherited method. Parent comment describes this behaviour too..
        virtual void SetChanged(const bool changed) {m_bIsChanged = changed; if (!IsNull()) m_pObject->SetChanged(changed);}

        //Override of inherited method. Parent comment describes this behaviour too..
        virtual bool IsChanged() const {return m_bIsChanged || (!IsNull() && m_pObject->IsChanged());}

        //override of pure virtual method
        virtual bool IsNull() const {return m_pObject == NULL;}

        //override of pure virtual method
        virtual void SetNull()
        {
            m_bIsChanged = true;
            m_pObject.reset();
        }

        //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__);
                }
                const ObjectContainerImpl<Object> & castedThat = static_cast<const ObjectContainerImpl<Object> &>(that);
                m_bIsChanged = castedThat.m_bIsChanged;
                if (that.IsNull())
                {
                    m_pObject.reset();
                }
                else
                {
                    SetObjectPointer(castedThat.m_pObject->Clone());
                }
            }
        }

        //Reflection part (Don't use unless you really know what you're doing!!)
        //Comments are in ObjectContainerBase.
        virtual       ContainerBase & GetMember(const int member, const int index)
        {if (IsNull()) throw NullException(L"Object is null",__WFILE__,__LINE__); return m_pObject->GetMember(member,index);}
        virtual const ContainerBase & GetMember(const int member, const int index) const
        {if (IsNull()) throw NullException(L"Object is null",__WFILE__,__LINE__); return m_pObject->GetMember(member,index);}

        Int32 CalculateBlobSize() const {if (IsNull()) return 0; else return m_pObject->CalculateBlobSize();}

    private:
        virtual const ObjectPtr GetObjectPointer() const {return boost::static_pointer_cast<Object>(m_pObject);}
        virtual void SetObjectPointer(const ObjectPtr ptr)
        {
            m_pObject = ptr;
        }
        virtual void ResetObjectPointer(){m_pObject.reset();}


        T_Ptr m_pObject;
    };

    typedef Safir::Dob::Typesystem::ObjectContainerImpl<Object> ObjectContainer;
}
}
}
#endif