aboutsummaryrefslogtreecommitdiffstats
path: root/src/include/rba/RBAScene.hpp
blob: 5bb1e662fae28814a288fc2049d3fa4ac7fc753b (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
// Copyright (c) 2018 DENSO CORPORATION. All rights reserved.
/**
 * Scene class
 */

#ifndef RBASCENE_HPP
#define RBASCENE_HPP

#include <cstdint>
#include <list>
#include <string>

#ifdef _MSC_VER
#ifdef _WINDLL
#define DLL_EXPORT __declspec(dllexport)
#else
#define DLL_EXPORT __declspec(dllimport)
#endif
#else
#define DLL_EXPORT
#endif

namespace rba
{

/**
 * @class RBAScene
 * Express the state(Including system state) at that time comprehensively.<br>
 * Used scene for switch area/zone and view/sound content state.
 * And plural RBA model(project) can share arbitration result by definitions global scene.
 */
class RBAScene
{
protected:
  RBAScene()=default;
  RBAScene(const RBAScene&)=delete;
  RBAScene(RBAScene&&)=delete;
  RBAScene& operator=(const RBAScene&)=delete;
  RBAScene& operator=(RBAScene&&)=delete;

public:
  virtual ~RBAScene()=default;

public:
  /**
   * @brief Returns the scene name
   * @return Scene name
   */
  virtual std::string getName() const=0;

  /**
   * @brief Returns the global scene status.
   * @return global scene status.
   */
  virtual bool isGlobal() const=0;

  /**
   * @brief Returns List of the scene property name.
   * @return List of the scene property name
   */
  virtual const std::list<std::string>& getPropertyNames() const=0;

  /**
   * @brief Returns Default value of the scene property.
   * @param propertyName Scene property name
   * @return Default value of the scene property
   */
  virtual std::int32_t getPropertyValue(const std::string& propertyName) const=0;

};

}

#endif