OpenVolumeMeshProperty.hh 15.3 KB
Newer Older
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
/*===========================================================================*\
 *                                                                           *
 *                            OpenVolumeMesh                                 *
 *        Copyright (C) 2011 by Computer Graphics Group, RWTH Aachen         *
 *                        www.openvolumemesh.org                             *
 *                                                                           *
 *---------------------------------------------------------------------------*
 *  This file is part of OpenVolumeMesh.                                     *
 *                                                                           *
 *  OpenVolumeMesh is free software: you can redistribute it and/or modify   *
 *  it under the terms of the GNU Lesser General Public License as           *
 *  published by the Free Software Foundation, either version 3 of           *
 *  the License, or (at your option) any later version with the              *
 *  following exceptions:                                                    *
 *                                                                           *
 *  If other files instantiate templates or use macros                       *
 *  or inline functions from this file, or you compile this file and         *
 *  link it with other files to produce an executable, this file does        *
 *  not by itself cause the resulting executable to be covered by the        *
 *  GNU Lesser General Public License. This exception does not however       *
 *  invalidate any other reasons why the executable file might be            *
 *  covered by the GNU Lesser General Public License.                        *
 *                                                                           *
 *  OpenVolumeMesh 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 Lesser General Public License for more details.                      *
 *                                                                           *
 *  You should have received a copy of the GNU LesserGeneral Public          *
 *  License along with OpenVolumeMesh.  If not,                              *
 *  see <http://www.gnu.org/licenses/>.                                      *
 *                                                                           *
\*===========================================================================*/

/*===========================================================================*\
 *                                                                           *
 *   $Revision$                                                         *
 *   $Date$                    *
 *   $LastChangedBy$                                                *
 *                                                                           *
\*===========================================================================*/

#ifndef OPENVOLUMEMESHPROPERTY_HH
#define OPENVOLUMEMESHPROPERTY_HH

//== INCLUDES =================================================================

#include <cassert>
49 50 51 52 53
#include <istream>
#include <ostream>
#include <numeric>
#include <string>
#include <vector>
54 55 56

#include "OpenVolumeMeshBaseProperty.hh"

57 58
#include "Serializers.hh"

59 60 61 62 63 64 65 66 67 68 69 70 71 72 73
namespace OpenVolumeMesh {

//== CLASS DEFINITION =========================================================

/** \class OpenVolumeMeshPropertyT
 *
 *  \brief Default property class for any type T.
 *
 *  The default property class for any type T.
 */

template<class T>
class OpenVolumeMeshPropertyT: public OpenVolumeMeshBaseProperty {
public:

74 75
    template <class PropT, class HandleT> friend class PropertyPtr;

76 77 78 79 80 81 82 83 84
	typedef T 										Value;
	typedef std::vector<T> 				            vector_type;
	typedef T 										value_type;
	typedef typename vector_type::reference 		reference;
	typedef typename vector_type::const_reference 	const_reference;

public:

	/// Default constructor
85 86 87
	OpenVolumeMeshPropertyT(const std::string& _name = "<unknown>", const T _def = T()) :
		OpenVolumeMeshBaseProperty(_name),
		def_(_def) {
88 89 90 91
	}

	/// Copy constructor
	OpenVolumeMeshPropertyT(const OpenVolumeMeshPropertyT& _rhs) :
92 93 94
		OpenVolumeMeshBaseProperty(_rhs),
		data_(_rhs.data_),
		def_(_rhs.def_) {
95 96 97 98 99 100 101 102
	}

public:
	// inherited from OpenVolumeMeshBaseProperty
	virtual void reserve(size_t _n) {
		data_.reserve(_n);
	}
	virtual void resize(size_t _n) {
103
		data_.resize(_n, def_);
104 105 106 107 108 109
	}
	virtual void clear() {
		data_.clear();
		vector_type().swap(data_);
	}
	virtual void push_back() {
110
		data_.push_back(def_);
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
	}
	virtual void swap(size_t _i0, size_t _i1) {
		std::swap(data_[_i0], data_[_i1]);
	}

	void delete_element(size_t _idx) {
	    data_.erase(data_.begin() + _idx);
	}

public:

