simgear/hla/RTIFederate.hxx

   1 // Copyright (C) 2009 - 2011  Mathias Froehlich - Mathias.Froehlich@web.de
   2 //
   3 // This library is free software; you can redistribute it and/or
   4 // modify it under the terms of the GNU Library General Public
   5 // License as published by the Free Software Foundation; either
   6 // version 2 of the License, or (at your option) any later version.
   7 //
   8 // This library is distributed in the hope that it will be useful,
   9 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  10 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  11 // Library General Public License for more details.
  12 //
  13 // You should have received a copy of the GNU General Public License
  14 // along with this program; if not, write to the Free Software
  15 // Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  16 //
  17
  18 #ifndef RTIFederate_hxx
  19 #define RTIFederate_hxx
  20
  21 #include <string>
  22 #include "simgear/structure/SGWeakReferenced.hxx"
  23 #include "RTIObjectClass.hxx"
  24 #include "RTIObjectInstance.hxx"
  25
  26 class SGTimeStamp;
  27
  28 namespace simgear {
  29
  30 class RTIFederate : public SGWeakReferenced {
  31 public:
  32     RTIFederate();
  33     virtual ~RTIFederate();
  34
  35     /// Create a federation execution
  36     /// Semantically this methods should be static,
  37     enum FederationManagementResult {
  38         FederationManagementSuccess,
  39         FederationManagementFail,
  40         FederationManagementFatal
  41     };
  42
  43     virtual FederationManagementResult createFederationExecution(const std::string& federation, const std::string& objectModel) = 0;
  44     virtual FederationManagementResult destroyFederationExecution(const std::string& federation) = 0;
  45
  46     /// Join with federateName the federation execution federation
  47     virtual FederationManagementResult join(const std::string& federateType, const std::string& federation) = 0;
  48     virtual bool resign() = 0;
  49     virtual bool getJoined() const = 0;
  50
  51     /// Synchronization Point handling
  52     virtual bool registerFederationSynchronizationPoint(const std::string& label, const RTIData& tag) = 0;
  53     virtual bool getFederationSynchronizationPointAnnounced(const std::string& label) = 0;
  54     virtual bool synchronizationPointAchieved(const std::string& label) = 0;
  55     virtual bool getFederationSynchronized(const std::string& label) = 0;
  56
  57     /// Time management
  58     virtual bool enableTimeConstrained() = 0;
  59     virtual bool disableTimeConstrained() = 0;
  60     virtual bool getTimeConstrainedEnabled() = 0;
  61
  62     virtual bool enableTimeRegulation(const SGTimeStamp& lookahead) = 0;
  63     virtual bool disableTimeRegulation() = 0;
  64     virtual bool modifyLookahead(const SGTimeStamp& timeStamp) = 0;
  65     virtual bool getTimeRegulationEnabled() = 0;
  66
  67     virtual bool timeAdvanceRequest(const SGTimeStamp& fedTime) = 0;
  68     virtual bool timeAdvanceRequestAvailable(const SGTimeStamp& timeStamp) = 0;
  69     virtual bool getTimeAdvancePending() = 0;
  70
  71     virtual bool queryFederateTime(SGTimeStamp& timeStamp) = 0;
  72     virtual bool queryLookahead(SGTimeStamp& timeStamp) = 0;
  73     virtual bool queryGALT(SGTimeStamp& timeStamp) = 0;
  74     virtual bool queryLITS(SGTimeStamp& timeStamp) = 0;
  75
  76     /// Process messages
  77     virtual bool processMessage() = 0;
  78     virtual bool processMessages(const double& minimum, const double& maximum) = 0;
  79
  80     virtual RTIObjectClass* createObjectClass(const std::string& name, HLAObjectClass* hlaObjectClass) = 0;
  81     // virtual RTIInteractionClass* createInteractionClass(const std::string& name) = 0;
  82
  83     virtual RTIObjectInstance* getObjectInstance(const std::string& name) = 0;
  84
  85 private:
  86     RTIFederate(const RTIFederate&);
  87     RTIFederate& operator=(const RTIFederate&);
  88 };
  89
  90 }
  91
  92 #endif