assistantCommandMsg.h

Go to the documentation of this file.

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


#ifndef assistantCommandMsg_H_
#define assistantCommandMsg_H_


#include "assistantMsg.h"
#include "netAssistantCommandMsg.h"

class DtAssistantCommandMsg;
class DtRtiAssistantServer;
class DtAssistantMsgQueue;

typedef void (*DtAssistantCommandMsgCb)(const DtAssistantCommandMsg& inter, void* usr);



class DT_DLL_ASSISTANT DtAssistantCommandMsg : public DtAssistantMsg
{

public:

   enum DtCommandEnum 
   { 
      DtDoNotCommand = 0, 
      DtRequestCommand, 
      DtForceCommand 
   };
   
   DtAssistantCommandMsg(DtBufferPtr buffer = DtUSE_INTERNAL_BUFFER);

   DtAssistantCommandMsg(const DtNetAssistantCommandMsg* netRep,
      DtBufferPtr buffer = DtUSE_INTERNAL_BUFFER);

   DtAssistantCommandMsg(DtU8 commandType,
                         const MAKRti::DtString& messageString="",                         
                         const DtU8 assistantId=0,
                         const DtU16 fedexHandle=0,
                         const DtU16 fedHandle=0,
                         DtBufferPtr buffer = DtUSE_INTERNAL_BUFFER );

   virtual ~DtAssistantCommandMsg();

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

   virtual void setIsAssistantToAssistant(bool yesNo);
   virtual bool isAssistantToAssistant() const;

   virtual void setCommandType(DtU8 yesNo);
   virtual DtU8 commandType() const;

   virtual void printData() const;

   virtual void setMessageString( const MAKRti::DtString& msgString, bool adjustBufferSize = true );
   virtual MAKRti::DtString messageString() const;

   virtual void setTargetAssistantComponentId( const DtU8 assistantId );
   virtual DtU8 targetAssistantComponentId() const;

   virtual void setTargetFederationHandle( const DtU16 fedexHandle );
   virtual DtU16 targetFederationHandle() const;

   virtual void setTargetFederateHandle( const DtU16 fedHandle );
   virtual DtU16 targetFederateHandle() 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,
      DtAssistantCommandMsgCb cb, void* usr);
   static void removeCallback(DtRtiAssistantServer* conn, 
      DtAssistantCommandMsgCb cb, void* usr);
   static void addCallback(DtAssistantMsgQueue* queue, 
      DtAssistantCommandMsgCb cb, void* usr);
   static void removeCallback(DtAssistantMsgQueue* queue, 
      DtAssistantCommandMsgCb cb, void* usr);

protected:

   virtual DtNetAssistantCommandMsg* netAssistantCommandMsg();
   virtual const DtNetAssistantCommandMsg* netAssistantCommandMsg() const;

   virtual DtAssistantMsgKind internalMsgKind();

   virtual int minSize() const;

   virtual int minSize(const MAKRti::DtString& text);

   virtual void setMessageStringSize( unsigned long size );
   virtual unsigned long messageStringSize() const;

   virtual const char* messageStringPtr() const;
   virtual char* messageStringPtr();

};

#endif