service/scene-manager/include/RemoteScene.h

   1 //******************************************************************
   2 //
   3 // Copyright 2016 Samsung Electronics All Rights Reserved.
   4 //
   5 //-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
   6 //
   7 // Licensed under the Apache License, Version 2.0 (the "License");
   8 // you may not use this file except in compliance with the License.
   9 // You may obtain a copy of the License at
  10 //
  11 //      http://www.apache.org/licenses/LICENSE-2.0
  12 //
  13 // Unless required by applicable law or agreed to in writing, software
  14 // distributed under the License is distributed on an "AS IS" BASIS,
  15 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16 // See the License for the specific language governing permissions and
  17 // limitations under the License.
  18 //
  19 //-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
  20
  21 #ifndef SM_REMOTE_SCENE_H_
  22 #define SM_REMOTE_SCENE_H_
  23
  24 #include <memory>
  25 #include <string>
  26 #include <map>
  27
  28 #include "RemoteSceneAction.h"
  29 #include "RCSRemoteResourceObject.h"
  30
  31 namespace OIC
  32 {
  33     namespace Service
  34     {
  35         class SceneCollectionResourceRequestor;
  36         class SceneMemberResourceRequestor;
  37
  38         class RemoteScene
  39         {
  40             public:
  41                 typedef std::shared_ptr< RemoteScene > Ptr;
  42
  43                 typedef std::function< void(RemoteSceneAction::Ptr, int) >
  44                 AddNewSceneActionCallback;
  45
  46                 typedef std::function< void(const int eCode) >
  47                 RemoveSceneActionCallback;
  48
  49                 typedef std::function< void(const std::string &sceneName, int eCode) >
  50                 RemoteSceneExecuteCallback;
  51
  52
  53             public:
  54                 ~RemoteScene() = default;
  55
  56                 void addNewSceneAction(RCSRemoteResourceObject::Ptr pTargetResource,
  57                                        const RCSResourceAttributes &attrs,
  58                                        AddNewSceneActionCallback);
  59                 void addNewSceneAction(RCSRemoteResourceObject::Ptr pTargetResource,
  60                                        const std::string &key,
  61                                        const RCSResourceAttributes::Value &value,
  62                                        AddNewSceneActionCallback);
  63
  64                 void removeSceneAction(RemoteSceneAction::Ptr pRemoteSceneAction,
  65                                        RemoveSceneActionCallback);
  66                 void removeSceneAction(RCSRemoteResourceObject::Ptr pTargetResource,
  67                                        RemoveSceneActionCallback);
  68
  69                 std::vector< RemoteSceneAction::Ptr > getRemoteSceneActions() const;
  70                 std::vector< RemoteSceneAction::Ptr > getRemoteSceneAction
  71                 (const RCSRemoteResourceObject::Ptr pTargetResource) const;
  72
  73                 std::string getName() const;
  74
  75                 void execute(RemoteSceneExecuteCallback);
  76
  77
  78             private:
  79                 RemoteScene
  80                 (const std::string &name, std::shared_ptr< SceneCollectionResourceRequestor >);
  81
  82                 RemoteSceneAction::Ptr createRemoteSceneActionInstance
  83                 (const std::string &, const RCSResourceAttributes &);
  84
  85                 void addExistingRemoteSceneAction(const std::string &, const std::string &,
  86                                                   const std::string &, const std::string &key,
  87                                                   const RCSResourceAttributes::Value &);
  88
  89                 void onSceneActionAdded(
  90                     std::shared_ptr< SceneMemberResourceRequestor >,
  91                     int eCode, RCSRemoteResourceObject::Ptr,
  92                     const RCSResourceAttributes &, AddNewSceneActionCallback);
  93
  94                 void onSceneExecuted(const int &reqType, const std::string &name,
  95                                      int eCode, RemoteSceneExecuteCallback);
  96
  97
  98             private:
  99                 std::string m_name;
 100                 std::map < const std::string, std::vector< RemoteSceneAction::Ptr > >
 101                 m_remoteSceneActions;
 102
 103                 std::shared_ptr< SceneCollectionResourceRequestor > m_requestorPtr;
 104
 105                 friend class RemoteSceneCollection;
 106         };
 107
 108     }
 109 }
 110
 111 #endif /* SM_REMOTE_SCENE_H_ */
 112