mirror of
https://git.rwth-aachen.de/acs/public/villas/node/
synced 2025-03-09 00:00:00 +01:00
95 lines
3 KiB
C++
95 lines
3 KiB
C++
/** Node type: File
|
|
*
|
|
* @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/>.
|
|
*********************************************************************************/
|
|
|
|
/**
|
|
* @addtogroup file File-IO node type
|
|
* @ingroup node
|
|
* @{
|
|
*/
|
|
|
|
#pragma once
|
|
|
|
#include <cstdio>
|
|
|
|
#include <villas/format.hpp>
|
|
#include <villas/task.hpp>
|
|
|
|
/* Forward declarations */
|
|
struct vnode;
|
|
|
|
#define FILE_MAX_PATHLEN 512
|
|
|
|
struct file {
|
|
villas::node::Format *formatter;
|
|
FILE *stream_in;
|
|
FILE *stream_out;
|
|
|
|
char *uri_tmpl; /**< Format string for file name. */
|
|
char *uri; /**< Real file name. */
|
|
char *mode; /**< File access mode. */
|
|
|
|
unsigned skip_lines; /**< Skip the first n-th lines/samples of the file. */
|
|
int flush; /**< Flush / upload file contents after each write. */
|
|
struct Task task; /**< Timer file descriptor. Blocks until 1 / rate seconds are elapsed. */
|
|
double rate; /**< The read rate. */
|
|
size_t buffer_size_out; /**< Defines size of output stream buffer. No buffer is created if value is set to zero. */
|
|
size_t buffer_size_in; /**< Defines size of input stream buffer. No buffer is created if value is set to zero. */
|
|
|
|
enum class EpochMode {
|
|
DIRECT,
|
|
WAIT,
|
|
RELATIVE,
|
|
ABSOLUTE,
|
|
ORIGINAL
|
|
} epoch_mode; /**< Specifies how file::offset is calculated. */
|
|
|
|
enum class EOFBehaviour {
|
|
STOP, /**< Terminate when EOF is reached. */
|
|
REWIND, /**< Rewind the file when EOF is reached. */
|
|
SUSPEND /**< Blocking wait when EOF is reached. */
|
|
} eof_mode;
|
|
|
|
struct timespec first; /**< The first timestamp in the file file::{read,write}::uri */
|
|
struct timespec epoch; /**< The epoch timestamp from the configuration. */
|
|
struct timespec offset; /**< An offset between the timestamp in the input file and the current time */
|
|
};
|
|
|
|
/** @see node_type::print */
|
|
char * file_print(struct vnode *n);
|
|
|
|
/** @see node_type::parse */
|
|
int file_parse(struct vnode *n, json_t *json);
|
|
|
|
/** @see node_type::start */
|
|
int file_start(struct vnode *n);
|
|
|
|
/** @see node_type::stop */
|
|
int file_stop(struct vnode *n);
|
|
|
|
/** @see node_type::read */
|
|
int file_read(struct vnode *n, struct sample * const smps[], unsigned cnt);
|
|
|
|
/** @see node_type::write */
|
|
int file_write(struct vnode *n, struct sample * const smps[], unsigned cnt);
|
|
|
|
/** @} */
|