object.hpp
Go to the documentation of this file.
#ifndef OSMIUM_OSM_OBJECT_HPP
#define OSMIUM_OSM_OBJECT_HPP
/*
This file is part of Osmium (http://osmcode.org/libosmium).
Copyright 2013-2016 Jochen Topf <jochen@topf.org> and others (see README).
Boost Software License - Version 1.0 - August 17th, 2003
Permission is hereby granted, free of charge, to any person or organization
obtaining a copy of the software and accompanying documentation covered by
this license (the "Software") to use, reproduce, display, distribute,
execute, and transmit the Software, and to prepare derivative works of the
Software, and to permit third-parties to whom the Software is furnished to
do so, all subject to the following:
The copyright notices in the Software and this entire statement, including
the above license grant, this restriction and the following disclaimer,
must be included in all copies of the Software, in whole or in part, and
all derivative works of the Software, unless such copies or derivative
works are solely in the form of machine-executable object code generated by
a source language processor.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT
SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE
FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE,
ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
DEALINGS IN THE SOFTWARE.
*/
#include <cstddef>
#include <cstdint>
#include <cstdlib>
#include <cstring>
#include <stdexcept>
#include <osmium/memory/collection.hpp>
#include <osmium/memory/item.hpp>
#include <osmium/memory/item_iterator.hpp>
#include <osmium/osm/entity.hpp>
#include <osmium/osm/item_type.hpp>
#include <osmium/osm/location.hpp>
#include <osmium/osm/tag.hpp>
#include <osmium/osm/timestamp.hpp>
#include <osmium/osm/types.hpp>
#include <osmium/osm/types_from_string.hpp>
namespace osmium {
class OSMObject : public osmium::OSMEntity {
object_id_type m_id;
bool m_deleted : 1;
object_version_type m_version : 31;
osmium::Timestamp m_timestamp;
user_id_type m_uid;
changeset_id_type m_changeset;
size_t sizeof_object() const noexcept {
return sizeof(OSMObject) + (type() == item_type::node ? sizeof(osmium::Location) : 0) + sizeof(string_size_type);
}
unsigned char* user_position() noexcept {
return data() + sizeof_object() - sizeof(string_size_type);
}
const unsigned char* user_position() const noexcept {
return data() + sizeof_object() - sizeof(string_size_type);
}
string_size_type user_size() const noexcept {
return *reinterpret_cast<const string_size_type*>(user_position());
}
unsigned char* subitems_position() {
return data() + osmium::memory::padded_length(sizeof_object() + user_size());
}
const unsigned char* subitems_position() const {
return data() + osmium::memory::padded_length(sizeof_object() + user_size());
}
protected:
OSMObject(osmium::memory::item_size_type size, osmium::item_type type) :
OSMEntity(size, type),
m_id(0),
m_deleted(false),
m_version(0),
m_timestamp(),
m_uid(0),
m_changeset(0) {
}
void set_user_size(string_size_type size) {
*reinterpret_cast<string_size_type*>(user_position()) = size;
}
public:
object_id_type id() const noexcept {
return m_id;
}
unsigned_object_id_type positive_id() const noexcept {
return static_cast<unsigned_object_id_type>(std::abs(m_id));
}
OSMObject& set_id(object_id_type id) noexcept {
m_id = id;
return *this;
}
OSMObject& set_id(const char* id) {
return set_id(osmium::string_to_object_id(id));
}
bool deleted() const noexcept {
return m_deleted;
}
bool visible() const noexcept {
return !deleted();
}
OSMObject& set_deleted(bool deleted) noexcept {
m_deleted = deleted;
return *this;
}
OSMObject& set_visible(bool visible) noexcept {
m_deleted = !visible;
return *this;
}
OSMObject& set_visible(const char* visible) {
if (!strcmp("true", visible)) {
set_visible(true);
} else if (!strcmp("false", visible)) {
set_visible(false);
} else {
throw std::invalid_argument("Unknown value for visible attribute (allowed is 'true' or 'false')");
}
return *this;
}
object_version_type version() const noexcept {
return m_version;
}
OSMObject& set_version(object_version_type version) noexcept {
m_version = version;
return *this;
}
OSMObject& set_version(const char* version) {
return set_version(string_to_object_version(version));
}
changeset_id_type changeset() const noexcept {
return m_changeset;
}
OSMObject& set_changeset(changeset_id_type changeset) noexcept {
m_changeset = changeset;
return *this;
}
OSMObject& set_changeset(const char* changeset) {
return set_changeset(string_to_changeset_id(changeset));
}
user_id_type uid() const noexcept {
return m_uid;
}
OSMObject& set_uid(user_id_type uid) noexcept {
m_uid = uid;
return *this;
}
OSMObject& set_uid_from_signed(signed_user_id_type uid) noexcept {
m_uid = uid < 0 ? 0 : static_cast<user_id_type>(uid);
return *this;
}
OSMObject& set_uid(const char* uid) {
return set_uid_from_signed(string_to_user_id(uid));
}
bool user_is_anonymous() const noexcept {
return m_uid == 0;
}
osmium::Timestamp timestamp() const noexcept {
return m_timestamp;
}
OSMObject& set_timestamp(const osmium::Timestamp& timestamp) noexcept {
m_timestamp = timestamp;
return *this;
}
const char* user() const noexcept {
return reinterpret_cast<const char*>(data() + sizeof_object());
}
const TagList& tags() const {
return osmium::detail::subitem_of_type<const TagList>(cbegin(), cend());
}
const char* get_value_by_key(const char* key, const char* default_value = nullptr) const noexcept {
return tags().get_value_by_key(key, default_value);
}
void set_attribute(const char* attr, const char* value) {
if (!strcmp(attr, "id")) {
set_id(value);
} else if (!strcmp(attr, "version")) {
set_version(value);
} else if (!strcmp(attr, "changeset")) {
set_changeset(value);
} else if (!strcmp(attr, "timestamp")) {
set_timestamp(osmium::Timestamp(value));
} else if (!strcmp(attr, "uid")) {
set_uid(value);
} else if (!strcmp(attr, "visible")) {
set_visible(value);
}
}
typedef osmium::memory::CollectionIterator<Item> iterator;
typedef osmium::memory::CollectionIterator<const Item> const_iterator;
iterator begin() {
return iterator(subitems_position());
}
iterator end() {
return iterator(next());
}
const_iterator cbegin() const {
return const_iterator(subitems_position());
}
const_iterator cend() const {
return const_iterator(next());
}
const_iterator begin() const {
return cbegin();
}
const_iterator end() const {
return cend();
}
template <typename T>
using t_iterator = osmium::memory::ItemIterator<T>;
template <typename T>
using t_const_iterator = osmium::memory::ItemIterator<const T>;
template <typename T>
t_iterator<T> begin() {
return t_iterator<T>(subitems_position(), next());
}
template <typename T>
t_iterator<T> end() {
return t_iterator<T>(next(), next());
}
template <typename T>
t_const_iterator<T> cbegin() const {
return t_const_iterator<T>(subitems_position(), next());
}
template <typename T>
t_const_iterator<T> cend() const {
return t_const_iterator<T>(next(), next());
}
template <typename T>
t_const_iterator<T> begin() const {
return cbegin<T>();
}
template <typename T>
t_const_iterator<T> end() const {
return cend<T>();
}
}; // class OSMObject
inline bool operator==(const OSMObject& lhs, const OSMObject& rhs) noexcept {
return lhs.type() == rhs.type() &&
lhs.id() == rhs.id() &&
lhs.version() == rhs.version();
}
inline bool operator!=(const OSMObject& lhs, const OSMObject& rhs) noexcept {
return ! (lhs == rhs);
}
inline bool operator<(const OSMObject& lhs, const OSMObject& rhs) noexcept {
if (lhs.type() != rhs.type()) {
return lhs.type() < rhs.type();
}
return (lhs.id() == rhs.id() && lhs.version() < rhs.version()) ||
lhs.positive_id() < rhs.positive_id();
}
inline bool operator>(const OSMObject& lhs, const OSMObject& rhs) noexcept {
return rhs < lhs;
}
inline bool operator<=(const OSMObject& lhs, const OSMObject& rhs) noexcept {
return ! (rhs < lhs);
}
inline bool operator>=(const OSMObject& lhs, const OSMObject& rhs) noexcept {
return ! (lhs < rhs);
}
} // namespace osmium
#endif // OSMIUM_OSM_OBJECT_HPP
collection.hpp
osmium::OSMObject::m_id
object_id_type m_id
Definition: object.hpp:60
osmium::memory::CollectionIterator
Definition: collection.hpp:47
osmium::OSMObject::user_position
unsigned char * user_position() noexcept
Definition: object.hpp:71
osmium::TagList
Definition: tag.hpp:105
osmium::unsigned_object_id_type
uint64_t unsigned_object_id_type
Type for OSM object (node, way, or relation) IDs where we only allow positive IDs.
Definition: types.hpp:46
osmium::OSMObject::begin
t_const_iterator< T > begin() const
Definition: object.hpp:385
osmium::operator<=
bool operator<=(const Changeset &lhs, const Changeset &rhs)
Definition: changeset.hpp:446
osmium::OSMObject::set_timestamp
OSMObject & set_timestamp(const osmium::Timestamp &timestamp) noexcept
Definition: object.hpp:284
location.hpp
types_from_string.hpp
item_iterator.hpp
osmium::OSMObject::m_deleted
bool m_deleted
Definition: object.hpp:61
osmium::OSMObject::OSMObject
OSMObject(osmium::memory::item_size_type size, osmium::item_type type)
Definition: object.hpp:93
osmium::memory::ItemIterator
Definition: item_iterator.hpp:119
osmium::memory::Item::next
unsigned char * next() noexcept
Definition: item.hpp:139
osmium::OSMObject::user_size
string_size_type user_size() const noexcept
Definition: object.hpp:79
osmium::operator==
constexpr bool operator==(const Box &lhs, const Box &rhs) noexcept
Definition: box.hpp:222
osmium::item_type
item_type
Definition: item_type.hpp:43
osmium::OSMObject::cend
const_iterator cend() const
Definition: object.hpp:346
osmium::OSMObject::sizeof_object
size_t sizeof_object() const noexcept
Definition: object.hpp:67
osmium::OSMObject::m_version
object_version_type m_version
Definition: object.hpp:62
osmium::OSMObject::cend
t_const_iterator< T > cend() const
Definition: object.hpp:380
osmium::OSMObject::set_id
OSMObject & set_id(object_id_type id) noexcept
Definition: object.hpp:124
osmium::OSMEntity
OSMEntity is the abstract base class for the OSMObject and Changeset classes.
Definition: entity.hpp:64
osmium::OSMObject::set_changeset
OSMObject & set_changeset(const char *changeset)
Definition: object.hpp:229
osmium::OSMObject::cbegin
const_iterator cbegin() const
Definition: object.hpp:342
types.hpp
osmium::memory::padded_length
T padded_length(T length) noexcept
Definition: item.hpp:56
osmium::OSMObject::set_attribute
void set_attribute(const char *attr, const char *value)
Definition: object.hpp:315
item_type.hpp
tag.hpp
osmium::OSMObject::m_timestamp
osmium::Timestamp m_timestamp
Definition: object.hpp:63
osmium::string_to_object_version
object_version_type string_to_object_version(const char *input)
Definition: types_from_string.hpp:123
osmium::OSMObject::user_is_anonymous
bool user_is_anonymous() const noexcept
Is this user anonymous?
Definition: object.hpp:269
osmium::OSMObject::end
iterator end()
Definition: object.hpp:338
osmium::item_type::node
osmium::OSMObject::set_visible
OSMObject & set_visible(const char *visible)
Definition: object.hpp:174
osmium::OSMObject::cbegin
t_const_iterator< T > cbegin() const
Definition: object.hpp:375
osmium::OSMObject::set_uid_from_signed
OSMObject & set_uid_from_signed(signed_user_id_type uid) noexcept
Definition: object.hpp:254
osmium::operator<
bool operator<(const Changeset &lhs, const Changeset &rhs)
Definition: changeset.hpp:438
osmium::string_to_object_id
object_id_type string_to_object_id(const char *input)
Definition: types_from_string.hpp:59
osmium::object_id_type
int64_t object_id_type
Type for OSM object (node, way, or relation) IDs.
Definition: types.hpp:45
osmium
Namespace for everything in the Osmium library.
Definition: assembler.hpp:59
osmium::OSMObject::m_changeset
changeset_id_type m_changeset
Definition: object.hpp:65
osmium::Timestamp
Definition: timestamp.hpp:56
osmium::string_size_type
uint16_t string_size_type
Definition: types.hpp:59
osmium::string_to_changeset_id
changeset_id_type string_to_changeset_id(const char *input)
Definition: types_from_string.hpp:137
osmium::OSMObject::tags
const TagList & tags() const
Get the list of tags for this object.
Definition: object.hpp:295
osmium::OSMObject::uid
user_id_type uid() const noexcept
Get user id of this object.
Definition: object.hpp:234
osmium::OSMObject::begin
t_iterator< T > begin()
Definition: object.hpp:365
osmium::OSMObject::changeset
changeset_id_type changeset() const noexcept
Get changeset id of this object.
Definition: object.hpp:210
osmium::OSMObject::begin
const_iterator begin() const
Definition: object.hpp:350
osmium::OSMObject::set_changeset
OSMObject & set_changeset(changeset_id_type changeset) noexcept
Definition: object.hpp:219
osmium::OSMObject::set_uid
OSMObject & set_uid(const char *uid)
Definition: object.hpp:264
osmium::Location
Definition: location.hpp:79
osmium::signed_user_id_type
int32_t signed_user_id_type
Type for signed OSM user IDs.
Definition: types.hpp:50
osmium::OSMObject::set_id
OSMObject & set_id(const char *id)
Definition: object.hpp:134
osmium::OSMObject::deleted
bool deleted() const noexcept
Is this object marked as deleted?
Definition: object.hpp:139
entity.hpp
osmium::operator>=
bool operator>=(const Changeset &lhs, const Changeset &rhs)
Definition: changeset.hpp:450
osmium::OSMObject::id
object_id_type id() const noexcept
Get ID of this object.
Definition: object.hpp:110
osmium::OSMObject::set_version
OSMObject & set_version(object_version_type version) noexcept
Definition: object.hpp:195
osmium::string_to_user_id
signed_user_id_type string_to_user_id(const char *input)
Definition: types_from_string.hpp:151
osmium::OSMObject::version
object_version_type version() const noexcept
Get version of this object.
Definition: object.hpp:186
item.hpp
osmium::operator>
bool operator>(const Changeset &lhs, const Changeset &rhs)
Definition: changeset.hpp:442
osmium::OSMObject::const_iterator
osmium::memory::CollectionIterator< const Item > const_iterator
Definition: object.hpp:332
osmium::OSMObject::set_visible
OSMObject & set_visible(bool visible) noexcept
Definition: object.hpp:163
osmium::OSMObject::visible
bool visible() const noexcept
Is this object marked visible (ie not deleted)?
Definition: object.hpp:144
osmium::object_version_type
uint32_t object_version_type
Type for OSM object version number.
Definition: types.hpp:47
osmium::OSMObject::subitems_position
unsigned char * subitems_position()
Definition: object.hpp:83
osmium::memory::item_size_type
uint32_t item_size_type
Definition: item.hpp:50
osmium::OSMObject::end
t_iterator< T > end()
Definition: object.hpp:370
osmium::OSMObject::end
const_iterator end() const
Definition: object.hpp:354
osmium::OSMObject::m_uid
user_id_type m_uid
Definition: object.hpp:64
osmium::OSMObject::positive_id
unsigned_object_id_type positive_id() const noexcept
Get absolute value of the ID of this object.
Definition: object.hpp:115
osmium::OSMObject::set_deleted
OSMObject & set_deleted(bool deleted) noexcept
Definition: object.hpp:153
osmium::OSMObject::iterator
osmium::memory::CollectionIterator< Item > iterator
Definition: object.hpp:331
osmium::OSMObject::end
t_const_iterator< T > end() const
Definition: object.hpp:390
osmium::OSMObject::set_user_size
void set_user_size(string_size_type size)
Definition: object.hpp:103
osmium::changeset_id_type
uint32_t changeset_id_type
Type for OSM changeset IDs.
Definition: types.hpp:48
osmium::OSMObject::subitems_position
const unsigned char * subitems_position() const
Definition: object.hpp:87
osmium::OSMObject::get_value_by_key
const char * get_value_by_key(const char *key, const char *default_value=nullptr) const noexcept
Definition: object.hpp:305
osmium::OSMObject::user_position
const unsigned char * user_position() const noexcept
Definition: object.hpp:75
osmium::OSMObject::user
const char * user() const noexcept
Get user name for this object.
Definition: object.hpp:290
osmium::TagList::get_value_by_key
const char * get_value_by_key(const char *key, const char *default_value=nullptr) const noexcept
Definition: tag.hpp:119
osmium::OSMObject::set_version
OSMObject & set_version(const char *version)
Definition: object.hpp:205
osmium::memory::Item::type
item_type type() const noexcept
Definition: item.hpp:155
osmium::OSMObject::timestamp
osmium::Timestamp timestamp() const noexcept
Get timestamp when this object last changed.
Definition: object.hpp:274
osmium::OSMObject::set_uid
OSMObject & set_uid(user_id_type uid) noexcept
Definition: object.hpp:243
osmium::operator!=
bool operator!=(const Changeset &lhs, const Changeset &rhs)
Definition: changeset.hpp:431
timestamp.hpp
osmium::OSMObject
Definition: object.hpp:58
osmium::user_id_type
uint32_t user_id_type
Type for OSM user IDs.
Definition: types.hpp:49
osmium::OSMObject::begin
iterator begin()
Definition: object.hpp:334