classification.hpp

Go to the documentation of this file.

/******************************************************************************
 * $Id$
 *
 * Project:  libLAS - http://liblas.org - A BSD library for LAS format data.
 * Purpose:  Definition of LASClassification type.
 * Author:   Mateusz Loskot, mateusz@loskot.net
 *
 ******************************************************************************
 * Copyright (c) 2009, Mateusz Loskot
 *
 * All rights reserved.
 * 
 * Redistribution and use in source and binary forms, with or without 
 * modification, are permitted provided that the following 
 * conditions are met:
 * 
 *     * Redistributions of source code must retain the above copyright 
 *       notice, this list of conditions and the following disclaimer.
 *     * Redistributions in binary form must reproduce the above copyright 
 *       notice, this list of conditions and the following disclaimer in 
 *       the documentation and/or other materials provided 
 *       with the distribution.
 *     * Neither the name of the Martin Isenburg or Iowa Department 
 *       of Natural Resources nor the names of its contributors may be 
 *       used to endorse or promote products derived from this software 
 *       without specific prior written permission.
 * 
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS 
 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE 
 * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, 
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, 
 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS 
 * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED 
 * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, 
 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT 
 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY 
 * OF SUCH DAMAGE.
 ****************************************************************************/

#ifndef LIBLAS_LASCLASSIFICATION_HPP_INCLUDED
#define LIBLAS_LASCLASSIFICATION_HPP_INCLUDED

#include <liblas/export.hpp>
// std
#include <cassert>
#include <cstddef>
#include <bitset>
#include <ostream>
#include <sstream>
#include <stdexcept>
#include <stdint.h>

// I hate you windows
#ifdef _MSC_VER
#ifdef GetClassName
#undef GetClassName
#endif
#endif

namespace liblas {

class LAS_DLL Classification
{
public:

    typedef std::bitset<8> bitset_type;


    static uint32_t const class_table_size;

    enum BitPosition
    {
        eClassBit     = 0, 
        eSyntheticBit = 5, 
        eKeyPointBit  = 6, 
        eWithheldBit  = 7  
    };

    Classification() {}

    explicit Classification(bitset_type const& flags)
        : m_flags(flags)
    {}

    explicit Classification(uint8_t const& flags)
        : m_flags(flags)
    {}

    Classification(uint32_t cls, bool s, bool k, bool w)
    {
        SetClass(cls);
        SetSynthetic(s);
        SetKeyPoint(k);
        SetWithheld(w);
    }

    Classification(Classification const& other)
    {
        m_flags = other.m_flags;
    }

    Classification& operator=(Classification const& rhs)
    {
        if (&rhs != this)
        {    
            m_flags = rhs.m_flags;
        }
        return *this;
    }

    operator bitset_type() const
    {
        return bitset_type(m_flags);
    }
    
    bitset_type GetFlags() const
    {
        return bitset_type(m_flags);
    }

    std::string GetClassName() const;

    uint8_t GetClass() const;

    void SetClass(uint32_t index);

    void SetSynthetic(bool flag)
    {
        m_flags[eSyntheticBit] = flag;
    }

    bool IsSynthetic() const
    {
        return m_flags[eSyntheticBit];
    }

    void SetKeyPoint(bool flag)
    {
        m_flags[eKeyPointBit] = flag;
    }

    bool IsKeyPoint() const
    {
        return m_flags[eKeyPointBit];
    }

    void SetWithheld(bool flag)
    {
        m_flags[eWithheldBit] = flag;
    }

    bool IsWithheld() const
    {
        return m_flags[eWithheldBit];
    }

    bool equal(Classification const& other) const
    {
        return (other.m_flags == m_flags);
    }

private:

    bitset_type m_flags;

    void check_class_index(uint32_t index) const;
};

inline bool operator==(Classification const& lhs, Classification const& rhs)
{
    return lhs.equal(rhs);
}

inline bool operator!=(Classification const& lhs, Classification const& rhs)
{
    return (!(lhs == rhs));
}

inline std::ostream& operator<<(std::ostream& os, Classification const& cls)
{
    Classification::bitset_type flags(cls);
    return (os << flags);
}

} // namespace liblas

#endif // LIBLAS_LASCLASSIFICATION_HPP_INCLUDED