Timeseries value module implementation file. More...

#include "mcl_connectivity/mcl_timeseries_value.h"
#include "timeseries_value.h"
#include "mcl_core/mcl_memory.h"
#include "mcl_core/mcl_string_util.h"

Include dependency graph for timeseries_value.c:

Go to the source code of this file.

Functions
mcl_error_t	mcl_timeseries_value_initialize (mcl_timeseries_value_t **timeseries_value)

mcl_error_t	mcl_timeseries_value_set_parameter (mcl_timeseries_value_t timeseries_value, E_MCL_TIMESERIES_VALUE_PARAMETER parameter, const void value)

mcl_error_t	timeseries_value_validate (timeseries_value_t *timeseries_value)

void	mcl_timeseries_value_destroy (mcl_timeseries_value_t **timeseries_value)

Detailed Description

Timeseries value module implementation file.

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

Definition in file timeseries_value.c.

Function Documentation

void mcl_timeseries_value_destroy ( mcl_timeseries_value_t ** timeseries_value )

This function destroys timeseries_value.

Parameters

[in] timeseries_value mcl_timeseries_value_t object handle that will be destroyed.

Definition at line 84 of file timeseries_value.c.

References MCL_DEBUG_ENTRY, MCL_DEBUG_LEAVE, MCL_FREE, and MCL_NULL.

Referenced by mcl_timeseries_value_list_destroy().

Here is the caller graph for this function:

mcl_error_t mcl_timeseries_value_initialize ( mcl_timeseries_value_t ** timeseries_value )

This function creates and initializes a data struct of mcl_timeseries_value_t.

Parameters

[out] timeseries_value Initialized mcl_timeseries_value_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 is null.

Definition at line 14 of file timeseries_value.c.

References MCL_ASSERT_CODE_MESSAGE, MCL_ASSERT_NOT_NULL, MCL_DEBUG_ENTRY, MCL_DEBUG_LEAVE, MCL_FUNCTION_LEAVE_LABEL, MCL_NEW, MCL_NULL, MCL_OK, and MCL_OUT_OF_MEMORY.

mcl_error_t mcl_timeseries_value_set_parameter	(	mcl_timeseries_value_t *	timeseries_value,
		E_MCL_TIMESERIES_VALUE_PARAMETER	parameter,
		const void *	value
	)

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

Parameters

[in]	timeseries_value	Timeseries value to set its parameter.
[in]	parameter	One of the parameters listed in E_MCL_TIMESERIES_VALUE_PARAMETER.
[in]	value	New value of the `parameter`.

Returns

MCL_OK in case of success.
MCL_TRIGGERED_WITH_NULL if provided timeseries_value 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.

Definition at line 36 of file timeseries_value.c.

References MCL_ASSERT_NOT_NULL, MCL_DEBUG_ENTRY, MCL_DEBUG_LEAVE, MCL_FUNCTION_LEAVE_LABEL, MCL_INVALID_PARAMETER, mcl_string_util_reset(), MCL_TIMESERIES_VALUE_PARAMETER_DATA_POINT_ID, MCL_TIMESERIES_VALUE_PARAMETER_QUALITY_CODE, and MCL_TIMESERIES_VALUE_PARAMETER_VALUE.

Here is the call graph for this function:

mcl_error_t timeseries_value_validate ( timeseries_value_t * timeseries_value )

This function checks whether all mandatory parameters of a timeseries value are set or not.

Parameters

[in] timeseries_value Timeseries value to validate.

Returns

MCL_OK in case of success.
MCL_INVALID_PARAMETER in case timeseries value has one or more missing mandatory parameters.

Definition at line 71 of file timeseries_value.c.

References timeseries_value_t::data_point_id, MCL_ASSERT_CODE_MESSAGE, MCL_DEBUG_ENTRY, MCL_DEBUG_LEAVE, MCL_INVALID_PARAMETER, MCL_NULL, MCL_OK, timeseries_value_t::quality_code, and timeseries_value_t::value.

Referenced by timeseries_value_list_validate().

Here is the caller graph for this function:

Functions

Detailed Description

Function Documentation