mapping.c File Reference

Mapping module implementation file. More...

#include "mcl_connectivity/mcl_mapping.h"
#include "mapping.h"
#include "mcl_core/mcl_memory.h"
#include "mcl_core/mcl_string_util.h"

Include dependency graph for mapping.c:

Go to the source code of this file.

Functions
mcl_error_t	mcl_mapping_initialize (mcl_mapping_t **mapping)
mcl_error_t	mcl_mapping_set_parameter (mcl_mapping_t *mapping, E_MCL_MAPPING_PARAMETER parameter, const void *value)
mcl_error_t	mapping_validate (mapping_t *mapping)
void	mcl_mapping_destroy (mcl_mapping_t **mapping)

Detailed Description

Mapping module implementation file.

Copyright

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

Definition in file mapping.c.

Function Documentation

mcl_error_t mapping_validate

(

mapping_t *

mapping

)

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

Parameters

[in]

mapping

Mapping to validate.

Returns

• MCL_OK in case of success.
• MCL_INVALID_PARAMETER in case mapping has one or more missing mandatory parameters.

Definition at line 87 of file mapping.c.

References mapping_t::data_point_id, MCL_DEBUG_ENTRY, MCL_DEBUG_LEAVE, MCL_INVALID_PARAMETER, MCL_NULL, MCL_OK, mapping_t::property_name, and mapping_t::property_set_name.

Referenced by connectivity_processor_create_mapping().

Here is the caller graph for this function:

void mcl_mapping_destroy

(

mcl_mapping_t **

mapping

)

This function destroys mapping data structure.

Parameters

[in]

mapping

Mapping handle which is going to be destroyed.

Definition at line 103 of file mapping.c.

References MCL_DEBUG_ENTRY, MCL_DEBUG_LEAVE, MCL_FREE, and MCL_NULL.

mcl_error_t mcl_mapping_initialize

(

mcl_mapping_t **

mapping

)

This function creates and initializes a data struct of mcl_mapping_t.

Parameters

[out]

mapping

Mapping handle which is going to be initialized.

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 mapping is null.

Definition at line 14 of file mapping.c.

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

mcl_error_t mcl_mapping_set_parameter	(	mcl_mapping_t *	mapping,
		E_MCL_MAPPING_PARAMETER	parameter,
		const void *	value
	)

This function is used to set a parameter of a mapping.

Parameters

[in]	mapping	Mapping to set its parameter.
[in]	parameter	One of the parameters listed in E_MCL_MAPPING_PARAMETER.
[in]	value	New value of the parameter.

Returns

• MCL_OK in case of success.
• MCL_TRIGGERED_WITH_NULL if provided mapping 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 44 of file mapping.c.

References MCL_ASSERT_NOT_NULL, MCL_DEBUG_ENTRY, MCL_DEBUG_LEAVE, MCL_FUNCTION_LEAVE_LABEL, MCL_INVALID_PARAMETER, MCL_MAPPING_PARAMETER_DATA_POINT_ID, MCL_MAPPING_PARAMETER_ENTITY_ID, MCL_MAPPING_PARAMETER_KEEP_MAPPING, MCL_MAPPING_PARAMETER_PROPERTY_NAME, MCL_MAPPING_PARAMETER_PROPERTY_SET_NAME, MCL_OK, and mcl_string_util_reset().

Here is the call graph for this function: