CID 1321282: virtual destructors are not needed
[scilab.git] / scilab / modules / scicos / includes / model / BaseObject.hxx
1 /*
2  *  Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
3  *  Copyright (C) 2014-2016 - Scilab Enterprises - Clement DAVID
4  *
5  * Copyright (C) 2012 - 2016 - Scilab Enterprises
6  *
7  * This file is hereby licensed under the terms of the GNU GPL v2.0,
8  * pursuant to article 5.3.4 of the CeCILL v.2.1.
9  * This file was originally licensed under the terms of the CeCILL v2.1,
10  * and continues to be available under such terms.
11  * For more information, see the COPYING file which you should have received
12  * along with this program.
13  *
14  */
15
16 #ifndef BASEOBJECT_HXX_
17 #define BASEOBJECT_HXX_
18
19 #include <vector>
20 #include <initializer_list>
21
22 #include "utilities.hxx"
23
24 namespace org_scilab_modules_scicos
25 {
26 namespace model
27 {
28
29 class BaseObject
30 {
31 public:
32     explicit BaseObject(kind_t k) :
33         m_id(ScicosID()), m_kind(k), m_refCount()
34     {
35         // m_id will be set by the caller
36     }
37     BaseObject(const BaseObject& b) :
38         m_id(b.m_id), m_kind(b.m_kind), m_refCount()
39     {
40     }
41     BaseObject(BaseObject&& b) :
42         m_id(b.m_id), m_kind(b.m_kind), m_refCount()
43     {
44     }
45     BaseObject(ScicosID id, kind_t k) :
46         m_id(id), m_kind(k), m_refCount()
47     {
48     }
49
50     inline BaseObject& operator=(BaseObject&& o)
51     {
52         m_id = o.m_id;
53         m_kind = o.m_kind;
54         return *this;
55     }
56     inline bool operator<(BaseObject o) const
57     {
58         return m_id < o.m_id;
59     }
60     inline bool operator==(BaseObject o) const
61     {
62         return m_id == o.m_id;
63     }
64
65     inline ScicosID id() const
66     {
67         return m_id;
68     }
69     inline void id(ScicosID _id)
70     {
71         m_id = _id;
72     }
73
74     inline kind_t kind() const
75     {
76         return m_kind;
77     }
78
79     inline unsigned& refCount()
80     {
81         return m_refCount;
82     }
83
84 private:
85     /**
86      * An id is used as a reference to the current object
87      */
88     ScicosID m_id;
89
90     /**
91      * Kind of the Object
92      */
93     kind_t m_kind;
94
95     /**
96      * Refcount of this object
97      */
98     unsigned m_refCount;
99 };
100
101 /** @defgroup utilities Shared utility classes
102  * @{
103  */
104
105 /*
106  * Represent a graphical object
107  */
108 struct Geometry
109 {
110     double m_x;
111     double m_y;
112     double m_width;
113     double m_height;
114
115     Geometry() : m_x(0), m_y(0), m_width(20), m_height(20) {};
116     Geometry(const Geometry& g) : m_x(g.m_x), m_y(g.m_y), m_width(g.m_width), m_height(g.m_height) {};
117     Geometry(const std::vector<double>& v) : m_x(v[0]), m_y(v[1]), m_width(v[2]), m_height(v[3]) {};
118     Geometry(std::initializer_list<double> l) : m_x(*l.begin()), m_y(*(l.begin() + 1)), m_width(*(l.begin() + 2)), m_height(*(l.begin() + 3)) {};
119
120     void fill(std::vector<double>& v) const
121     {
122         v.resize(4);
123         v[0] = m_x;
124         v[1] = m_y;
125         v[2] = m_width;
126         v[3] = m_height;
127     }
128     bool operator==(const Geometry& g) const
129     {
130         return m_x == g.m_x && m_y == g.m_y && m_width == g.m_width && m_height == g.m_height;
131     }
132 };
133
134 /**
135  * Per port type descriptor
136  *
137  * FIXME: should reuse Scilab datatypes descriptors
138  */
139 struct Datatype
140 {
141 public:
142     Datatype(const Datatype& d) :
143         m_refCount(0), m_datatype_id(d.m_datatype_id), m_rows(d.m_rows), m_columns(d.m_columns) {};
144     Datatype(const std::vector<int>& v) :
145         m_refCount(0), m_datatype_id(v[2]), m_rows(v[0]), m_columns(v[1]) {};
146
147     // reference counter for the flyweight pattern
148     int m_refCount;
149
150     const int m_datatype_id;
151     const int m_rows;
152     const int m_columns;
153
154     bool operator==(const Datatype& d) const
155     {
156         return m_datatype_id == d.m_datatype_id && m_rows == d.m_rows && m_columns == d.m_columns;
157     }
158
159     bool operator<(const Datatype& d) const
160     {
161         // Lexicographical order
162         return m_datatype_id < d.m_datatype_id ||
163                (m_datatype_id == d.m_datatype_id && m_rows < d.m_rows) ||
164                (m_datatype_id == d.m_datatype_id && m_rows == d.m_rows && m_columns < d.m_columns);
165     }
166 };
167
168 /** @}*/
169
170 } /* namespace model */
171 } /* namespace org_scilab_modules_scicos */
172
173 #endif /* BASEOBJECT_HXX_ */