Signal

Detailed Description

Note: To read/write signals, see stream assistant

Modules
	Signal list

Typedefs
typedef struct ed247_internal_signal_t *	ed247_signal_t
	Signal identifier.

Enumerations
enum	ed247_signal_type_t {   ED247_SIGNAL_TYPE__INVALID,   ED247_SIGNAL_TYPE_ANALOG = ED247_STREAM_TYPE_ANALOG,   ED247_SIGNAL_TYPE_DISCRETE = ED247_STREAM_TYPE_DISCRETE,   ED247_SIGNAL_TYPE_NAD = ED247_STREAM_TYPE_NAD,   ED247_SIGNAL_TYPE_VNAD = ED247_STREAM_TYPE_VNAD }
	Signal types.
enum	ed247_nad_type_t {   ED247_NAD_TYPE__INVALID,   ED247_NAD_TYPE_INT8,   ED247_NAD_TYPE_INT16,   ED247_NAD_TYPE_INT32,   ED247_NAD_TYPE_INT64,   ED247_NAD_TYPE_UINT8,   ED247_NAD_TYPE_UINT16,   ED247_NAD_TYPE_UINT32,   ED247_NAD_TYPE_UINT64,   ED247_NAD_TYPE_FLOAT32,   ED247_NAD_TYPE_FLOAT64,   ED247_NAD_TYPE__COUNT }
	NAD type.
enum	ed247_discrete_t {   ED247_DISCRETE_FALSE = 0x00,   ED247_DISCRETE_TRUE = 0xFF }
	Discrete values to be used.

Functions
LIBED247_EXPORT uint32_t	ed247_nad_type_size (ed247_nad_type_t nad_type)
	Size of a single element of ed247_nad_type_t. More...
LIBED247_EXPORT ed247_status_t	ed247_signal_set_user_data (ed247_signal_t signal, void *user_data)
	Assign user data to the signal. More...
LIBED247_EXPORT ed247_status_t	ed247_signal_get_user_data (ed247_signal_t signal, void **user_data)
	Retrieve user data assigned to the signal. More...
LIBED247_EXPORT ed247_status_t	ed247_signal_get_stream (ed247_signal_t signal, ed247_stream_t *stream)
	Get the stream that contain this signal. More...
LIBED247_EXPORT ed247_status_t	ed247_signal_get_assistant (ed247_signal_t signal, ed247_stream_assistant_t *assistant)
	Get the stream assistant associated with this signal. More...
LIBED247_EXPORT ed247_status_t	ed247_signal_allocate_sample (ed247_signal_t signal, void **sample_data, uint32_t *sample_size)
	Allocate a sample to store one signal. More...
LIBED247_EXPORT const char *	ed247_signal_get_name (ed247_signal_t signal)
LIBED247_EXPORT const char *	ed247_signal_get_comment (ed247_signal_t signal)
LIBED247_EXPORT const char *	ed247_signal_get_icd (ed247_signal_t signal)
LIBED247_EXPORT ed247_signal_type_t	ed247_signal_get_type (ed247_signal_t signal)
LIBED247_EXPORT uint32_t	ed247_signal_get_byte_offset (ed247_signal_t signal)
	Meaningless for VNAD.
LIBED247_EXPORT const char *	ed247_signal_analogue_get_electrical_unit (ed247_signal_t analogue_signal)
LIBED247_EXPORT ed247_nad_type_t	ed247_signal_nad_get_type (ed247_signal_t nad_signal)
	For NAD and VNAD.
LIBED247_EXPORT const char *	ed247_signal_nad_get_unit (ed247_signal_t nad_signal)
	For NAD and VNAD.
LIBED247_EXPORT uint32_t	ed247_signal_nad_get_dimensions_count (ed247_signal_t nad_signal)
LIBED247_EXPORT uint32_t	ed247_signal_nad_get_dimension (ed247_signal_t nad_signal, uint32_t dimention_id)
LIBED247_EXPORT uint32_t	ed247_signal_vnad_get_position (ed247_signal_t vnad_signal)
LIBED247_EXPORT uint32_t	ed247_signal_vnad_get_max_number (ed247_signal_t vnad_signal)

Function Documentation

LIBED247_EXPORT uint32_t ed247_nad_type_size

(

ed247_nad_type_t

nad_type

)

Size of a single element of ed247_nad_type_t.

Parameters

[in]

nad_type

The NAD type

Returns

The size of the NAD type element (sizeof equivalent)

LIBED247_EXPORT ed247_status_t ed247_signal_set_user_data	(	ed247_signal_t	signal,
		void *	user_data
	)

Assign user data to the signal.

Memory has to be free by the user.

Parameters

[in]	signal	The signal identifier
[in]	user_data	Pointer to user data

Return values

ED247_STATUS_SUCCESS
ED247_STATUS_FAILURE

LIBED247_EXPORT ed247_status_t ed247_signal_get_user_data	(	ed247_signal_t	signal,
		void **	user_data
	)

Retrieve user data assigned to the signal.

Parameters

[in]	signal	The signal identifier
[out]	user_data	Pointer to host pointer to user data

Return values

ED247_STATUS_SUCCESS
ED247_STATUS_FAILURE

LIBED247_EXPORT ed247_status_t ed247_signal_get_stream	(	ed247_signal_t	signal,
		ed247_stream_t *	stream
	)

Get the stream that contain this signal.

Parameters

[in]	signal	The signal identifier
[out]	stream	The stream identifier

Return values

ED247_STATUS_SUCCESS
ED247_STATUS_FAILURE

Here is the caller graph for this function:

LIBED247_EXPORT ed247_status_t ed247_signal_get_assistant	(	ed247_signal_t	signal,
		ed247_stream_assistant_t *	assistant
	)

Get the stream assistant associated with this signal.

Calling this method is the same as calling ed247_signal_get_stream() then ed247_stream_get_assistant()

Parameters

[in]	signal
[out]	assistant

Return values

ED247_STATUS_SUCCESS
ED247_STATUS_FAILURE

Here is the call graph for this function:

LIBED247_EXPORT ed247_status_t ed247_signal_allocate_sample	(	ed247_signal_t	signal,
		void **	sample_data,
		uint32_t *	sample_size
	)

Allocate a sample to store one signal.

For VNAD, the allcated size is the max signal size.
Memory has to be released with ed247_signal_free_sample().

Parameters

[in]	signal	Signal identifier
[out]	sample_data	Pointer to the allocated memory
[out]	sample_size	Size of the memory allocated for the sample

Return values

ED247_STATUS_SUCCESS
ED247_STATUS_FAILURE