mcl_timeseries_value_list.h File Reference

Timeseries value list module interface header file. More...

#include "mcl_connectivity/mcl_timeseries_value.h"

Include dependency graph for mcl_timeseries_value_list.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Typedefs
typedef struct mcl_timeseries_value_list_t	mcl_timeseries_value_list_t

Enumerations
enum	E_MCL_TIMESERIES_VALUE_LIST_PARAMETER { MCL_TIMESERIES_VALUE_LIST_PARAMETER_TIMESTAMP_ISO8601, MCL_TIMESERIES_VALUE_LIST_PARAMETER_TIMESTAMP_EPOCH, MCL_TIMESERIES_VALUE_LIST_PARAMETER_END }

Functions
MCL_CONNECTIVITY_EXPORT mcl_error_t	mcl_timeseries_value_list_initialize (mcl_timeseries_value_list_t **timeseries_value_list)
MCL_CONNECTIVITY_EXPORT mcl_error_t	mcl_timeseries_value_list_set_parameter (mcl_timeseries_value_list_t *timeseries_value_list, E_MCL_TIMESERIES_VALUE_LIST_PARAMETER parameter, const void *value)
MCL_CONNECTIVITY_EXPORT mcl_error_t	mcl_timeseries_value_list_add_value (mcl_timeseries_value_list_t *timeseries_value_list, mcl_timeseries_value_t *timeseries_value)
MCL_CONNECTIVITY_EXPORT void	mcl_timeseries_value_list_destroy (mcl_timeseries_value_list_t **timeseries_value_list)

Detailed Description

Timeseries value list module interface header file.

Timeseries value list is a list of timeseries values at a specified timestamp.
See mcl_connectivity/mcl_timeseries_value.h for information about timeseries values.

This module enables the agent to initialize a timeseries value list using mcl_timeseries_value_list_initialize function. Following initialization, the parameters of this timeseries value list can be set using mcl_timeseries_value_list_set_parameter function. Then timeseries value(s) can be added to the timeseries value list using mcl_timeseries_value_list_add_value function. If the timeseries value list is added to a timeseries, mcl_timeseries_t will handle the destroy operation of the timeseries value list and the agent does not need to take any action. Otherwise, mcl_timeseries_value_list_destroy function is used to destroy timeseries value list.

For more information, please look at example file "mcl_connectivity/examples/timeseries_upload.c".

Copyright

Copyright (C) 2019 Siemens Aktiengesellschaft.
All rights reserved.

Definition in file mcl_timeseries_value_list.h.

Typedef Documentation

typedef struct mcl_timeseries_value_list_t mcl_timeseries_value_list_t

Handle for timeseries value list.

Definition at line 35 of file mcl_timeseries_value_list.h.

Enumeration Type Documentation

enum E_MCL_TIMESERIES_VALUE_LIST_PARAMETER

Parameters for timeseries value list.

Enumerator
MCL_TIMESERIES_VALUE_LIST_PARAMETER_TIMESTAMP_ISO8601	Timeseries value list timestamp parameter as char* (which is in yyyy-MM-ddTHH:mm:ss.SSSZ format).
MCL_TIMESERIES_VALUE_LIST_PARAMETER_TIMESTAMP_EPOCH	Timeseries value list timestamp parameter as time_t*.
MCL_TIMESERIES_VALUE_LIST_PARAMETER_END

Definition at line 40 of file mcl_timeseries_value_list.h.

Function Documentation

MCL_CONNECTIVITY_EXPORT mcl_error_t mcl_timeseries_value_list_add_value	(	mcl_timeseries_value_list_t *	timeseries_value_list,
		mcl_timeseries_value_t *	timeseries_value
	)

This function adds timeseries_value to timeseries_value_list.

Parameters

[in]	timeseries_value_list	mcl_timeseries_value_list_t object handle which timeseries_value is added to.
[in]	timeseries_value	mcl_timeseries_value_t object handle which contains timeseries value information.

Returns

