VILLASnode/include/villas/nodes/signal_generator.hpp

/** Node-type for signal generation.
 *
 * @file
 * @author Steffen Vogel <stvogel@eonerc.rwth-aachen.de>
 * @copyright 2014-2020, 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/>.
 *********************************************************************************/

/**
 * @ingroup node
 * @addtogroup signal_generator Signal generation node-type-
 * @{
 */

#pragma once

#include <villas/timing.h>
#include <villas/task.hpp>

/* Forward declarations */
struct vnode;
struct sample;

/** Node-type for signal generation.
 * @see node_type
 */
struct signal_generator {
	struct Task task;		/**< Timer for periodic events. */
	int rt;				/**< Real-time mode? */

	enum class SignalType {
		RANDOM,
		SINE,
		SQUARE,
		TRIANGLE,
		RAMP,
		COUNTER,
		CONSTANT,
		MIXED,
		PULSE
	} *type;			/**< Signal type */

	double rate;			/**< Sampling rate. */
	double *frequency;		/**< Frequency of the generated signals. */
	double *amplitude;		/**< Amplitude of the generated signals. */
	double *stddev;			/**< Standard deviation of random signals (normal distributed). */
	double *offset;			/**< A constant bias. */
	double *pulse_width;		/**< Width of a pulse with respect to the rate (duration = pulse_width/rate) */
	double *pulse_low;		/**< Amplitude when pulse signal is off */
	double *pulse_high;		/**< Amplitude when pulse signal is on */
	double *phase;			/**< Phase (rad) offset with respect to program start */
	int monitor_missed;		/**< Boolean, if set, node counts missed steps and warns user. */

	double *last;			/**< The values from the previous period which are required for random walk. */

	unsigned values;			/**< The number of values which will be emitted by this node. */
	int limit;			/**< The number of values which should be generated by this node. <0 for infinitve. */

	struct timespec started;	/**< Point in time when this node was started. */
	unsigned counter;			/**< The number of packets already emitted. */
	unsigned missed_steps;		/**< Total number of missed steps. */
};

/** @see node_type::print */
char * signal_generator_print(struct vnode *n);

/** @see node_type::parse */
int signal_generator_parse(struct vnode *n, json_t *json);

/** @see node_type::start */
int signal_generator_start(struct vnode *n);

/** @see node_type::stop */
int signal_generator_stop(struct vnode *n);

/** @see node_type::read */
int signal_generator_read(struct vnode *n, struct sample * const smps[], unsigned cnt);

/** @} */