Timeseries value list module implementation file. More...

#include "mcl_connectivity/mcl_timeseries_value_list.h"
#include "timeseries_value_list.h"
#include "mcl_core/mcl_memory.h"
#include "mcl_core/mcl_string_util.h"

Include dependency graph for timeseries_value_list.c:

Go to the source code of this file.

Functions
mcl_error_t	mcl_timeseries_value_list_initialize (mcl_timeseries_value_list_t **timeseries_value_list)

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_error_t	timeseries_value_list_validate (timeseries_value_list_t *timeseries_value_list)

mcl_error_t	mcl_timeseries_value_list_add_value (mcl_timeseries_value_list_t timeseries_value_list, mcl_timeseries_value_t timeseries_value)

void	mcl_timeseries_value_list_destroy (mcl_timeseries_value_list_t **timeseries_value_list)

Detailed Description

Timeseries value list module implementation file.

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

Definition in file timeseries_value_list.c.

Function Documentation

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:

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_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_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`.