output.h File Reference

Generic output (signal writing/generation) functions. More...

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

Go to the source code of this file.

Typedefs
typedef struct _OutputData	OutputData
	Single output internal data structure.
typedef OutputData *	Output
	Opaque reference to output internal data structure.

Functions
Output	Output_Init (DataHandle configuration)
	Creates and initializes output data structure based on given information.
void	Output_End (Output output)
	Deallocates internal data of given output.
bool	Output_Enable (Output output)
	Allows hardware/virtual device of given output to output signal.
void	Output_Disable (Output output)
	Prevents hardware/virtual device of given output from outputing signal.
bool	Output_HasError (Output output)
	Calls underlying signal output implementation to check for errors on given output.
void	Output_Reset (Output output)
	Calls underlying signal output implementation to reset possible device errors.
void	Output_Update (Output output, double value)
	Writes specified value to given output ouput device.

Detailed Description

Generic output (signal writing/generation) functions.

Interface for configurable output writing (as shown in Motor Configuration)

Function Documentation

Output_Disable()

void Output_Disable

(

Output

output

)

Prevents hardware/virtual device of given output from outputing signal.

Parameters

[in]

output

reference to output

Output_Enable()

bool Output_Enable

(

Output

output

)

Allows hardware/virtual device of given output to output signal.

Parameters

[in]

output

reference to output

Returns

true on enabled output, false otherwise

Output_End()

void Output_End

(

Output

output

)

Deallocates internal data of given output.

Parameters

[in]

output

reference to output

Output_HasError()

bool Output_HasError

(

Output

output

)

Calls underlying signal output implementation to check for errors on given output.

Parameters

[in]

output

reference to output

Returns

true on detected error, false otherwise

Output_Init()

Output Output_Init

(

DataHandle

configuration

)

Creates and initializes output data structure based on given information.

Parameters

[in]

configuration

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

Returns

reference/pointer to newly created and initialized output data structure

Output_Reset()

void Output_Reset

(

Output

output

)

Calls underlying signal output implementation to reset possible device errors.

Parameters

[in]

output

reference to output

Output_Update()

void Output_Update	(	Output	output,
		double	value )

Writes specified value to given output ouput device.

Parameters

[in]	output	reference to output
[in]	value	value to be written/generated