EntityProxy.h

Go to the documentation of this file.

/******************************************************************************
*
* Copyright Saab AB, 2008-2013 (http://safir.sourceforge.net)
*
* Created by: Anders Widén / stawi
*
*******************************************************************************
*
* 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 _SAFIR_DOB_ENTITY_PROXY_H
#define _SAFIR_DOB_ENTITY_PROXY_H

#include <Safir/Dob/Internal/ProxyImplPtr.h>
#include <Safir/Dob/PreviousEntityProxy.h>
#include <Safir/Dob/DoseCppExportDefs.h>
#include <Safir/Dob/ConnectionInfo.h>
#include <Safir/Dob/Typesystem/EntityId.h>
#include <Safir/Dob/Typesystem/HandlerId.h>
#include <Safir/Dob/Typesystem/Defs.h>
#include <Safir/Dob/Entity.h>
#include <Safir/Dob/Defs.h>

#include <string>

namespace Safir
{
namespace Dob
{
    // Forward declaration
    namespace Internal
    {
        class EntityProxyImpl;
    }

    class DOSE_CPP_API EntityProxy
    {
    public:

        const Dob::Typesystem::TypeId GetTypeId() const;

        const Dob::Typesystem::InstanceId GetInstanceId() const;

        const Dob::Typesystem::EntityId GetEntityId() const;

        const Dob::EntityPtr GetEntity() const;

        const Dob::EntityPtr GetEntityWithChangeInfo() const;

        const Dob::Typesystem::HandlerId GetOwner() const;

        const Dob::ConnectionInfoPtr GetOwnerConnectionInfo() const;

        const char * GetBlob() const;

        const char * GetBlobWithChangeInfo() const;

        const Dob::PreviousEntityProxy GetPrevious() const;

        const Dob::Typesystem::HandlerId GetOwnerWithStringRepresentation() const;

        const Dob::Typesystem::Int64 GetTimestamp() const;

        const Dob::Typesystem::Int64 GetTimestamp(const Dob::Typesystem::MemberIndex member) const;

        // The constructor is for internal usage only!
        explicit EntityProxy(Internal::EntityProxyImpl* pImpl);

    private:

#ifdef _MSC_VER
#pragma warning (push)
#pragma warning (disable: 4251) // To get rid of warning that says that the template needs to have a DLL-interface
#endif

        Internal::ProxyImplPtr<Internal::EntityProxyImpl> m_pImpl;

#ifdef _MSC_VER
#pragma warning (pop)
#endif

    };

}
}

#endif