	virtual size_t n_elements() const {
		return data_.size();
	}
	virtual size_t element_size() const {
		return sizeof(T);
	}

#ifndef DOXY_IGNORE_THIS
	struct plus {
		size_t operator ()(size_t _b, const T& /*_v*/) {
			return _b + sizeof(T);
		}
	};
#endif

	virtual size_t size_of() const {
		if (element_size() != OpenVolumeMeshBaseProperty::UnknownSize)
			return this->OpenVolumeMeshBaseProperty::size_of(n_elements());
		return std::accumulate(data_.begin(), data_.end(), 0, plus());
	}

	virtual size_t size_of(size_t _n_elem) const {
		return this->OpenVolumeMeshBaseProperty::size_of(_n_elem);
	}

	// Function to serialize a property
148
    virtual void serialize(std::ostream& _ostr) const {
149 150
        for(typename vector_type::const_iterator it = data_.begin();
                it != data_.end(); ++it) {
151
            OpenVolumeMesh::serialize(_ostr, *it) << std::endl;
152 153 154
        }
    }

Mike Kremer's avatar
Mike Kremer committed
155
    // Function to deserialize a property
156
    virtual void deserialize(std::istream& _istr) {
Mike Kremer's avatar
Mike Kremer committed
157
        for(unsigned int i = 0; i < n_elements(); ++i) {
158
            OpenVolumeMesh::deserialize(_istr, data_[i]);
Mike Kremer's avatar
Mike Kremer committed
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
public:
	// data access interface

	/// Get pointer to array (does not work for T==bool)
	const T* data() const {

		if (data_.empty())
			return 0;

		return &data_[0];
	}

	/// Get reference to property vector (be careful, improper usage, e.g. resizing, may crash)
	vector_type& data_vector() {

		return data_;
	}

	/// Access the i'th element. No range check is performed!
	reference operator[](int _idx) {
		assert(size_t(_idx) < data_.size());
		return data_[_idx];
	}

	/// Const access to the i'th element. No range check is performed!
	const_reference operator[](int _idx) const {
		assert(size_t(_idx) < data_.size());
		return data_[_idx];
	}

	/// Make a copy of self.
	OpenVolumeMeshPropertyT<T>* clone() const {
194
		OpenVolumeMeshPropertyT<T>* p = new OpenVolumeMeshPropertyT<T>(*this);
195 196 197
		return p;
	}

198 199 200 201 202 203 204 205
	typename vector_type::const_iterator begin() const { return data_.begin(); }

	typename vector_type::iterator begin() { return data_.begin(); }

	typename vector_type::const_iterator end() const { return data_.end(); }

    typename vector_type::iterator end() { return data_.end(); }

206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223
protected:

    /// Delete multiple entries in list
    virtual void delete_multiple_entries(const std::vector<bool>& _tags) {

        assert(_tags.size() == data_.size());
        vector_type new_data;
        typename vector_type::iterator d_it = data_.begin();
        std::vector<bool>::const_iterator t_it = _tags.begin();
        std::vector<bool>::const_iterator t_end = _tags.end();
        for(; t_it != t_end; ++t_it, ++d_it) {
            if(!*t_it) {
                new_data.push_back(*d_it);
            }
        }
        data_.swap(new_data);
    }

224 225 226
private:

	vector_type data_;
227 228

	const T def_;
229 230 231 232 233
};

//-----------------------------------------------------------------------------


Mike Kremer's avatar
Mike Kremer committed
234 235
/**
 * Property specialization for bool type.
236 237 238 239 240
 */
template<>
class OpenVolumeMeshPropertyT<bool> : public OpenVolumeMeshBaseProperty {
public:

241 242
    template <class PropT, class HandleT> friend class PropertyPtr;

243 244 245 246
    typedef std::vector<bool> 				vector_type;
    typedef bool 							value_type;
    typedef vector_type::reference 			reference;
    typedef vector_type::const_reference 	const_reference;
247 248 249

public:

250 251 252 253
    OpenVolumeMeshPropertyT(const std::string& _name = "<unknown>", const bool _def = bool()) :
        OpenVolumeMeshBaseProperty(_name),
        def_(_def) {
    }
254 255

public:
256
    // inherited from OpenVolumeMeshBaseProperty
257

258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275
    virtual void reserve(size_t _n) {
        data_.reserve(_n);
    }
    virtual void resize(size_t _n) {
        data_.resize(_n, def_);
    }
    virtual void clear() {
        data_.clear();
        vector_type().swap(data_);
    }
    virtual void push_back() {
        data_.push_back(def_);
    }
    virtual void swap(size_t _i0, size_t _i1) {
        bool t(data_[_i0]);
        data_[_i0] = data_[_i1];
        data_[_i1] = t;
    }
276

277
    void delete_element(size_t _idx) {
278 279 280 281 282
        data_.erase(data_.begin() + _idx);
    }

public:

283 284 285 286 287 288 289 290 291 292 293 294
    virtual size_t n_elements() const {
        return data_.size();
    }
    virtual size_t element_size() const {
        return OpenVolumeMeshBaseProperty::UnknownSize;
    }
    virtual size_t size_of() const {
        return size_of(n_elements());
    }
    virtual size_t size_of(size_t _n_elem) const {
        return _n_elem / 8 + ((_n_elem % 8) != 0);
    }
295

296 297 298 299 300
    // Function to serialize a property
    virtual void serialize(std::ostream& _ostr) const {
        for(vector_type::const_iterator it = data_.begin();
                it != data_.end(); ++it) {
            OpenVolumeMesh::serialize(_ostr, *it) << std::endl;
301
        }
302
    }
303

304 305 306 307 308 309
    // Function to deserialize a property
    virtual void deserialize(std::istream& _istr) {
        for(unsigned int i = 0; i < n_elements(); ++i) {
            value_type val;
            OpenVolumeMesh::deserialize(_istr, val);
            data_[i] = val;
310
        }
311
    }
312

313 314
public:

315 316 317 318 319
    /// Access the i'th element. No range check is performed!
    reference operator[](int _idx) {
        assert(size_t(_idx) < data_.size());
        return data_[_idx];
    }
320

321 322 323 324 325
    /// Const access to the i'th element. No range check is performed!
    const_reference operator[](int _idx) const {
        assert(size_t(_idx) < data_.size());
        return data_[_idx];
    }
326

327 328 329 330 331 332
    /// Make a copy of self.
    OpenVolumeMeshPropertyT<bool>* clone() const {
        OpenVolumeMeshPropertyT<bool>* p = new OpenVolumeMeshPropertyT<bool> (
                *this);
        return p;
    }
333

334
    vector_type::const_iterator begin() const { return data_.begin(); }
335 336 337 338 339 340 341

    vector_type::iterator begin() { return data_.begin(); }

    vector_type::const_iterator end() const { return data_.end(); }

    vector_type::iterator end() { return data_.end(); }

342 343 344 345 346 347 348
protected:

    /// Delete multiple entries in list
    virtual void delete_multiple_entries(const std::vector<bool>& _tags) {

        assert(_tags.size() == data_.size());
        vector_type new_data;
Mike Kremer's avatar
Mike Kremer committed
349
        vector_type::iterator d_it = data_.begin();
350 351 352 353 354 355 356 357 358 359
        std::vector<bool>::const_iterator t_it = _tags.begin();
        std::vector<bool>::const_iterator t_end = _tags.end();
        for(; t_it != t_end; ++t_it, ++d_it) {
            if(!*t_it) {
                new_data.push_back(*d_it);
            }
        }
        data_.swap(new_data);
    }

360 361
private:

362
    vector_type data_;
363

364
    const bool def_;
365 366 367 368 369
};

//-----------------------------------------------------------------------------


Mike Kremer's avatar
Mike Kremer committed
370 371
/**
 * Property specialization for std::string type.
372 373 374 375 376
 */
template<>
class OpenVolumeMeshPropertyT<std::string> : public OpenVolumeMeshBaseProperty {
public:

377 378
    template <class PropT, class HandleT> friend class PropertyPtr;

379 380 381 382 383
    typedef std::string 					Value;
    typedef std::vector<std::string> 		vector_type;
    typedef std::string 					value_type;
    typedef vector_type::reference 			reference;
    typedef vector_type::const_reference 	const_reference;
384 385 386

public:

387 388 389 390
    OpenVolumeMeshPropertyT(const std::string& _name = "<unknown>", const std::string& _def = "") :
        OpenVolumeMeshBaseProperty(_name),
        def_(_def) {
    }
391 392

public:
393
    // inherited from OpenVolumeMeshBaseProperty
394

395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410
    virtual void reserve(size_t _n) {
        data_.reserve(_n);
    }
    virtual void resize(size_t _n) {
        data_.resize(_n, def_);
    }
    virtual void clear() {
        data_.clear();
        vector_type().swap(data_);
    }
    virtual void push_back() {
        data_.push_back(def_);
    }
    virtual void swap(size_t _i0, size_t _i1) {
        std::swap(data_[_i0], data_[_i1]);
    }
411

412
    virtual void delete_element(size_t _idx) {
413 414 415 416 417
        data_.erase(data_.begin() + _idx);
    }

public:

418 419 420 421 422 423 424 425 426
    virtual size_t n_elements() const {
        return data_.size();
    }
    virtual size_t element_size() const {
        return OpenVolumeMeshBaseProperty::UnknownSize;
    }
    virtual size_t size_of() const {
        return sizeof(data_);
    }
427

428 429 430
    virtual size_t size_of(size_t /* _n_elem */) const {
        return OpenVolumeMeshBaseProperty::UnknownSize;
    }
431

432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452
    virtual void stats(std::ostream& _ostr) const {
        for(vector_type::const_iterator it = data_.begin();
            it != data_.end(); ++it) {
                _ostr << *it << " ";
        }
    }

    // Function to serialize a property
    virtual void serialize(std::ostream& _ostr) const {
        for(vector_type::const_iterator it = data_.begin();
                it != data_.end(); ++it) {
            OpenVolumeMesh::serialize(_ostr, *it) << std::endl;
        }
    }

    // Function to deserialize a property
    virtual void deserialize(std::istream& _istr) {
        for(unsigned int i = 0; i < n_elements(); ++i) {
            OpenVolumeMesh::deserialize(_istr, data_[i]);
        }
    }
453 454 455

public:

456 457 458
    const value_type* data() const {
        if (data_.empty())
            return 0;
459

460 461
        return (value_type*) &data_[0];
    }
462

463 464 465 466 467
    /// Access the i'th element. No range check is performed!
    reference operator[](int _idx) {
        assert(size_t(_idx) < data_.size());
        return ((value_type*) &data_[0])[_idx];
    }
468

469 470 471 472 473
    /// Const access the i'th element. No range check is performed!
    const_reference operator[](int _idx) const {
        assert(size_t(_idx) < data_.size());
        return ((value_type*) &data_[0])[_idx];
    }
474

475 476 477 478 479
    OpenVolumeMeshPropertyT<value_type>* clone() const {
        OpenVolumeMeshPropertyT<value_type>* p = new OpenVolumeMeshPropertyT<
                value_type> (*this);
        return p;
    }
480

481
    vector_type::const_iterator begin() const { return data_.begin(); }
482 483 484 485 486 487 488

    vector_type::iterator begin() { return data_.begin(); }

    vector_type::const_iterator end() const { return data_.end(); }

    vector_type::iterator end() { return data_.end(); }

489 490 491 492 493 494 495
protected:

    /// Delete multiple entries in list
    virtual void delete_multiple_entries(const std::vector<bool>& _tags) {

        assert(_tags.size() == data_.size());
        vector_type new_data;
Mike Kremer's avatar
Mike Kremer committed
496
        vector_type::iterator d_it = data_.begin();
497 498 499 500 501 502 503 504 505 506
        std::vector<bool>::const_iterator t_it = _tags.begin();
        std::vector<bool>::const_iterator t_end = _tags.end();
        for(; t_it != t_end; ++t_it, ++d_it) {
            if(!*t_it) {
                new_data.push_back(*d_it);
            }
        }
        data_.swap(new_data);
    }

507 508
private:

509
    vector_type data_;
510

511
    const std::string def_;
512 513 514 515 516 517 518
};

} // Namespace OpenVolumeMesh

//=============================================================================
#endif // OPENVOLUMEMESHPROPERTY_HH defined
//=============================================================================