• MCL_OK in case of success.
• MCL_TRIGGERED_WITH_NULL in case timeseries_value_list or timeseries_value is null.
• MCL_OUT_OF_MEMORY in case there is not enough memory in the system to proceed.
• MCL_LIMIT_EXCEEDED in case timeseries_value_list has no space for a new timeseries value.

Definition at line 132 of file timeseries_value_list.c.

References MCL_ASSERT_NOT_NULL, MCL_DEBUG_ENTRY, MCL_DEBUG_LEAVE, MCL_FUNCTION_LEAVE_LABEL, and mcl_list_add().

Here is the call graph for this function:

MCL_CONNECTIVITY_EXPORT void mcl_timeseries_value_list_destroy

(

mcl_timeseries_value_list_t **

timeseries_value_list

)

This function destroys timeseries_value_list.

Parameters

[in]

timeseries_value_list

Timeseries value list handle which is going to be destroyed.

Definition at line 151 of file timeseries_value_list.c.

References MCL_DEBUG_ENTRY, MCL_DEBUG_LEAVE, MCL_FREE, mcl_list_destroy_with_content(), MCL_NULL, and mcl_timeseries_value_destroy().

Referenced by mcl_timeseries_destroy(), and mcl_timeseries_value_list_initialize().

Here is the call graph for this function:

Here is the caller graph for this function:

MCL_CONNECTIVITY_EXPORT mcl_error_t mcl_timeseries_value_list_initialize

(

mcl_timeseries_value_list_t **

timeseries_value_list

)

This function creates and initializes a data struct of mcl_timeseries_value_list_t.

Parameters

[out]

timeseries_value_list

Initialized mcl_timeseries_value_list_t object handle.

Returns

• MCL_OK in case of success.
• MCL_OUT_OF_MEMORY in case there is not enough memory in the system to proceed.
• MCL_TRIGGERED_WITH_NULL in case timeseries_value_list is null.

Definition at line 14 of file timeseries_value_list.c.

References MCL_ASSERT_NOT_NULL, MCL_DEBUG_ENTRY, MCL_DEBUG_LEAVE, MCL_FUNCTION_LEAVE_LABEL, mcl_list_initialize(), MCL_NEW, MCL_NULL, MCL_NULL_CHAR, MCL_OK, MCL_OUT_OF_MEMORY, and mcl_timeseries_value_list_destroy().

Here is the call graph for this function:

MCL_CONNECTIVITY_EXPORT mcl_error_t mcl_timeseries_value_list_set_parameter	(	mcl_timeseries_value_list_t *	timeseries_value_list,
		E_MCL_TIMESERIES_VALUE_LIST_PARAMETER	parameter,
		const void *	value
	)

This function is used to set a parameter of a timeseries value list.

Parameters

[in]	timeseries_value_list	Timeseries value list to set its parameter.
[in]	parameter	One of the parameters listed in E_MCL_TIMESERIES_VALUE_LIST_PARAMETER.
[in]	value	New value of the parameter.

Returns

• MCL_OK in case of success.
• MCL_TRIGGERED_WITH_NULL if provided timeseries_value_list or value is NULL.
• MCL_OUT_OF_MEMORY in case there is not enough memory in the system to proceed.
• MCL_INVALID_PARAMETER if provided parameter is invalid.
• MCL_FAIL in case of an internal error in MCL.

Definition at line 49 of file timeseries_value_list.c.

References MCL_ASSERT_NOT_NULL, MCL_DEBUG_ENTRY, MCL_DEBUG_LEAVE, MCL_FUNCTION_LEAVE_LABEL, MCL_INVALID_PARAMETER, MCL_OK, mcl_string_util_memcpy(), mcl_time_util_convert_to_iso_8601_format(), mcl_time_util_validate_timestamp(), MCL_TIMESERIES_VALUE_LIST_PARAMETER_TIMESTAMP_EPOCH, MCL_TIMESERIES_VALUE_LIST_PARAMETER_TIMESTAMP_ISO8601, MCL_TIMESTAMP_LENGTH, and MCL_TRUE.

Here is the call graph for this function: