assistantConnectionAssocData.h

Go to the documentation of this file.

/*********************************************************************
** Copyright (c) 2009 MaK Technologies, Inc.
** All rights reserved.
*********************************************************************/
/*********************************************************************
** $RCSfile: assistantConnectionAssocData.h,v $ $Revision: 1.2 $ $State: Exp $
*********************************************************************/

#ifndef assistantConnectionAssocData_H_
#define assistantConnectionAssocData_H_


#include <rtiUtil.h>
#include <vlutil/vlString.h>
#include <vlutil/vlMutex.h>
#include "assistantUtil.h"
#include "assistantInfo.h"
#include <hostNameAddress.h>

class DT_DLL_ASSISTANT DtRtiAssociatedConnectionData
{

public:

   enum DtConnectionState
   {
      // It is not known whether this connection is in use
      DtUnknownState,
      
      // This connection conflicts with an active connection and can't be used
      DtConnectionConflicting,   

      // A forwarder is using this connection, but not an rtiexec
      DtConnectionForwarderVerified,

      // Both a forwarder and rtiexec are using this connection, or this is a
      // lightweight connection that has recently been used
      DtConnectionVerified
   };

   DtRtiAssociatedConnectionData();

   virtual bool operator==(const DtRtiAssociatedConnectionData& other) const;

   virtual bool operator!=(const DtRtiAssociatedConnectionData& other) const;

   MAKRti::DtString name( bool withOwner = false ) const;

   void setName( const MAKRti::DtString& connName );

   bool isNamed() const;

   MAKRti::DtString ownerHost() const;
   void setOwnerHost( const MAKRti::DtString& host );

   DtConnectionState connectionState() const;
   void setConnectionState( DtConnectionState state );


   bool isStateVerified() const;
   bool isStateForwarderVerified() const;
   bool isStateConflicting() const;
   bool isStateUnknown() const;
   bool isStateActive() const;
   bool isStateInactive() const;

   MAKRti::DtString conflictReason() const;
   void setConflictReason( const MAKRti::DtString& reason );

   bool isSaved() const;
   void setIsSaved( bool saved );

   bool isChosen() const;
   void setIsChosen( bool chosen );

   bool isPredefined() const;
   void setIsPredefined( bool predefined );

   MAKRti::DtInetAddr optionalForwarderToConnectTo() const;
   void setOptionalForwarderToConnectTo( const MAKRti::DtInetAddr& forwarder );

   unsigned numLocalFederates() const;
   void addLocalFederate(int compId);
   void removeLocalFederate(int compId);
   void clearLocalFederates();
   const std::set<int>& localFederates() const;

   bool wasRtiexecRemotelyHeartbeated() const;
   void setWasRtiexecRemotelyHeartbeated( bool heartbeated );

   bool wasRemotelyHeartbeated() const;
   void setWasRemotelyHeartbeated( bool heartbeated );

   DtAssistantInfo rtiexecsAssistant() const;
   void setRtiexecsAssistant( const DtAssistantInfo& assistant );

   DtAssistantInfo forwardersAssistant() const;
   void setForwardersAssistant( const DtAssistantInfo& assistant );

   int rtiexecCompId() const;
   void setRtiexecCompId( int id );

   int forwarderCompId() const;
   void setForwarderCompId( int id );

protected:

   MAKRti::DtString myName;

   MAKRti::DtString myOwnerHost;

   DtConnectionState myConnectionState;

   // The reason for the conflict.
   MAKRti::DtString myConflictReason;

   bool myIsSaved;

   bool myIsChosen;

   bool myIsPredefined;

   MAKRti::DtInetAddr myOptionalAdditionalForwarderToConnectTo;

   std::set<int> myLocalFederates;

   bool myRtiexecWasRemotelyHeartbeated;

   bool myWasRemotelyHeartbeated;

   DtAssistantInfo myRtiexecsAssistant;

   DtAssistantInfo myForwardersAssistant;

   int myRtiexecCompId;

   int myForwarderCompId;
};

inline bool DtRtiAssociatedConnectionData::isStateVerified() const
{
   return (myConnectionState == DtConnectionVerified);
}

inline bool DtRtiAssociatedConnectionData::isStateForwarderVerified() const
{
   return (myConnectionState == DtConnectionForwarderVerified);
}

inline bool DtRtiAssociatedConnectionData::isStateConflicting() const
{
   return (myConnectionState == DtConnectionConflicting);
}

inline bool DtRtiAssociatedConnectionData::isStateUnknown() const
{
   return (myConnectionState == DtUnknownState);
}

inline bool DtRtiAssociatedConnectionData::isStateActive() const
{
   return (myConnectionState == DtConnectionVerified ||
           myConnectionState == DtConnectionForwarderVerified);
}

inline bool DtRtiAssociatedConnectionData::isStateInactive() const
{
   return (myConnectionState == DtConnectionConflicting ||
           myConnectionState == DtUnknownState);
}


#endif