DataGroup.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_DATAGROUP_H
#define SURGSIM_DATASTRUCTURES_DATAGROUP_H

#include <Eigen/Core>

#include "SurgSim/DataStructures/Image.h"
#include "SurgSim/DataStructures/NamedData.h"
#include "SurgSim/DataStructures/NamedVariantData.h"
#include "SurgSim/Math/RigidTransform.h"
#include "SurgSim/Math/Vector.h"

namespace SurgSim
{
namespace DataStructures
{

class DataGroup
{
public:
    typedef SurgSim::Math::RigidTransform3d PoseType;
    typedef SurgSim::Math::Vector3d VectorType;
    typedef Eigen::Matrix<double, Eigen::Dynamic, Eigen::Dynamic, Eigen::RowMajor> DynamicMatrixType;
    typedef double ScalarType;
    typedef int IntegerType;
    typedef bool BooleanType;
    typedef std::string StringType;
    typedef Image<float> ImageType;

    DataGroup();

    DataGroup(const DataGroup& dataGroup);

    DataGroup& operator=(const DataGroup& dataGroup);

    DataGroup& operator=(DataGroup&& dataGroup);

    NamedData<PoseType>& poses();

    const NamedData<PoseType>& poses() const;

    NamedData<VectorType>& vectors();

    const NamedData<VectorType>& vectors() const;

    NamedData<DynamicMatrixType>& matrices();

    const NamedData<DynamicMatrixType>& matrices() const;

    NamedData<ScalarType>& scalars();

    const NamedData<ScalarType>& scalars() const;

    NamedData<IntegerType>& integers();

    const NamedData<IntegerType>& integers() const;

    NamedData<BooleanType>& booleans();

    const NamedData<BooleanType>& booleans() const;

    NamedData<StringType>& strings();

    const NamedData<StringType>& strings() const;

    NamedData<ImageType>& images();

    const NamedData<ImageType>& images() const;

    NamedVariantData& customData();

    const NamedVariantData& customData() const;

    void resetAll();

    bool isEmpty() const;

private:
    NamedData<PoseType> m_poses;

    NamedData<VectorType> m_vectors;

    NamedData<DynamicMatrixType> m_matrices;

    NamedData<ScalarType> m_scalars;

    NamedData<IntegerType> m_integers;

    NamedData<BooleanType> m_booleans;

    NamedData<StringType> m_strings;

    NamedData<ImageType> m_images;

    NamedVariantData m_customData;
};

};  // namespace DataStructures
};  // namespace SurgSim

#endif  // SURGSIM_DATASTRUCTURES_DATAGROUP_H