federate.h

Go to the documentation of this file.

/*********************************************************************
** Copyright (c) 1998 MaK Technologies, Inc.
** All rights reserved.
*********************************************************************/
/*********************************************************************
** $RCSfile: federate.h,v $ $Revision: 1.11 $ $State: Exp $
*********************************************************************/


#ifndef DtFederate_H_
#define DtFederate_H_

#include "rtiMsConfig.h"
#include <vlutil/vlMachineTypes.h>
#include "syncHashlist.h"
#include <vlutil/vlHashKeys.h>
#include <vlutil/vlTime.h>
#include <vlutil/vlPrint.h>
#include <vlutil/vlUtil.h>
#include <vlutil/vlInetAddr.h>
#include <rtiVersion.h>
#include "internalTypes.h"
#include "saveStatusMsg.h"
#include "restoreStatusMsg.h"


class DtFederate;
typedef DtFederate* (*DtFederateCreator)(const char* type, const char* name,
      DtFederateHandle handle, unsigned long connHandle, int astntCompId,
      DtResignAction resignAction, const char* fedHostName, const MAKRti::DtInetAddr& host,
      const DtSyncHashlist& syncList, DtHlaVersionId hlaVersion);



class DT_DLL_EXEC DtFederate
{
public:
   
   DtFederate(const char* type, const char* name, DtFederateHandle handle,
      unsigned long connHandle, int astntCompId, DtResignAction resignAction, const char* fedHostName,
      const MAKRti::DtInetAddr& host, const DtSyncHashlist& syncList, DtHlaVersionId hlaVersion);

   virtual ~DtFederate();

private:
   DtFederate(const DtFederate&);
   DtFederate& operator=(const DtFederate &);
public:
   virtual void setFederateSyncPtAchieved(const char* name, bool successful);
   virtual bool federateSyncPtAchieved(const char* name);
   virtual bool federateSyncPtAchievedSuccessfully(const char* name);

   virtual void addFederateSyncPt(const char* name, DtSyncPt* item);
   virtual DtSyncPt* removeFederateSyncPt(const char* name);

   virtual char* getType() const;

   virtual char* getName() const;

   virtual bool isNamed() const;

   virtual DtFederateHandle getHandle() const;

   virtual const char* getDescription() const;

   virtual unsigned long getConnectionHandle() const;
   virtual void setConnectionHandle(unsigned long handle);

   virtual DtResignAction resignAction() const;
   virtual void setResignAction(DtResignAction val);

   virtual MAKRti::DtInetAddr getFederateHost() const;
   virtual void setFederateHost( const MAKRti::DtInetAddr& hostAddr );

   virtual char* getFederateHostName() const;
   virtual void setFederateHostName( char* hostname );

   virtual const DtSyncHashlist& syncPtList() const;

   virtual DtTime federateHeartbeat() const;
   virtual void setFederateHeartbeat(MAKRti::DtTime time);

   virtual void setSaveStatus(DtSaveStatus status);
   virtual DtSaveStatus saveStatus() const;

   virtual void setRestoreStatus(DtRestoreStatus status);
   virtual DtRestoreStatus restoreStatus() const;

   virtual void setHlaVersion(DtHlaVersionId version);
   virtual DtHlaVersionId hlaVersion() const;

   virtual void setAssistantCompId(int id);
   virtual int assistantCompId() const;


public:

   static DtFederate* create(const char* type, const char* name,
      DtFederateHandle handle, unsigned long connHandle, int astntCompId,
      DtResignAction resignAction, const char* fedHostName, const MAKRti::DtInetAddr& host,
      const DtSyncHashlist& syncList, DtHlaVersionId hlaVersion);

   static void setCreatorFunction(DtFederateCreator creator);
   


protected:   
   char* myType;
   char* myName;
   bool myIsNamed;
   char* myFederateHostName;
   MAKRti::DtTime myHeartbeat;
   DtFederateHandle myHandle;
   DtSaveStatus mySaveStatus;
   DtRestoreStatus myRestoreStatus;
   unsigned long myConnectionHandle;
   DtSyncHashlist myHashlist;
   MAKRti::DtInetAddr myFederateHost;
   DtString myDescription;
   DtHlaVersionId myHlaVersion;
   int myAstntCompId;
   DtResignAction myResignAction;

protected:

   static DtFederateCreator theCreator;   
};

inline char* DtFederate::getType() const
{
   return myType;
}

inline char* DtFederate::getName() const
{
  return myName;
}

inline bool DtFederate::isNamed() const
{
   return myIsNamed;
}

inline DtFederateHandle DtFederate::getHandle() const
{
  return myHandle;
}

inline const char* DtFederate::getDescription() const
{
   return myDescription.c_str();
}

inline unsigned long DtFederate::getConnectionHandle() const
{
  return myConnectionHandle;
}

inline DtTime DtFederate::federateHeartbeat() const
{
  return myHeartbeat;
}

inline const DtSyncHashlist& DtFederate::syncPtList() const
{
  return myHashlist;
}

#endif