assistantFederateStateMsg.h

Go to the documentation of this file.

/*********************************************************************
** Copyright (c) 2008 MaK Technologies, Inc.
** All rights reserved.
*********************************************************************/
/*********************************************************************
** $RCSfile: assistantFederateStateMsg.h,v $ $Revision: 1.3 $ $State: Exp $
*********************************************************************/

#ifndef DtAssistantFederateStateMsg_H_
#define DtAssistantFederateStateMsg_H_


#include <vlutil/vlString.h>
#include <vlutil/vlUtil.h>

#include "rtiVersion.h"
#include "assistantMsg.h"
#include "netAssistantFederateStateMsg.h"

class DtRtiAssistantPeer;
class DtRtiAssistantServer;
class DtAssistantFederateStateMsg;

namespace MAKRti
{
   class DtInetAddr;
}

typedef void (*DtAssistantFederateStateCb)(const DtAssistantFederateStateMsg& inter, void* usr);

class DT_DLL_ASSISTANT DtAssistantFederateStateMsg : public DtAssistantMsg
{
public:

   DtAssistantFederateStateMsg(DtBufferPtr buffer = DtUSE_INTERNAL_BUFFER);

   DtAssistantFederateStateMsg(const DtNetAssistantFederateStateMsg* netRepMsg,
      DtBufferPtr buffer = DtUSE_INTERNAL_BUFFER);

   virtual ~DtAssistantFederateStateMsg();

   virtual DtAssistantMsg* clone(bool copy = true) const;

   virtual unsigned long connectionId() const;

   virtual void setConnectionId( unsigned long connId );

   virtual unsigned int federateHandle() const;

   virtual void setFederateHandle( unsigned int handle );

   virtual MAKRti::DtInetAddr federateHostIp() const;

   virtual void setFederateHostIp( const MAKRti::DtInetAddr& ip );

   virtual bool isTestEnabled() const;

   virtual void setIsTestEnabled( bool enabled );

   virtual bool isTestInProgress() const;

   virtual void setIsTestInProgress( bool inProgress );

   virtual bool isContinuousTest() const;

   virtual void setIsContinuousTest( bool continuous );

   virtual unsigned int numInitiatedTests() const;

   virtual void setNumInitiatedTests( unsigned int num );

   virtual unsigned int numTestReports() const;

   virtual void setNumTestReports( unsigned int num );

   virtual bool isReconnecting() const;

   virtual void setIsReconnecting( bool reconnecting );

   virtual bool isDisconnected() const;

   virtual void setIsDisconnected( bool disconnected );

   virtual bool isRemoval() const;

   virtual void setIsRemoval( bool remove );

   virtual DtHlaVersionId hlaVersion() const;

   virtual void setHlaVersion( DtHlaVersionId version );

   virtual int assistantCompId() const;

   virtual void setAssistantCompId( int compId );

   virtual MAKRti::DtString federationName() const;

   virtual void setFederationName( const MAKRti::DtString& name, bool adjustBufferSize = true);

   virtual MAKRti::DtString federateType() const;

   virtual void setFederateType( const MAKRti::DtString& type, bool adjustBufferSize = true);

   virtual MAKRti::DtString federateName() const;

   virtual void setFederateName( const MAKRti::DtString& name, bool adjustBufferSize = true);

   virtual MAKRti::DtString federateHostName() const;

   virtual void setFederateHostName( const MAKRti::DtString& name, bool adjustBufferSize = true );

   virtual void setVariableData(const MAKRti::DtString& federationName, const MAKRti::DtString& federateType,
      const MAKRti::DtString& federateName, const MAKRti::DtString& hostName, bool adjustBufferSize = true);

   virtual void printData() const;

public:

   static DtAssistantMsg* create(const DtNetAssistantMsgHeader* initial,
      DtBufferPtr buffer = DtUSE_INTERNAL_BUFFER);

   static DtAssistantMsg* create(DtBufferPtr buffer = DtUSE_INTERNAL_BUFFER);

   static void addCallback(DtRtiAssistantServer* conn, 
      DtAssistantFederateStateCb cb, void* usr);
   static void removeCallback(DtRtiAssistantServer* conn, 
      DtAssistantFederateStateCb cb, void* usr);

   static void addCallback(DtRtiAssistantPeer* conn, 
      DtAssistantFederateStateCb cb, void* usr);
   static void removeCallback(DtRtiAssistantPeer* conn, 
      DtAssistantFederateStateCb cb, void* usr);
      
protected:

   virtual DtNetAssistantFederateStateMsg* netAssistantFederateStateMsg();
   virtual const DtNetAssistantFederateStateMsg* netAssistantFederateStateMsg() const;

   virtual DtAssistantMsgKind internalMsgKind();

   virtual int minSize() const;

   virtual void setFederationNameSize( unsigned long size );
   virtual unsigned long federationNameSize() const;

   virtual const char* federationNamePtr() const;
   virtual char* federationNamePtr();

   virtual void setFederateTypeSize( unsigned long size );
   virtual unsigned long federateTypeSize() const;

   virtual const char* federateTypePtr() const;
   virtual char* federateTypePtr();

   virtual void setFederateNameSize( unsigned long size );
   virtual unsigned long federateNameSize() const;

   virtual const char* federateNamePtr() const;
   virtual char* federateNamePtr();

   virtual void setFederateHostNameSize( unsigned long size );
   virtual unsigned long federateHostNameSize() const;

   virtual const char* federateHostNamePtr() const;
   virtual char* federateHostNamePtr();

};

#endif