examples/addSimCommand/addSimCommandSim/mySimCommand.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2006 MAK Technologies, Inc.
** All rights reserved.
*******************************************************************************/
/*******************************************************************************
** $RCSfile: mySimCommand.h,v $ $Revision: 1.3 $ $State: Exp $
*******************************************************************************/

//\file consoleMessageCommand.h
//\brief DtConsoleMessageCommand.

#ifndef consoleMessageCommand_h
#define consoleMessageCommand_h

#include "vrfplan/simCommand.h"
#include "vrfutil/rwString.h"
#include <vlutil/vlPrint.h>
#include "vrftasks/radioMsgTypes.h"

const int MySimCommandType = MIN_USER_RADIO_MESSAGE_TYPE + 200;
const char MySimCommandTypeString[] = "my-sim-command";

//\brief DtSimCommand which causes a console message to be printed.
//This command will simply print a message to the back-end console

class MySimCommand : public DtSimCommand
{
public:
   //Default constructor
   MySimCommand();

   //Usual constructor
   MySimCommand(const DtString& writeName,
      DtReaderWriterRegistry* parentRegistry = NULL);

   //copy constructor
   MySimCommand(const DtString & writeName, const MySimCommand& orig,
      DtReaderWriterRegistry* parentRegistry = NULL);

   //destructor
   virtual ~MySimCommand();

   //assignment operator
   MySimCommand& operator=(const MySimCommand& orig);

   //\return MySimCommandType.
   int type() const;

   //\return A new instance of this class, copied from the original.
   virtual DtSimCommand * clone(const DtString & name, DtReaderWriterRegistry *
      parentRegistry = 0) const;

   //Message to print to console
   virtual DtString messageText() const;
   virtual void setMessageText(const DtString& text);

   //Text representation of this command.
   virtual DtString stringRep() const;

   //\copydoc DtSimCommand::netRepSize()
   virtual int netRepSize() const;

   //\copydoc DtSimCommand::setFromNet()
   virtual bool setFromNet(const char* contentBuffer, 
      unsigned contentSize);

   //\copydoc DtSimCommand::setToNet()
   virtual bool setToNet();

   //Returns a new instance of this class.
   static DtSimCommand* creator();

protected:
   DtRwString myMessageText;
};

#endif