Browse Source

Improve naming of event related methods

Patrick-Christopher Mattulat 3 years ago
parent
commit
abd82436b3

+ 2 - 2
include/ls_std/event/Event.hpp

@@ -3,7 +3,7 @@
  * Company:         Lynar Studios
  * E-Mail:          webmaster@lynarstudios.com
  * Created:         2020-11-26
- * Changed:         2020-11-26
+ * Changed:         2020-11-28
  *
  * */
 
@@ -28,7 +28,7 @@ namespace ls_std {
     private:
 
       ls_std::event_id id {};
-      ls_std::event_parameter_list eventParameterList {};
+      ls_std::event_parameter_list parameterList {};
 
       bool _hasParameter(const ls_std::event_id&  _id);
   };

+ 3 - 3
include/ls_std/event/EventHandler.hpp

@@ -3,7 +3,7 @@
  * Company:         Lynar Studios
  * E-Mail:          webmaster@lynarstudios.com
  * Created:         2020-11-27
- * Changed:         2020-11-27
+ * Changed:         2020-11-28
  *
  * */
 
@@ -23,10 +23,10 @@ namespace ls_std {
       explicit EventHandler(ls_std::event_id  _id);
       ~EventHandler() override = default;
 
+      void addListener(const std::shared_ptr<ls_std::IListener>& _listener);
       ls_std::event_id getId();
       void notify(const ls_std::Event& _event);
-      void subscribe(const std::shared_ptr<ls_std::IListener>& _listener);
-      void unsubscribe(const std::shared_ptr<ls_std::IListener>& _listener);
+      void removeListener(const std::shared_ptr<ls_std::IListener>& _listener);
 
     private:
 

+ 5 - 5
source/ls_std/event/Event.cpp

@@ -3,7 +3,7 @@
  * Company:         Lynar Studios
  * E-Mail:          webmaster@lynarstudios.com
  * Created:         2020-11-26
- * Changed:         2020-11-26
+ * Changed:         2020-11-28
  *
  * */
 
@@ -16,7 +16,7 @@ id(std::move(_id))
 void ls_std::Event::addParameter(const ls_std::event_parameter &_eventParameter)
 {
   if(!this->_hasParameter(_eventParameter.first)) {
-    this->eventParameterList.insert(_eventParameter);
+    this->parameterList.insert(_eventParameter);
   }
 }
 
@@ -27,17 +27,17 @@ ls_std::event_id ls_std::Event::getId()
 
 ls_std::event_parameter_list ls_std::Event::getParameterList()
 {
-  return this->eventParameterList;
+  return this->parameterList;
 }
 
 void ls_std::Event::removeParameter(const ls_std::event_id &_id)
 {
   if(this->_hasParameter(_id)) {
-    this->eventParameterList.erase(_id);
+    this->parameterList.erase(_id);
   }
 }
 
 bool ls_std::Event::_hasParameter(const ls_std::event_id &_id)
 {
-  return this->eventParameterList.find(_id) != this->eventParameterList.end();
+  return this->parameterList.find(_id) != this->parameterList.end();
 }

+ 9 - 9
source/ls_std/event/EventHandler.cpp

@@ -3,7 +3,7 @@
  * Company:         Lynar Studios
  * E-Mail:          webmaster@lynarstudios.com
  * Created:         2020-11-27
- * Changed:         2020-11-27
+ * Changed:         2020-11-28
  *
  * */
 
@@ -13,6 +13,13 @@ ls_std::EventHandler::EventHandler(ls_std::event_id  _id) : ls_std::Class("Event
 id(std::move(_id))
 {}
 
+void ls_std::EventHandler::addListener(const std::shared_ptr<ls_std::IListener> &_listener)
+{
+  if(!this->_hasListener(_listener)) {
+    this->_addListener(_listener);
+  }
+}
+
 ls_std::event_id ls_std::EventHandler::getId()
 {
   return this->id;
@@ -25,14 +32,7 @@ void ls_std::EventHandler::notify(const ls_std::Event &_event)
   }
 }
 
-void ls_std::EventHandler::subscribe(const std::shared_ptr<ls_std::IListener> &_listener)
-{
-  if(!this->_hasListener(_listener)) {
-    this->_addListener(_listener);
-  }
-}
-
-void ls_std::EventHandler::unsubscribe(const std::shared_ptr<ls_std::IListener> &_listener)
+void ls_std::EventHandler::removeListener(const std::shared_ptr<ls_std::IListener> &_listener)
 {
   this->_removeListener(_listener);
 }

+ 3 - 3
test/classes/event/DailyNewsAgency.cpp

@@ -3,7 +3,7 @@
  * Company:         Lynar Studios
  * E-Mail:          webmaster@lynarstudios.com
  * Created:         2020-11-27
- * Changed:         2020-11-27
+ * Changed:         2020-11-28
  *
  * */
 
@@ -36,14 +36,14 @@ void ls_std_test::DailyNewsAgency::subscribe(const ls_std::event_id &_id)
   // TODO: check event handler existence
 
 //  std::shared_ptr<ls_std_test::DailyNewsAgency> listener = this->shared_from_this();
-  this->eventHandlers.at(_id)->subscribe(this->shared_from_this());
+  this->eventHandlers.at(_id)->addListener(this->shared_from_this());
 }
 
 void ls_std_test::DailyNewsAgency::unsubscribe(const ls_std::event_id &_id)
 {
   // TODO: check event handler existence
 
-  this->eventHandlers.at(_id)->unsubscribe(this->shared_from_this());
+  this->eventHandlers.at(_id)->removeListener(this->shared_from_this());
 }
 
 void ls_std_test::DailyNewsAgency::addEventHandler(const std::shared_ptr<ls_std::EventHandler> &_eventHandler)

+ 3 - 3
test/classes/event/GossipNewsAgency.cpp

@@ -3,7 +3,7 @@
  * Company:         Lynar Studios
  * E-Mail:          webmaster@lynarstudios.com
  * Created:         2020-11-27
- * Changed:         2020-11-27
+ * Changed:         2020-11-28
  *
  * */
 
@@ -39,14 +39,14 @@ void ls_std_test::GossipNewsAgency::subscribe(const ls_std::event_id &_id)
 {
   // TODO: check event handler existence
 
-  this->eventHandlers.at(_id)->subscribe(this->shared_from_this());
+  this->eventHandlers.at(_id)->addListener(this->shared_from_this());
 }
 
 void ls_std_test::GossipNewsAgency::unsubscribe(const ls_std::event_id &_id)
 {
   // TODO: check event handler existence
 
-  this->eventHandlers.at(_id)->unsubscribe(this->shared_from_this());
+  this->eventHandlers.at(_id)->removeListener(this->shared_from_this());
 }
 
 void ls_std_test::GossipNewsAgency::addEventHandler(const std::shared_ptr<ls_std::EventHandler> &_eventHandler)