include/vrfplan/simCommand.h

Go to the documentation of this file.

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



#ifndef DtSimCommand_H_
#define DtSimCommand_H_

#include "vrfutil/rdrWritr.h"
#include "vrfplan/simCommandFactory.h"
#include "vrfutil/strIntMapper.h"
#include "vrfutil/rwBoolean.h"
#include <vlutil/vlNetTypes.h>
#include "tdbutil/translation.h"
#include "tdbutil/tdbUnits.h"
#include "vrfplan/vrfplanDefines.h"

class DtRwString;
class DtSimCommandFactory;


class DT_DLL_vrfplan DtSimCommand : public DtReaderWriter
{
protected:

   DtSimCommand();

   DtSimCommand(const DtString & writeName,
      DtReaderWriterRegistry * parentRegistry = 0);

   DtSimCommand(const DtString & writeName, const DtSimCommand & orig,
      DtReaderWriterRegistry * parentRegistry = 0);

   const DtSimCommand & operator=(const DtSimCommand & orig);

public:

   virtual ~DtSimCommand();

   virtual bool init();

   virtual int type() const = 0;

   virtual DtSimCommand * clone(const DtString & name, DtReaderWriterRegistry *
      parentRegistry = 0) const = 0;

   virtual DtSimCommand* clone() const;

   virtual DtString stringRep() const = 0;

   virtual void putData(FILE *fp, int indentLevel = 0);

   virtual DtlObjPtr getData(DtlObjPtr args, const DtFilename& searchPath,
      const DtVariableBindingsList& variableBindings);

   virtual char* netRep();

   virtual int netRepSize() const;

   virtual bool setFromNet(const char* contentBuffer,
      unsigned contentSize);

   virtual bool setToNet();


   static DtSimCommand * createSimCommand(DtlObjPtr mtlStream);
   static DtSimCommand * createSimCommand(int simCommandType);

   static void addSimCommandCreatorFcn(const DtString & simCommandName, int simCommandType,
      DtSimCommandCreatorFcn fcn);

   static void setFactory(DtSimCommandFactory * factory);
   static DtSimCommandFactory* factory();

   static bool getSimCommandNameFromSimCommandType(int simCommandType, DtString& simCommandName);
   static bool getSimCommandTypeFromSimCommandName(const DtString& simCommandName,
      int& simCommandType);

   static bool addSimCommandTypeMapping(const DtString& simCommandName, int simCommandType);
   static bool removeSimCommandTypeMapping(const DtString& simCommandName,
      int simCommandType);

protected:
   virtual char* createNetworkBuffer();

protected:
   char*     myNetRep;

   static DtSimCommandFactory*  myFactory;
   static DtStringIntMapper theSimCommandNameMapper;
};

namespace DtBufferSerialize
{
   DT_DLL_vrfplan int getSize(const DtSimCommand* const&  commandPtr);

   DT_DLL_vrfplan char *encode(const DtSimCommand* const& commandPtr, char *buffer);

   DT_DLL_vrfplan const char *decode(DtSimCommand*& commandPtr, const char *buffer);
}

#endif