header.hpp

Go to the documentation of this file.

/******************************************************************************
 * $Id$
 *
 * Project:  libLAS - http://liblas.org - A BSD library for LAS format data.
 * Purpose:  LAS header class 
 * Author:   Mateusz Loskot, mateusz@loskot.net
 *
 ******************************************************************************
 * Copyright (c) 2010, Mateusz Loskot
 * Copyright (c) 2008, Phil Vachon
 *
 * 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_LASHEADER_HPP_INCLUDED
#define LIBLAS_LASHEADER_HPP_INCLUDED

#include <boost/uuid/uuid.hpp>
#include <liblas/bounds.hpp>
#include <liblas/schema.hpp>
#include <liblas/spatialreference.hpp>
#include <liblas/variablerecord.hpp>
#include <liblas/version.hpp>
#include <liblas/external/property_tree/ptree.hpp>
#include <liblas/export.hpp>
#include <liblas/detail/singleton.hpp>
// boost
#include <boost/foreach.hpp>
#include <boost/uuid/uuid.hpp>
#include <boost/uuid/uuid_generators.hpp>
#include <boost/uuid/uuid_io.hpp>

//std
#include <cstddef>
#include <string>
#include <vector>
#include <sstream>
#include <cmath>

namespace liblas {

class LAS_DLL Header
{
public:

    static char const* const FileSignature;

    static char const* const SystemIdentifier;

    static char const* const SoftwareIdentifier;

    typedef std::vector<uint32_t> RecordsByReturnArray;

    Header();

    Header(Header const& other);

    Header& operator=(Header const& rhs);
    
    bool operator==(const Header& other) const;

    std::string GetFileSignature() const;

    void SetFileSignature(std::string const& v);

    uint16_t GetFileSourceId() const;

    void SetFileSourceId(uint16_t v);

    uint16_t GetReserved() const;

    void SetReserved(uint16_t v);

    boost::uuids::uuid GetProjectId() const;

    void SetProjectId(boost::uuids::uuid const& v);

    uint8_t GetVersionMajor() const;

    void SetVersionMajor(uint8_t v);

    uint8_t GetVersionMinor() const;

    void SetVersionMinor(uint8_t v);

    std::string GetSystemId(bool pad = false) const;

    void SetSystemId(std::string const& v);

    std::string GetSoftwareId(bool pad = false) const;

    void SetSoftwareId(std::string const& v);

    uint16_t GetCreationDOY() const;

    void SetCreationDOY(uint16_t v);

    uint16_t GetCreationYear() const;

    void SetCreationYear(uint16_t v);

    uint16_t GetHeaderSize() const;

    void SetHeaderSize(uint16_t v);
    
    uint32_t GetDataOffset() const;

    void SetDataOffset(uint32_t v);

    uint32_t GetHeaderPadding() const;

    void SetHeaderPadding(uint32_t v);

    uint32_t GetRecordsCount() const;

    void SetRecordsCount(uint32_t v);
    
    PointFormatName GetDataFormatId() const;

    void SetDataFormatId(PointFormatName v);

    uint16_t GetDataRecordLength() const;
    
    uint32_t GetPointRecordsCount() const;

    void SetPointRecordsCount(uint32_t v);
    
    RecordsByReturnArray const& GetPointRecordsByReturnCount() const;

    void SetPointRecordsByReturnCount(std::size_t index, uint32_t v);
    
    double GetScaleX() const;

    double GetScaleY() const;
    
    double GetScaleZ() const;

    void SetScale(double x, double y, double z);

    double GetOffsetX() const;
    
    double GetOffsetY() const;
    
    double GetOffsetZ() const;

    void SetOffset(double x, double y, double z);

    double GetMaxX() const;

    double GetMinX() const;

    double GetMaxY() const;

    double GetMinY() const;

    double GetMaxZ() const;

    double GetMinZ() const;

    void SetMax(double x, double y, double z);

    void SetMin(double x, double y, double z);

    void AddVLR(VariableRecord const& v);
    
    VariableRecord const& GetVLR(uint32_t index) const;
    
    const std::vector<VariableRecord>& GetVLRs() const;

    void DeleteVLR(uint32_t index);
    void DeleteVLRs(std::string const& name, uint16_t id);

    void SetGeoreference();
    
    SpatialReference GetSRS() const;
    
    void SetSRS(SpatialReference& srs);
    
    Schema const& GetSchema() const;

    void SetSchema(const Schema& format);

    const Bounds<double>& GetExtent() const;

    void SetExtent(Bounds<double> const& extent);

    liblas::property_tree::ptree GetPTree() const;
    
    bool Compressed() const;

    void SetCompressed(bool b);
    
    uint32_t GetVLRBlockSize() const;

    void to_rst(std::ostream& os) const;
    void to_xml(std::ostream& os) const;
    void to_json(std::ostream& os) const;
    
private:
    
    typedef detail::Point<double> PointScales;
    typedef detail::Point<double> PointOffsets;

    enum
    {
        eDataSignatureSize = 2,
        eFileSignatureSize = 4,
        ePointsByReturnSize = 7,
        eProjectId4Size = 8,
        eSystemIdSize = 32,
        eSoftwareIdSize = 32,
        eHeaderSize = 227, 
        eFileSourceIdMax = 65535
    };

    // TODO (low-priority): replace static-size char arrays
    // with std::string and return const-reference to string object.
    
    //
    // Private function members
    //
    void Init();

    //
    // Private data members
    //
    char m_signature[eFileSignatureSize]; // TODO: replace with boost::array --mloskot
    boost::uint16_t m_sourceId;
    boost::uint16_t m_reserved;
    boost::uuids::uuid m_projectGuid;
    // boost::uint32_t m_projectId1;
    // boost::uint16_t m_projectId2;
    // boost::uint16_t m_projectId3;
    // boost::uint8_t m_projectId4[eProjectId4Size];
    boost::uint8_t m_versionMajor;
    boost::uint8_t m_versionMinor;

    char m_systemId[eSystemIdSize]; // TODO: replace with boost::array --mloskot
    char m_softwareId[eSoftwareIdSize];
    uint16_t m_createDOY;
    uint16_t m_createYear;
    uint16_t m_headerSize;
    uint32_t m_dataOffset;
    uint32_t m_recordsCount;
    uint32_t m_pointRecordsCount;
    RecordsByReturnArray m_pointRecordsByReturn;
    PointScales m_scales;
    PointOffsets m_offsets;
    Bounds<double> m_extent;
    std::vector<VariableRecord> m_vlrs;
    SpatialReference m_srs;
    Schema m_schema;
    bool m_isCompressed;
    uint32_t m_headerPadding;
};

LAS_DLL std::ostream& operator<<(std::ostream& os, liblas::Header const&);

class LAS_DLL DefaultHeader : public Singleton<Header>
{
public:
    ~DefaultHeader() {}


protected:
    DefaultHeader();
    DefaultHeader( DefaultHeader const&);
    DefaultHeader& operator=( DefaultHeader const&);
    
};


} // namespace liblas

#endif // LIBLAS_LASHEADER_HPP_INCLUDED