include/vrfobjcore/netIface.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2000 MAK Technologies, Inc.
** All rights reserved.
*******************************************************************************/
/*******************************************************************************
** $RCSfile: netIface.h,v $ $Revision: 1.13 $ $State: Exp $
*******************************************************************************/




#ifndef DtSimObjectNetInterface_H_
#define DtSimObjectNetInterface_H_

#include "vrfutil/rwBoolean.h"
#include "vrfobjcore/netIfaceFact.h"


class DtVrfObject;
class DtStateRepository;
class DtSimObjectNetInterfaceFactory;

#include "vrfobjcore/vrfobjcoreDefines.h"
class DT_DLL_vrfobjcore DtSimObjectNetInterface : public DtReaderWriter
{
protected:
   DtSimObjectNetInterface();

public:

   DtSimObjectNetInterface(const DtString & name, DtVrfObject * simObject,
      DtReaderWriterRegistry * parentRegistry = 0, 
      bool publishObject = true);

   DtSimObjectNetInterface(const DtSimObjectNetInterface & orig, 
      DtReaderWriterRegistry * parentRegistry = 0);

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

   virtual ~DtSimObjectNetInterface();

   virtual bool init() { return true; }

   virtual void tick();

   virtual void onTick() = 0;

   virtual DtVrfObject * simObject() const;

   virtual DtStateRepository * networkState() const;

   virtual bool isEntity() const = 0;
   virtual bool isEnvironmental() const = 0;

   virtual bool isLocal() const = 0;

   virtual DtString type() const = 0;
   
   virtual int maxNameLength() const;

   static void addSimObjectNetInterfaceCreatorFcn(const DtString & type, 
      DtSimObjectNetIfaceCreatorFcn fcn);

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

   static DtSimObjectNetInterface * createNetInterface(
      const DtString & name, const DtString & type, DtVrfObject * simObject,
      DtReaderWriterRegistry * parentRegistry = 0,
      bool publishObject = true);

   static int maxNameLengthForInterfaceType(const DtString& interfaceTypeString);

protected:

   DtVrfObject * mySimObject;
   DtStateRepository * myNetworkState;

   static DtSimObjectNetInterfaceFactory* theFactory;
};

#endif