1/* Copyright (c) 2015, 2017 The Linux Foundation. All rights reserved.
2 *
3 * Redistribution and use in source and binary forms, with or without
4 * modification, are permitted provided that the following conditions are
5 * met:
6 *     * Redistributions of source code must retain the above copyright
7 *       notice, this list of conditions and the following disclaimer.
8 *     * Redistributions in binary form must reproduce the above
9 *       copyright notice, this list of conditions and the following
10 *       disclaimer in the documentation and/or other materials provided
11 *       with the distribution.
12 *     * Neither the name of The Linux Foundation, nor the names of its
13 *       contributors may be used to endorse or promote products derived
14 *       from this software without specific prior written permission.
15 *
16 * THIS SOFTWARE IS PROVIDED "AS IS" AND ANY EXPRESS OR IMPLIED
17 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
18 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT
19 * ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS
20 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
21 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
22 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
23 * BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
24 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
25 * OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN
26 * IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27 *
28 */
29
30#ifndef __IDATAITEMCORE_H__
31#define __IDATAITEMCORE_H__
32
33#include <string>
34#include <DataItemId.h>
35
36namespace loc_core {
37
38using namespace std;
39
40/**
41 * @brief IDataItemCore interface.
42 * @details IDataItemCore interface.
43 *
44 */
45class IDataItemCore {
46public:
47    /**
48     * @brief Gets Data item id.
49     * @details Gets Data item id.
50     * @return Data item id.
51     */
52    virtual DataItemId getId () = 0;
53
54    /**
55     * @brief Stringify.
56     * @details Stringify.
57     *
58     * @param valueStr Reference to string.
59     */
60    virtual void stringify (string & valueStr) = 0;
61
62    /**
63     * @brief copy.
64     * @details copy.
65     *
66     * @param src Where to copy from.
67     * @param dataItemCopied Boolean flag indicated whether or not copied.
68     *
69     * @return Zero for success or non zero for failure.
70     */
71    virtual int32_t copy (IDataItemCore * src, bool *dataItemCopied = nullptr) = 0;
72
73    /**
74     * @brief Destructor.
75     * @details Destructor.
76     */
77    virtual ~IDataItemCore () {}
78};
79
80} // namespace loc_core
81
82#endif // __IDATAITEMCORE_H__
83