ryzom/server/src/frontend_service/prio_sub.h

   1 // Ryzom - MMORPG Framework <http://dev.ryzom.com/projects/ryzom/>
   2 // Copyright (C) 2010  Winch Gate Property Limited
   3 //
   4 // This program is free software: you can redistribute it and/or modify
   5 // it under the terms of the GNU Affero General Public License as
   6 // published by the Free Software Foundation, either version 3 of the
   7 // License, or (at your option) any later version.
   8 //
   9 // This program is distributed in the hope that it will be useful,
  10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12 // GNU Affero General Public License for more details.
  13 //
  14 // You should have received a copy of the GNU Affero General Public License
  15 // along with this program.  If not, see <http://www.gnu.org/licenses/>.
  16
  17
  18
  19 #ifndef NL_PRIO_SUB_H
  20 #define NL_PRIO_SUB_H
  21
  22 #include <nel/misc/types_nl.h>
  23 #include "vision_array.h"
  24 #include "vision_provider.h"
  25 #include "distance_prioritizer.h"
  26
  27 #include <nel/misc/hierarchical_timer.h>
  28
  29 /**
  30  * Priority Subsystem.
  31  * You can call update for a whole cycle or call each task independantly
  32  * (for example, to allow multithreading).
  33  * One cycle consists of the following tasks:
  34  * #1. processVision()
  35  * #2. preparePairSelection()
  36  * #3. calculatePriorities()
  37  * #4. initDispatcherCycle()
  38  *
  39  * \author Olivier Cado
  40  * \author Nevrax France
  41  * \date 2002
  42  */
  43 class CPrioSub
  44 {
  45 public:
  46
  47         /// Constructor
  48         CPrioSub();
  49
  50         /// Main initialization
  51         void                                    init( CHistory *h, CClientIdLookup *cl )
  52                                                         {
  53                                                                 VisionProvider.init( &VisionArray, h, cl );
  54                                                                 Prioritizer.init( &VisionArray, &VisionProvider, h );
  55                                                         }
  56
  57         /// Perform one cycle (PropDispatcher becomes ready for getNextParcel())
  58         void                                    update()
  59                                                         {
  60                                                                 H_TIME(ProcessVision, processVision(););
  61                                                                 H_TIME(calculatePriorities, calculatePriorities(););
  62                                                         }
  63
  64         /// Process Vision Differences
  65         void                                    processVision()
  66                                                         { VisionProvider.processVision(); }
  67
  68         /// Calculate the priorities corresponding to the selected pairs
  69         void                                    calculatePriorities()
  70                                                         { Prioritizer.calculatePriorities(); }
  71
  72         /// Unit testing (TEMP)
  73         void                                    testVisionProvider();
  74
  75 public:
  76
  77         /// Entities seen by the clients and the priorities of their properties
  78         CVisionArray                    VisionArray;
  79
  80         /// Manager of the vision (who sees who)
  81         CVisionProvider                 VisionProvider;
  82
  83         /// Priority calculation
  84         CDistancePrioritizer    Prioritizer;
  85
  86 private:
  87
  88         /// Counter for adjustHPThreshold
  89         //uint32                                        _AHPTCounter;
  90
  91 };
  92
  93
  94 #endif // NL_PRIO_SUB_H
  95
  96 /* End of prio_sub.h */