DataGroupBuilder.h

// This file is a part of the OpenSurgSim project.
// Copyright 2012-2013, SimQuest Solutions Inc.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

#ifndef SURGSIM_DATASTRUCTURES_DATAGROUPBUILDER_H
#define SURGSIM_DATASTRUCTURES_DATAGROUPBUILDER_H

#include "SurgSim/DataStructures/NamedDataBuilder.h"
#include "SurgSim/DataStructures/NamedVariantData.h"
#include "SurgSim/DataStructures/DataGroup.h"
#include <Eigen/Core>

namespace SurgSim
{
namespace DataStructures
{

class DataGroupBuilder
{
public:
    typedef DataGroup::PoseType PoseType;
    typedef DataGroup::VectorType VectorType;
    typedef DataGroup::DynamicMatrixType DynamicMatrixType;
    typedef DataGroup::ScalarType ScalarType;
    typedef DataGroup::IntegerType IntegerType;
    typedef DataGroup::BooleanType BooleanType;
    typedef DataGroup::StringType StringType;
    typedef Image<float> ImageType;

    DataGroupBuilder();

    DataGroup createData() const;

    std::shared_ptr<DataGroup> createSharedData() const;

    NamedDataBuilder<PoseType>& poses();

    const NamedDataBuilder<PoseType>& poses() const;

    NamedDataBuilder<VectorType>& vectors();

    const NamedDataBuilder<VectorType>& vectors() const;

    NamedDataBuilder<DynamicMatrixType>& matrices();

    const NamedDataBuilder<DynamicMatrixType>& matrices() const;

    NamedDataBuilder<ScalarType>& scalars();

    const NamedDataBuilder<ScalarType>& scalars() const;

    NamedDataBuilder<IntegerType>& integers();

    const NamedDataBuilder<IntegerType>& integers() const;

    NamedDataBuilder<BooleanType>& booleans();

    const NamedDataBuilder<BooleanType>& booleans() const;

    NamedDataBuilder<StringType>& strings();

    const NamedDataBuilder<StringType>& strings() const;

    NamedDataBuilder<ImageType>& images();

    const NamedDataBuilder<ImageType>& images() const;

    NamedVariantDataBuilder& customData();

    const NamedVariantDataBuilder& customData() const;

    void addPose(const std::string& name);

    void addVector(const std::string& name);

    void addMatrix(const std::string& name);

    void addScalar(const std::string& name);

    void addInteger(const std::string& name);

    void addBoolean(const std::string& name);

    void addString(const std::string& name);

    void addImage(const std::string& name);

    void addCustom(const std::string& name);

    void addEntriesFrom(const DataGroupBuilder& builder);

    void addEntriesFrom(const DataGroup& data);

private:
    // Prevent copy construction and copy assignment.
    DataGroupBuilder(const DataGroupBuilder&);
    DataGroupBuilder& operator=(const DataGroupBuilder&);

    NamedDataBuilder<PoseType> m_poses;

    NamedDataBuilder<VectorType> m_vectors;

    NamedDataBuilder<DynamicMatrixType> m_matrices;

    NamedDataBuilder<ScalarType> m_scalars;

    NamedDataBuilder<IntegerType> m_integers;

    NamedDataBuilder<BooleanType> m_booleans;

    NamedDataBuilder<StringType> m_strings;

    NamedDataBuilder<ImageType> m_images;

    NamedVariantDataBuilder m_customData;
};

};  // namespace Input
};  // namespace SurgSim

#endif  // SURGSIM_DATASTRUCTURES_DATAGROUPBUILDER_H