simgear/hla/RTI13Federate.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 RTI13Federate_hxx
  19 #define RTI13Federate_hxx
  20
  21 #ifndef RTI_USES_STD_FSTREAM
  22 #define RTI_USES_STD_FSTREAM
  23 #endif
  24
  25 #include <RTI.hh>
  26
  27 #include "RTIFederate.hxx"
  28 #include "RTI13ObjectClass.hxx"
  29 #include "RTI13ObjectInstance.hxx"
  30
  31 namespace simgear {
  32
  33 class RTI13Ambassador;
  34
  35 class RTI13Federate : public RTIFederate {
  36 public:
  37     RTI13Federate(const std::list<std::string>& stringList);
  38     virtual ~RTI13Federate();
  39
  40     /// Create a federation execution
  41     /// Semantically this methods should be static,
  42     virtual FederationManagementResult createFederationExecution(const std::string& federation, const std::string& objectModel);
  43     virtual FederationManagementResult destroyFederationExecution(const std::string& federation);
  44
  45     /// Join with federateName the federation execution federation
  46     virtual FederationManagementResult join(const std::string& federateType, const std::string& federation);
  47     virtual bool resign();
  48     virtual bool getJoined() const;
  49
  50     /// Synchronization Point handling
  51     virtual bool registerFederationSynchronizationPoint(const std::string& label, const RTIData& tag);
  52     virtual bool getFederationSynchronizationPointAnnounced(const std::string& label);
  53     virtual bool synchronizationPointAchieved(const std::string& label);
  54     virtual bool getFederationSynchronized(const std::string& label);
  55
  56     /// Time management
  57     virtual bool enableTimeConstrained();
  58     virtual bool disableTimeConstrained();
  59     virtual bool getTimeConstrainedEnabled();
  60
  61     virtual bool enableTimeRegulation(const SGTimeStamp& lookahead);
  62     virtual bool disableTimeRegulation();
  63     virtual bool modifyLookahead(const SGTimeStamp& timeStamp);
  64     virtual bool getTimeRegulationEnabled();
  65
  66     virtual bool timeAdvanceRequest(const SGTimeStamp& timeStamp);
  67     virtual bool timeAdvanceRequestAvailable(const SGTimeStamp& timeStamp);
  68     virtual bool flushQueueRequest(const SGTimeStamp& timeStamp);
  69     virtual bool getTimeAdvancePending();
  70
  71     virtual bool queryFederateTime(SGTimeStamp& timeStamp);
  72     virtual bool queryLookahead(SGTimeStamp& timeStamp);
  73     virtual bool queryGALT(SGTimeStamp& timeStamp);
  74     virtual bool queryLITS(SGTimeStamp& timeStamp);
  75
  76     /// Process messages
  77     virtual bool processMessage();
  78     virtual bool processMessages(const double& minimum, const double& maximum);
  79
  80     virtual RTI13ObjectClass* createObjectClass(const std::string& name, HLAObjectClass* hlaObjectClass);
  81
  82     virtual RTI13ObjectInstance* getObjectInstance(const std::string& name);
  83     void insertObjectInstance(RTI13ObjectInstance* objectInstance);
  84
  85 private:
  86     RTI13Federate(const RTI13Federate&);
  87     RTI13Federate& operator=(const RTI13Federate&);
  88
  89     /// The federate handle
  90     RTI::FederateHandle _federateHandle;
  91     bool _joined;
  92
  93     /// RTI connection
  94     SGSharedPtr<RTI13Ambassador> _ambassador;
  95
  96     /// Callbacks from the rti are handled here.
  97     struct FederateAmbassador;
  98     FederateAmbassador* _federateAmbassador;
  99 };
 100
 101 }
 102
 103 #endif