outofcore_base_data.h

Go to the documentation of this file.

/*
 * Software License Agreement (BSD License)
 *
 *  Point Cloud Library (PCL) - www.pointclouds.org
 *  Copyright (c) 2010-2012, Willow Garage, Inc.
 *
 *  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 Willow Garage, Inc. 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.
 *
 *  $Id$
 */

#ifndef PCL_OUTOFCORE_OCTREE_BASE_METADATA_H_
#define PCL_OUTOFCORE_OCTREE_BASE_METADATA_H_

#include <pcl/pcl_macros.h>
#include <pcl/outofcore/boost.h>
#include <pcl/outofcore/cJSON.h>

#include <pcl/common/eigen.h>

#include <pcl/outofcore/metadata.h>

//standard library
#include <string>

namespace pcl
{
  namespace outofcore
  {
    class PCL_EXPORTS OutofcoreOctreeBaseMetadata : public OutofcoreAbstractMetadata
    {
      public:
        OutofcoreOctreeBaseMetadata ();
        OutofcoreOctreeBaseMetadata (const boost::filesystem::path& path_arg);
        ~OutofcoreOctreeBaseMetadata ();

        OutofcoreOctreeBaseMetadata (const OutofcoreOctreeBaseMetadata& orig);

        int 
        getOutofcoreVersion () const;
        void 
        setOutofcoreVersion (const int version);

        boost::filesystem::path 
        getMetadataFilename () const;
        void 
        setMetadataFilename (const boost::filesystem::path& path_to_metadata);
                
        virtual void 
        serializeMetadataToDisk ();

        virtual int
        loadMetadataFromDisk ();
        virtual int
        loadMetadataFromDisk (const boost::filesystem::path& path_to_metadata);

        virtual std::string
        getOctreeName ();
        virtual void
        setOctreeName (const std::string& name_arg);

        virtual std::string
        getPointType ();
        virtual void
        setPointType (const std::string& point_type_arg);

        virtual std::vector<boost::uint64_t>&
        getLODPoints ();
        virtual std::vector<boost::uint64_t>
        getLODPoints () const;
        virtual boost::uint64_t
        getLODPoints (const boost::uint64_t& depth_index) const;
        
        virtual void
        setLODPoints (const boost::uint64_t& depth);
        virtual void
        setLODPoints (std::vector<boost::uint64_t>& lod_points_arg);

        virtual void
        setLODPoints (const boost::uint64_t& lod_index_arg, const boost::uint64_t& num_points_arg, const bool increment=true);
        
        virtual void
        setCoordinateSystem (const std::string& coordinate_system);
        virtual std::string
        getCoordinateSystem () const;

        virtual void
        setDepth (const boost::uint64_t& depth_arg);
        virtual boost::uint64_t
        getDepth () const;

        friend std::ostream& 
        operator<<(std::ostream& os, const OutofcoreOctreeBaseMetadata& metadata_arg);

      protected:
        boost::filesystem::path metadata_filename_;

        int outofcore_version_;

        std::string coordinate_system_;

        std::string tree_name_;

        std::string point_type_;
        
        boost::uint64_t levels_of_depth_;
        
        std::vector<boost::uint64_t> LOD_num_points_;

        virtual void
        writeMetadataString (std::vector<char>& buf);
    };
  }//namespace outofcore
}//namespace pcl
  
#endif // PCL_OUTOFCORE_OCTREE_BASE_METADATA_H_