ScanProjectSchema.hpp

Go to the documentation of this file.

#ifndef SCANPROJECTPARSER_HPP_
#define SCANPROJECTPARSER_HPP_

#include <string>
#include <tuple>

#include <boost/optional.hpp>

#include <yaml-cpp/yaml.h>
namespace lvr2
{

using StringOptional = boost::optional<std::string>;
using NodeOptional = boost::optional<YAML::Node>;

struct Description
{
    StringOptional groupName;
    StringOptional dataSetName;
    StringOptional metaName;
    NodeOptional metaData;
};

std::pair<std::string, std::string> getNames(
    const std::string& defaultGroup, 
    const std::string& defaultContainer, 
    const Description& d);

class ScanProjectSchema
{
public:
    ScanProjectSchema() {}

    ~ScanProjectSchema() = default;

    virtual Description scanProject() const = 0;
    virtual Description position(const size_t& scanPosNo) const = 0;
    virtual Description scan(const size_t& scanPosNo, const size_t& scanNo) const = 0;
    virtual Description scan(const std::string& scanPositionPath, const size_t& scanNo) const = 0;
    
    virtual Description scanCamera(const size_t& scanPositionNo, const size_t& camNo) const = 0;
    virtual Description scanCamera(const std::string& scanPositionPath, const size_t& camNo) const = 0;
 
    virtual Description scanImage(
        const size_t& scanPosNo, const size_t& scanNo,
        const size_t& scanCameraNo, const size_t& scanImageNo) const = 0;

    virtual Description scanImage(
        const std::string& scanImagePath, const size_t& scanImageNo) const = 0;

    virtual Description hyperspectralCamera(const size_t& position) const
    {
        return Description();
    }

    virtual Description hyperSpectralTimestamps(const std::string& group) const
    {
        Description d;
        // Timestamps should be in the same group as the 
        d.groupName = group;
        d.dataSetName = "timestamps";
        d.metaData = boost::none; 
    }

    virtual Description hyperSpectralFrames(const std::string& group) const
    {
        Description d;
        // Timestamps should be in the same group as the 
        d.groupName = group;
        d.dataSetName = "frames";
        d.metaData = boost::none; 
    }
protected:
    
};

class HDF5Schema : public ScanProjectSchema 
{
public:
    HDF5Schema() {}
};

class DirectorySchema : public ScanProjectSchema
{
public:
    DirectorySchema() {}
};

using ScanProjectSchemaPtr = std::shared_ptr<ScanProjectSchema>;
using DirectorySchemaPtr = std::shared_ptr<DirectorySchema>;
using HDF5SchemaPtr = std::shared_ptr<HDF5Schema>;

} // namespace lvr2

#endif