Safir SDK Core
Loading...
Searching...
No Matches
EntityProxy.h
Go to the documentation of this file.
1/******************************************************************************
2*
3* Copyright Saab AB, 2008-2013 (http://safirsdkcore.com)
4*
5* Created by: Anders Widén / stawi
6*
7*******************************************************************************
8*
9* This file is part of Safir SDK Core.
10*
11* Safir SDK Core is free software: you can redistribute it and/or modify
12* it under the terms of version 3 of the GNU General Public License as
13* published by the Free Software Foundation.
14*
15* Safir SDK Core is distributed in the hope that it will be useful,
16* but WITHOUT ANY WARRANTY; without even the implied warranty of
17* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18* GNU General Public License for more details.
19*
20* You should have received a copy of the GNU General Public License
21* along with Safir SDK Core. If not, see <http://www.gnu.org/licenses/>.
22*
23******************************************************************************/
24
25#ifndef _SAFIR_DOB_ENTITY_PROXY_H
26#define _SAFIR_DOB_ENTITY_PROXY_H
27
28#include <Safir/Dob/Internal/ProxyImplPtr.h>
35#include <Safir/Dob/Entity.h>
36#include <Safir/Dob/Defs.h>
37
38#include <string>
39
40namespace Safir
41{
42namespace Dob
43{
44 // Forward declaration
45 namespace Internal
46 {
47 class EntityProxyImpl;
48 }
49
54 {
55 public:
56
65
74
83
94
104
113
120
141 const char * GetBlob() const;
142
153 const char * GetBlobWithChangeInfo() const;
154
181
198
215
225
229 // The constructor is for internal usage only!
230 explicit EntityProxy(Internal::EntityProxyImpl* pImpl);
231
232 private:
233
234#ifdef _MSC_VER
235#pragma warning (push)
236#pragma warning (disable: 4251) // To get rid of warning that says that the template needs to have a DLL-interface
237#endif
238
239 Internal::ProxyImplPtr<Internal::EntityProxyImpl> m_pImpl;
240
241#ifdef _MSC_VER
242#pragma warning (pop)
243#endif
244
245 };
246
247}
248}
249
250#endif
#define DOSE_CPP_API
Definition DoseCppExportDefs.h:33
This namespace contains all the functionality and definitions of the SAFIR SDK.
Definition Backdoor.h:31
std::shared_ptr< ConnectionInfo > ConnectionInfoPtr
Definition ConnectionInfo.h:36
std::shared_ptr< Entity > EntityPtr
Definition Entity.h:34
DotsC_Int64 Int64
64 bit integer type.
Definition Defs.h:69
DotsC_TypeId TypeId
A unique type identifier.
Definition Defs.h:218
DotsC_MemberIndex MemberIndex
The index of a member in an object.
Definition Defs.h:237
Proxy class for an entity.
Definition EntityProxy.h:54
Dob::Typesystem::TypeId GetTypeId() const
Get type id.
Dob::Typesystem::Int64 GetTimestamp() const
Retrieves the timestamp for the latest create, update or delete.
EntityProxy(Internal::EntityProxyImpl *pImpl)
const Dob::Typesystem::EntityId GetEntityId() const
Get entity id.
Dob::Typesystem::Int64 GetTimestamp(const Dob::Typesystem::MemberIndex member) const
Retrieves the timestamp for the given top member.
const Dob::EntityPtr GetEntity() const
Get entity.
const Dob::Typesystem::HandlerId GetOwnerWithStringRepresentation() const
Get owner handler id that also contains the string representation.
const char * GetBlob() const
Get binary blob of the received entity without changeflags set.
const Dob::EntityPtr GetEntityWithChangeInfo() const
Get entity with change information.
const Dob::Typesystem::HandlerId GetOwner() const
Get owner handler id.
const Dob::Typesystem::InstanceId GetInstanceId() const
Get instance id.
const Dob::ConnectionInfoPtr GetOwnerConnectionInfo() const
Get info about the connection to which the owner handler is related.
const Dob::PreviousEntityProxy GetPrevious() const
Get previous entity state.
const char * GetBlobWithChangeInfo() const
Get binary blob with change information.
Proxy class for a "previous" entity.
Definition PreviousEntityProxy.h:53
Class containing the identity of an entity.
Definition EntityId.h:43
Class containing the identity of a handler.
Definition HandlerId.h:46
Class containing the identity of an instance.
Definition InstanceId.h:49