Changeset 10388


Ignore:
Timestamp:
Apr 18, 2011, 2:28:00 PM (9 years ago)
Author:
tbretz
Message:
Added descriptions for the virtual function.
File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/FACT++/src/DimServiceInfoList.h

    r10378 r10388  
    5151    void RemoveAllServers();
    5252
    53     virtual void AddService(const std::string &server, const std::string &service, const std::string &fmt, bool iscmd)
    54     {
    55     }
    56     virtual void RemoveService(const std::string &server, const std::string &service, bool iscmd)
    57     {
    58     }
    59     virtual void RemoveAllServices(const std::string &server)
    60     {
    61     }
    62 
    63     virtual void AddDescription(const std::string &server, const std::string &service, const std::vector<Description> &vec)
    64     {
    65     }
    66 
    67     virtual void AddStates(const std::string &server, const std::vector<State> &vec)
    68     {
    69     }
     53    virtual void AddService(const std::string &, const std::string &, const std::string &, bool) { }
     54    virtual void RemoveService(const std::string &, const std::string &, bool) { }
     55    virtual void RemoveAllServices(const std::string &) { }
     56    virtual void AddDescription(const std::string &, const std::string &, const std::vector<Description> &) { }
     57    virtual void AddStates(const std::string &, const std::vector<State> &) { }
    7058
    7159protected:
     
    9684};
    9785
     86// ***************************************************************************
     87/** @fn DimServiceInfoList::AddService(const std::string &server, const std::string &service, const std::string &fmt, bool iscmd)
     88
     89This virtual function is called as a callback whenever a new service appears.
     90The default is to do nothing.
     91
     92@param server
     93   Server name of the server at which the new service appeared
     94
     95@param service
     96   Service name which appeared
     97
     98@param fmt
     99   Dim format string associated with the service
     100
     101@param iscmd
     102   boolean which is true if it is a command, and false if it is a service
     103
     104
     105**/
     106// ***************************************************************************
     107/** @fn DimServiceInfoList::RemoveService(const std::string &server, const std::string &service, bool iscmd)
     108
     109This virtual function is called as a callback whenever a service disappears.
     110The default is to do nothing.
     111
     112@param server
     113   Server name of the server at which the new service appeared
     114
     115@param service
     116   Service name which appeared
     117
     118@param iscmd
     119   boolean which is true if it is a command, and false if it is a service
     120
     121
     122**/
     123// ***************************************************************************
     124/** @fn DimServiceInfoList::RemoveAllServices(const std::string &server)
     125
     126This virtual function is called as a callback whenever a server disappears,
     127or the list must be cleared because a new list has been retrieved.
     128The default is to do nothing.
     129
     130@param server
     131   Server name of the server at which the new service appeared
     132
     133
     134**/
     135// ***************************************************************************
     136/** @fn DimServiceInfoList::AddDescription(const std::string &server, const std::string &service, const std::vector<Description> &vec)
     137
     138This virtual function is called as a callback whenever a new description
     139was received.
     140The default is to do nothing.
     141
     142@param server
     143   Server name of the server for which something was received
     144
     145@param service
     146   Service name for which the description weer received
     147
     148@param vec
     149   vector<Description> associated with this service. The first entry in the
     150   list belongs to the service itself, each consecutive entry to its arguments
     151
     152
     153**/
     154// ***************************************************************************
     155/** @fn DimServiceInfoList::AddStates(const std::string &server, const std::vector<State> &vec)
     156
     157This virtual function is called as a callback whenever a new list of states
     158was received.
     159The default is to do nothing.
     160
     161@param server
     162   Server name for which the list was received
     163
     164@param vec
     165   vector<State> associated with this server.
     166
     167**/
     168// ***************************************************************************
     169
    98170#endif
Note: See TracChangeset for help on using the changeset viewer.