src/openxc-utils.hpp

   1 /*
   2  * Copyright (C) 2015, 2016 "IoT.bzh"
   3  * Author "Romain Forlot" <romain.forlot@iot.bzh>
   4  * Author "Loic Collignon" <loic.collignon@iot.bzh>
   5  *
   6  * Licensed under the Apache License, Version 2.0 (the "License");
   7  * you may not use this file except in compliance with the License.
   8  * You may obtain a copy of the License at
   9  *
  10  *       http://www.apache.org/licenses/LICENSE-2.0
  11  *
  12  * Unless required by applicable law or agreed to in writing, software
  13  * distributed under the License is distributed on an "AS IS" BASIS,
  14  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  15  * See the License for the specific language governing permissions and
  16  * limitations under the License.
  17  */
  18
  19 #pragma once
  20
  21 #include "openxc.pb.h"
  22
  23 /**
  24  * @brief Build a specific VehicleMessage containing a SimpleMessage.
  25  *
  26  * @param[in] openxc_DynamicField_Type type - The type of message to build
  27  * @param[in] openxc_SimpleMessage& message - simple message to include into openxc_VehicleMessage
  28  *
  29  * @return openxc_VehicleMessage - a vehicle message including simple message that will be convert into
  30  * a JSON object before being pushed to the subscribers
  31  */
  32 openxc_VehicleMessage build_VehicleMessage_with_SimpleMessage(openxc_DynamicField_Type type, const openxc_SimpleMessage& message);
  33
  34 /**
  35  * @brief Build an openxc_SimpleMessage associating a name to an openxc_DynamicField
  36  */
  37 openxc_SimpleMessage build_SimpleMessage(const std::string& name, const openxc_DynamicField& value);
  38 /**
  39  * @brief Build an openxc_DynamicField depending what we pass as argument
  40  */
  41 openxc_DynamicField build_DynamicField(const std::string& value);
  42
  43 /**
  44  * @brief Build an openxc_DynamicField depending what we pass as argument
  45  */
  46 openxc_DynamicField build_DynamicField(double value);
  47
  48 /**
  49  * @brief Build an openxc_DynamicField depending what we pass as argument
  50  */
  51 openxc_DynamicField build_DynamicField(bool value);
  52
  53 void jsonify_DynamicField(const openxc_DynamicField& field, const json_object& value);
  54
  55 /**
  56  * @brief Extract the simple message value from an openxc_VehicleMessage
  57  * and return it, or null if there isn't.
  58  */
  59 openxc_SimpleMessage get_simple_message(const openxc_VehicleMessage& v_msg);
  60
  61 json_object jsonify_simple(const openxc_SimpleMessage& s_msg);