1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
|
// Cyphesis Online RPG Server and AI Engine
// Copyright (C) 2004 Alistair Riddoch
//
// This program is free software; you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation; either version 2 of the License, or
// (at your option) any later version.
//
// This program 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 this program; if not, write to the Free Software Foundation,
// Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
// $Id: Property.h,v 1.18 2007-12-24 00:06:20 alriddoch Exp $
#ifndef COMMON_PROPERTY_H
#define COMMON_PROPERTY_H
#include <Atlas/Message/Element.h>
#include <Atlas/Objects/ObjectsFwd.h>
#include <sigc++/trackable.h>
#include <sigc++/signal.h>
/// \brief Interface for Entity properties
///
/// \ingroup PropertyClasses
class PropertyBase {
protected:
/// \brief Flags indicating how this Property should be handled
const unsigned int m_flags;
explicit PropertyBase(unsigned int);
public:
virtual ~PropertyBase();
/// \brief Accessor for Property flags
unsigned int flags() const { return m_flags; }
/// \brief Copy the value of the property into an Atlas Message
virtual bool get(Atlas::Message::Element & val) const = 0;
/// \brief Read the value of the property from an Atlas Message
virtual void set(const Atlas::Message::Element & val) = 0;
/// \brief Add the value as an attribute to an Atlas map
virtual void add(const std::string & key, Atlas::Message::MapType & map) const;
/// \brief Add the value as an attribute to an Atlas entity
virtual void add(const std::string & key, const Atlas::Objects::Entity::RootEntity & ent) const;
};
/// \brief Entity property template for properties with single data values
/// that cannot be modified directly.
///
/// Properties like CONTAINS, LOC and POS are accessed this way, as they
/// are only ever modified as a result of a move operation.
/// \ingroup PropertyClasses
template <typename T>
class ImmutableProperty : public PropertyBase {
protected:
/// \brief Reference to variable holding the value of this Property
const T & m_data;
public:
explicit ImmutableProperty(const T & data, unsigned int flags = 0);
virtual bool get(Atlas::Message::Element & val) const;
virtual void set(const Atlas::Message::Element & val);
virtual void add(const std::string & key, Atlas::Message::MapType & map) const;
virtual void add(const std::string & key, const Atlas::Objects::Entity::RootEntity & ent) const;
};
/// \brief Entity property template for properties with single data values
/// \ingroup PropertyClasses
template <typename T>
class Property : public ImmutableProperty<T> {
protected:
/// \brief Reference to variable holding the value of this Property
T & m_modData;
public:
explicit Property(T & data, unsigned int flags);
virtual void set(const Atlas::Message::Element &);
};
/// \brief Entity property template for properties with single data values
/// \ingroup PropertyClasses
template <typename T>
class SignalProperty : public Property<T>, virtual public sigc::trackable {
public:
explicit SignalProperty(T & data, unsigned int flags);
virtual void set(const Atlas::Message::Element & val);
/// \brief Signal that is emitted when this Property is modified.
sigc::signal<void> modified;
};
class SoftProperty : public PropertyBase {
protected:
Atlas::Message::Element m_data;
public:
explicit SoftProperty(const Atlas::Message::Element & data);
/// \brief Copy the value of the property into an Atlas Message
virtual bool get(Atlas::Message::Element & val) const;
/// \brief Read the value of the property from an Atlas Message
virtual void set(const Atlas::Message::Element & val);
};
#endif // COMMON_PROPERTY_H
|
