TreeNode.h

// This file is a part of the OpenSurgSim project.
// Copyright 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_TREENODE_H
#define SURGSIM_DATASTRUCTURES_TREENODE_H

#include <vector>
#include <memory>

#include "SurgSim/DataStructures/TreeVisitor.h"

namespace SurgSim
{

namespace DataStructures
{

class TreeData;


class TreeNode
{
public:
    TreeNode();

    virtual ~TreeNode();

    void setData(std::shared_ptr<TreeData> data);

    const std::shared_ptr<TreeData>& getData() const;

    size_t getNumChildren() const;

    std::shared_ptr<TreeNode>& getChild(size_t index);

    void accept(TreeVisitor* visitor);

    bool operator==(const TreeNode& node) const;

    bool operator!=(const TreeNode& node) const;

protected:

    virtual bool isEqual(const TreeNode& node) const;

    virtual bool doAccept(TreeVisitor* visitor) = 0;

    void setNumChildren(size_t numChildren);

    void addChild(const std::shared_ptr<TreeNode>& node);

    void addChild(const std::shared_ptr<TreeNode>&& node);

    void setChild(size_t index, const std::shared_ptr<TreeNode>& node);

private:

    std::vector<std::shared_ptr<TreeNode>> m_children;

    std::shared_ptr<TreeData> m_data;
};

};  // namespace DataStructures

};  // namespace SurgSim

#endif  // SURGSIM_DATASTRUCTURES_TREENODE_H