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 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327
|
// This file may be redistributed and modified only under the terms of
// the GNU Lesser General Public License (See COPYING for details).
// Copyright (C) 2000-2004 Stefanus Du Toit, Aloril and Al Riddoch
#ifndef ATLAS_OBJECTS_BASEOBJECT_H
#define ATLAS_OBJECTS_BASEOBJECT_H
#include <Atlas/Message/MEncoder.h>
#include <Atlas/Message/Element.h>
#include <Atlas/Bridge.h>
#include <Atlas/Exception.h>
#include <map>
#include <list>
#include <string>
#include <assert.h>
namespace Atlas {
/// The Atlas high level Objects namespace.
///
/// This namespace contains classes used to handle high level Atlas data.
namespace Objects {
/** An exception indicating the requested attribute does not exist.
*
* This is thrown by Root::getAttr() [and derivatives thereof!]
*/
class NoSuchAttrException : public Atlas::Exception
{
/// The name of the attribute that does not exist.
std::string m_name;
public:
NoSuchAttrException(const std::string& name) :
Atlas::Exception("No such attribute"), m_name(name) {}
virtual ~NoSuchAttrException() throw ();
/// Get the name of the attribute which does not exist.
const std::string & getName() const {
return m_name;
}
};
static const int BASE_OBJECT_NO = 0;
/** Atlas base object class.
This is class is the base from which all classes used to represent high
level objects are derived. In this release of Atlas-C++, all classes
that inherit from BaseObjectData are designed to be used with SmartPtr
and should have the suffix Data on the end of their name. All the
subclasses of BaseObjectData included with Atlas-C++ are automatically
generated from the Atlas spec at release time. For each subclass
a typedef is created of a specialisation of SmartPtr aliasing it
to the name of the class without the Data suffix. Thus RootOperationData
has an associate type RootOperation which is a typedef for
SmartPtr<RootOperationData>. Each class also has an associated integer
identifier used to identify classes of its type. The SmartPtr class
is designed to store unused instances of the data objects in a memory
pool, and reuse instances as they are required. In order to re-use
instances without re-constructing all their members, a system of flags
is used to mark which members are in use. When an instance is re-used
these flags are cleared, indicating that none of the members are in use.
*/
class BaseObjectData
{
public:
/// Construct a new BaseObjectData from a subclass.
/// Initialises flags to zero, and stores a pointer to the reference
/// object that provides default values for all attributes. Subclasses
/// must pass in a pointer to their class specific reference object.
BaseObjectData(BaseObjectData *defaults) :
m_class_no(BASE_OBJECT_NO), m_defaults(defaults)
{
if(defaults) m_attrFlags = 0;
else m_attrFlags = -1; //this is default object: all attributes here
m_refCount = 0;
}
virtual ~BaseObjectData();
/// Get class number:
int getClassNo() const
{
return m_class_no;
}
virtual BaseObjectData * copy() const = 0;
/// Is this instance of some class?
virtual bool instanceOf(int classNo) const;
/// Check whether the attribute "name" exists.
bool hasAttr(const std::string& name) const;
/// Check whether the attribute "name" exists.
bool hasAttrFlag(int flag) const;
/// Retrieve the attribute "name". Throws NoSuchAttrException if it does
/// not exist.
const Atlas::Message::Element getAttr(const std::string& name)
const throw (NoSuchAttrException);
/// Retrieve the attribute "name". Return non-zero if it does
/// not exist.
virtual int copyAttr(const std::string& name,
Atlas::Message::Element & attr) const;
/// Set the attribute "name" to the value given by "attr".
virtual void setAttr(const std::string& name,
const Atlas::Message::Element& attr);
/// Remove the attribute "name". This will not work for static attributes.
virtual void removeAttr(const std::string& name);
/// Convert this object to a Object. This is now legacy, and implemented
/// using addToMessage.
const Atlas::Message::MapType asMessage() const;
/// Write this object to an existing Element
virtual void addToMessage(Atlas::Message::MapType &) const;
/// Send the contents of this object to a Bridge.
virtual void sendContents(Atlas::Bridge & b) const;
//move to protected once SmartPtr <-> BaseObject order established
inline void incRef();
inline void decRef();
/// \brief Allocate a new instance of this class, using an existing
/// instance if available.
///
/// This is the key function for implementing the memory pool
/// for the Atlas::Objects API.
static BaseObjectData *alloc() {assert(0); return NULL;} //not callable
/// \brief Free an instance of this class, returning it to the memory
/// pool.
///
/// This function in combination with alloc() handle the memory pool.
virtual void free() = 0;
class const_iterator;
// FIXME should this hold a reference to the object it's
// iterating over?
/// The iterator first iterates over the contents of m_obj->m_attributes,
/// holding an iterator to the attributes map in m_I. When m_I reaches
/// the end, it iterates through the named attributes in each of the
/// classes, starting with the terminal child and working its way
/// up to the ultimate parent, BaseObjectData. It stores the
/// class number in m_current_class and the name of the current
/// attribute in m_val.first. Since BaseObjectData has no
/// named attributes, an iterator with m_current_class == BASE_OBJECT_NO
/// is considered to be the end of the map.
/// The iterator constructor has an argument which lets you begin() at the
/// first named attribute in some class, and only iterate through
/// that class and its parents. The same iterator, treated as an
/// end(), lets you iterate through all attributes which are either
/// named in derived classes or in m_attributes.
class iterator
{
public:
friend class BaseObjectData;
friend class const_iterator;
iterator() : m_obj(0), m_val("", *this) {}
iterator(const iterator& I) : m_obj(I.m_obj),
m_current_class(I.m_current_class),
m_I(I.m_I), m_val(I.m_val.first, *this) {}
iterator(BaseObjectData& obj, int current_class);
// default destructor is fine unless we hold a reference to m_obj
iterator& operator=(const iterator& I);
iterator& operator++(); // preincrement
inline iterator operator++(int); // postincrement
bool operator==(const iterator& I) const;
bool operator!=(const iterator& I) const {return !operator==(I);}
class PsuedoElement
{
public:
PsuedoElement(const iterator& I) : m_I(I) {}
operator Message::Element() const;
// this acts on const PsuedoElement instead of PsuedoElement
// so that we can assign to attributes refered to by
// a const iterator& (as opposed to a const_iterator, where
// we can't, but that's done later)
const PsuedoElement& operator=(const Message::Element& val) const;
private:
const iterator& m_I;
};
friend class PsuedoElement;
typedef std::pair<std::string,PsuedoElement> value_type;
const value_type& operator*() const {return m_val;}
const value_type* operator->() const {return &m_val;}
private:
BaseObjectData *m_obj; // pointer to object whose args we're iterating
int m_current_class; // m_class_no for current class in the iteration
Message::MapType::iterator m_I; // iterator in m_obj->m_attributes
value_type m_val;
};
friend class iterator;
// FIXME should this hold a reference to the object it's
// iterating over?
class const_iterator
{
public:
friend class BaseObjectData;
const_iterator() : m_obj(0), m_val("", *this) {}
const_iterator(const const_iterator& I) : m_obj(I.m_obj),
m_current_class(I.m_current_class),
m_I(I.m_I), m_val(I.m_val.first, *this) {}
const_iterator(const iterator& I) : m_obj(I.m_obj),
m_current_class(I.m_current_class),
m_I(I.m_I), m_val(I.m_val.first, *this) {}
const_iterator(const BaseObjectData& obj, int current_class);
// default destructor is fine unless we hold a reference to m_obj
const_iterator& operator=(const const_iterator& I);
const_iterator& operator++(); // preincrement
inline const_iterator operator++(int); // postincrement
bool operator==(const const_iterator& I) const;
bool operator!=(const const_iterator& I) const {return !operator==(I);}
class PsuedoElement
{
public:
PsuedoElement(const const_iterator& I) : m_I(I) {}
operator Message::Element() const;
private:
const const_iterator& m_I;
};
friend class PsuedoElement;
typedef std::pair<std::string,PsuedoElement> value_type;
const value_type& operator*() const {return m_val;}
const value_type* operator->() const {return &m_val;}
private:
const BaseObjectData *m_obj; // pointer to object whose args we're iterating
int m_current_class; // m_class_no for current class in the iteration
Message::MapType::const_iterator m_I; // const_iterator in m_obj->m_attributes
value_type m_val;
};
friend class const_iterator;
iterator begin() {return iterator(*this, -1);}
iterator end() {return iterator(*this, BASE_OBJECT_NO);}
iterator find(const std::string&);
const_iterator begin() const {return const_iterator(*this, -1);}
const_iterator end() const {return const_iterator(*this, BASE_OBJECT_NO);}
const_iterator find(const std::string&) const;
protected:
/// Find the class which contains the attribute "name".
virtual int getAttrClass(const std::string& name) const;
/// Find the flag for the attribute "name".
virtual int getAttrFlag(const std::string& name) const;
/// Iterate over the attributes of this instance.
virtual void iterate(int& current_class, std::string& attr) const;
int m_class_no; //each class has different enum
int m_refCount; //how many instances
BaseObjectData *m_defaults;
//this will be defined in each subclass separately, so no need here for it
//static BaseObjectData *begin;
BaseObjectData *m_next;
std::map<std::string, Atlas::Message::Element> m_attributes;
// is attribute in this object or in default object?
int m_attrFlags;
};
void BaseObjectData::incRef() {
m_refCount++;
}
void BaseObjectData::decRef() {
//why zero based refCount? avoids one m_refCount-- ;-)
assert( m_refCount >= 0 );
if(!m_refCount) {
free();
return;
}
m_refCount--;
}
BaseObjectData::iterator BaseObjectData::iterator::operator++(int) // postincrement
{
iterator tmp = *this;
operator++();
return tmp;
}
BaseObjectData::const_iterator BaseObjectData::const_iterator::operator++(int) // postincrement
{
const_iterator tmp = *this;
operator++();
return tmp;
}
} } // namespace Atlas::Objects
#endif
|