/** Message source
 *
 * @file
 * @author Steffen Vogel <stvogel@eonerc.rwth-aachen.de>
 * @copyright 2014-2022, Institute for Automation of Complex Power Systems, EONERC
 * @license GNU General Public License (version 3)
 *
 * VILLASnode
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *********************************************************************************/

#pragma once

#include <vector>
#include <memory>

#include <villas/mapping_list.hpp>
#include <villas/pool.hpp>

namespace villas {
namespace node {

/* Forward declarations */
struct Sample;
class Node;
class Path;

class PathSource {
	friend Path;

public:
	using Ptr = std::shared_ptr<PathSource>;

protected:
	Node *node;
	Path *path;

	bool masked;

	struct Pool pool;

	MappingList mappings;				/**< List of mappings (struct MappingEntry). */

public:
	PathSource(Path *p, Node *n);
	virtual ~PathSource();

	void check();

	int read(int i);

	virtual
	void writeToSecondaries(struct Sample *smps[], unsigned cnt)
	{ }

	Node * getNode() const
	{
		return node;
	}

	Path * getPath() const
	{
		return path;
	}
};

using PathSourceList = std::vector<PathSource::Ptr>;

class SecondaryPathSource : public PathSource {

protected:
	PathSource::Ptr master;

public:
	using Ptr = std::shared_ptr<SecondaryPathSource>;

	SecondaryPathSource(Path *p, Node *n, NodeList &nodes, PathSource::Ptr master);
};

using SecondaryPathSourceList = std::vector<SecondaryPathSource::Ptr>;

class MasterPathSource : public PathSource {

protected:
	SecondaryPathSourceList secondaries;	/**< List of secondary path sources (PathSource). */

public:
	MasterPathSource(Path *p, Node *n);

	void addSecondary(SecondaryPathSource::Ptr ps)
	{
		secondaries.push_back(ps);
	}

	SecondaryPathSourceList getSecondaries()
	{
		return secondaries;
	}

	virtual
	void writeToSecondaries(struct Sample *smps[], unsigned cnt);
};



} /* namespace node */
} /* namespace villas */