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 <string>
  22 #include <json-c/json.h>
  23 #include <sys/timeb.h>
  24
  25 #include "openxc.pb.h"
  26
  27 /**
  28  * @brief Build a specific VehicleMessage containing a SimpleMessage.
  29  *
  30  * @param[in] openxc_DynamicField_Type type - The type of message to build
  31  * @param[in] openxc_SimpleMessage& message - simple message to include into openxc_VehicleMessage
  32  *
  33  * @return openxc_VehicleMessage - a vehicle message including simple message that will be convert into
  34  * a JSON object before being pushed to the subscribers
  35  */
  36 openxc_VehicleMessage build_VehicleMessage_with_SimpleMessage(openxc_DynamicField_Type type, const openxc_SimpleMessage& message);
  37
  38 /**
  39  * @brief Build an openxc_SimpleMessage associating a name to an openxc_DynamicField
  40  */
  41 openxc_SimpleMessage build_SimpleMessage(const std::string& name, const openxc_DynamicField& value);
  42 /**
  43  * @brief Build an openxc_DynamicField depending what we pass as argument
  44  */
  45 openxc_DynamicField build_DynamicField(const std::string& value);
  46
  47 /**
  48  * @brief Build an openxc_DynamicField depending what we pass as argument
  49  */
  50 openxc_DynamicField build_DynamicField(double value);
  51
  52 /**
  53  * @brief Build an openxc_DynamicField depending what we pass as argument
  54  */
  55 openxc_DynamicField build_DynamicField(bool value);
  56
  57 void jsonify_DynamicField(const openxc_DynamicField& field, json_object* value);
  58
  59 /**
  60  * @brief Extract the simple message value from an openxc_VehicleMessage
  61  * and return it, or null if there isn't.
  62  */
  63 openxc_SimpleMessage get_simple_message(const openxc_VehicleMessage& v_msg);
  64
  65 json_object* jsonify_simple(const openxc_SimpleMessage& s_msg);