summaryrefslogtreecommitdiff
path: root/src/components/formatters/include/formatters/meta_formatter.h
blob: 36e39301f67f5e5e18de3096ff4c77b9df0b3acb (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
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
/*
 * @file meta_fromatter.h
 * @brief file describes class CMetaFormatter which is designed to format
 *        the smart object against given schema for given formatter
 */
// Copyright (c) 2013, Ford Motor Company
// All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are met:
//
// Redistributions of source code must retain the above copyright notice, this
// list of conditions and the following disclaimer.
//
// Redistributions in binary form must reproduce the above copyright notice,
// this list of conditions and the following
// disclaimer in the documentation and/or other materials provided with the
// distribution.
//
// Neither the name of the Ford Motor Company nor the names of its contributors
// may be used to endorse or promote products derived from this software
// without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
// AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 'A PARTICULAR PURPOSE
// ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
// LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
// CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
// SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
// INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
// CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
// ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
// POSSIBILITY OF SUCH DAMAGE.

#ifndef SRC_COMPONENTS_FORMATTERS_INCLUDE_FORMATTERS_META_FORMATTER_H_
#define SRC_COMPONENTS_FORMATTERS_INCLUDE_FORMATTERS_META_FORMATTER_H_

#include "smart_objects/smart_object.h"
#include "smart_objects/smart_schema.h"

namespace ns_smart_device_link {
namespace ns_json_handler {
namespace formatters {

/**
  * @brief Formats to string the smart object against given schema for given
  *formatter
  *
  * Sample usage:
  *    CSmartFactory factory;
  *    SmartObject object;
  *    CSmartSchmema schema;
  *
  */
class CMetaFormatter {
 public:
  /**
    * @brief Creates smart object by the given schema having copied
    *        matched tree elements from original object.
    *
    * @param object Original smart object which macthed tree elements
    *        will be copied from
    * @param schema Smart schema which describes result smart object
    * @param result_object createdsmart object
    * @return true if successful, false - otherwise
    */
  static bool CreateObjectByPattern(
      const ns_smart_device_link::ns_smart_objects::SmartObject& object,
      const ns_smart_device_link::ns_smart_objects::CSmartSchema& schema,
      ns_smart_device_link::ns_smart_objects::SmartObject& result_object);
};

}  // namespace ns_smart_device_link
}  // namespace ns_smart_device_link::ns_json_handler
}  // namespace ns_smart_device_link::ns_json_handler::formatters

#endif  // SRC_COMPONENTS_FORMATTERS_INCLUDE_FORMATTERS_META_FORMATTER_H_