summaryrefslogtreecommitdiffstats
path: root/src/openxc-utils.hpp
blob: 295e99c5b1924a3395f45e786eaa91732b18ab7e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
/*
 * Copyright (C) 2015, 2016 "IoT.bzh"
 * Author "Romain Forlot" <romain.forlot@iot.bzh>
 * Author "Loic Collignon" <loic.collignon@iot.bzh>
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *	 http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#pragma once

#include "openxc.pb.h"

/**
 * @brief Build a specific VehicleMessage containing a SimpleMessage.
 *
 * @param[in] openxc_DynamicField_Type type - The type of message to build
 * @param[in] openxc_SimpleMessage& message - simple message to include into openxc_VehicleMessage
 *
 * @return openxc_VehicleMessage - a vehicle message including simple message that will be convert into 
 * a JSON object before being pushed to the subscribers
 */
openxc_VehicleMessage build_VehicleMessage_with_SimpleMessage(openxc_DynamicField_Type type, const openxc_SimpleMessage& message);

/**
 * @brief Build an openxc_SimpleMessage associating a name to an openxc_DynamicField
 */
openxc_SimpleMessage build_SimpleMessage(const std::string& name, const openxc_DynamicField& value);
/**
 * @brief Build an openxc_DynamicField depending what we pass as argument
 */
openxc_DynamicField build_DynamicField(const std::string& value);

/**
 * @brief Build an openxc_DynamicField depending what we pass as argument
 */
openxc_DynamicField build_DynamicField(double value);

/**
 * @brief Build an openxc_DynamicField depending what we pass as argument
 */
openxc_DynamicField build_DynamicField(bool value);

void jsonify_DynamicField(const openxc_DynamicField& field, const json_object& value);

/**
 * @brief Extract the simple message value from an openxc_VehicleMessage
 * and return it, or null if there isn't.
 */
openxc_SimpleMessage get_simple_message(const openxc_VehicleMessage& v_msg);

json_object jsonify_simple(const openxc_SimpleMessage& s_msg);