Changeset 10388 for trunk/FACT++/src

Timestamp:

04/18/11 14:28:00 (14 years ago)

Author:

tbretz

Message:

Added descriptions for the virtual function.

File:

• trunk/FACT++/src/DimServiceInfoList.h (modified) (2 diffs)

trunk/FACT++/src/DimServiceInfoList.h

@@ -51 +51 @@
     void RemoveAllServers();
 
-    virtual void AddService(const std::string &server, const std::string &service, const std::string &fmt, bool iscmd)
-    {
-    }
-    virtual void RemoveService(const std::string &server, const std::string &service, bool iscmd)
-    {
-    }
-    virtual void RemoveAllServices(const std::string &server)
-    {
-    }
-
-    virtual void AddDescription(const std::string &server, const std::string &service, const std::vector<Description> &vec)
-    {
-    }
-
-    virtual void AddStates(const std::string &server, const std::vector<State> &vec)
-    {
-    }
+    virtual void AddService(const std::string &, const std::string &, const std::string &, bool) { }
+    virtual void RemoveService(const std::string &, const std::string &, bool) { }
+    virtual void RemoveAllServices(const std::string &) { }
+    virtual void AddDescription(const std::string &, const std::string &, const std::vector<Description> &) { }
+    virtual void AddStates(const std::string &, const std::vector<State> &) { }
 
 protected:
@@ -96 +84 @@
 };
 
+// ***************************************************************************
+/** @fn DimServiceInfoList::AddService(const std::string &server, const std::string &service, const std::string &fmt, bool iscmd)
+
+This virtual function is called as a callback whenever a new service appears.
+The default is to do nothing.
+
+@param server
+   Server name of the server at which the new service appeared
+
+@param service
+   Service name which appeared
+
+@param fmt
+   Dim format string associated with the service
+
+@param iscmd
+   boolean which is true if it is a command, and false if it is a service
+
+
+**/
+// ***************************************************************************
+/** @fn DimServiceInfoList::RemoveService(const std::string &server, const std::string &service, bool iscmd)
+
+This virtual function is called as a callback whenever a service disappears.
+The default is to do nothing.
+
+@param server
+   Server name of the server at which the new service appeared
+
+@param service
+   Service name which appeared
+
+@param iscmd
+   boolean which is true if it is a command, and false if it is a service
+
+
+**/
+// ***************************************************************************
+/** @fn DimServiceInfoList::RemoveAllServices(const std::string &server)
+
+This virtual function is called as a callback whenever a server disappears,
+or the list must be cleared because a new list has been retrieved.
+The default is to do nothing.
+
+@param server
+   Server name of the server at which the new service appeared
+
+
+**/
+// ***************************************************************************
+/** @fn DimServiceInfoList::AddDescription(const std::string &server, const std::string &service, const std::vector<Description> &vec)
+
+This virtual function is called as a callback whenever a new description
+was received.
+The default is to do nothing.
+
+@param server
+   Server name of the server for which something was received
+
+@param service
+   Service name for which the description weer received
+
+@param vec
+   vector<Description> associated with this service. The first entry in the
+   list belongs to the service itself, each consecutive entry to its arguments
+
+
+**/
+// ***************************************************************************
+/** @fn DimServiceInfoList::AddStates(const std::string &server, const std::vector<State> &vec)
+
+This virtual function is called as a callback whenever a new list of states
+was received.
+The default is to do nothing.
+
+@param server
+   Server name for which the list was received
+
+@param vec
+   vector<State> associated with this server.
+
+**/
+// ***************************************************************************
+
 #endif