input.h File Reference

Generic input (measurement reading) functions. More...

#include "signal_processing/signal_processing.h"
#include "data_io/interface/data_io.h"
#include <stdbool.h>

Go to the source code of this file.

Typedefs
typedef struct _InputData	InputData
	Single input internal data structure.
typedef InputData *	Input
	Opaque reference to input internal data structure.

Functions
Input	Input_Init (DataHandle configuration)
	Creates and initializes input data structure based on given information.
void	Input_End (Input input)
	Deallocates internal data of given input.
double	Input_Update (Input input)
	Performs single reading and processing of signal measured by given input.
bool	Input_HasError (Input input)
	Calls underlying signal reading implementation (plugin) to check for errors on given input.
void	Input_Reset (Input input)
	Resets signal processing state and possible input device errors.
void	Input_SetState (Input input, enum SigProcState newProcessingState)
	Sets current processing phase/state/mode of given input.

Detailed Description

Generic input (measurement reading) functions.

Interface for configurable input reading and state change (as shown in Sensor Configuration)

Function Documentation

Input_End()

void Input_End

(

Input

input

)

Deallocates internal data of given input.

Parameters

[in]

input

reference to input

Input_HasError()

bool Input_HasError

(

Input

input

)

Calls underlying signal reading implementation (plugin) to check for errors on given input.

Parameters

[in]

input

reference to input

Returns

true on detected error, false otherwise

Input_Init()

Input Input_Init

(

DataHandle

configuration

)

Creates and initializes input data structure based on given information.

Parameters

[in]

configuration

reference to data object containing configuration parameters, as explained at Sensor Configuration

Returns

reference/pointer to newly created and initialized input data structure

Input_Reset()

void Input_Reset

(

Input

input

)

Resets signal processing state and possible input device errors.

Parameters

[in]

input

reference to input

Input_SetState()

void Input_SetState	(	Input	input,
		enum SigProcState	newProcessingState )

Sets current processing phase/state/mode of given input.

Parameters

[in]	input	reference to input
[in]	newProcessingState	desired signal processing phase

Input_Update()

double Input_Update

(

Input

input

)

Performs single reading and processing of signal measured by given input.

Parameters

[in]

input

reference to input

Returns

current value of processed signal (0.0 on erros)