entityIdentifier.h

Go to the documentation of this file.

/*********************************************************************
** Copyright (c) 1992-2010 VT MAK
** All rights reserved.
*********************************************************************/

#ifndef entityIdentifier_H_
#define entityIdentifier_H_

#include <vlutil/vlMachineTypes.h>
#include "NetStructs.h"
#include "disEnums.h"
#include "simulationAddress.h"
#include <string>


const DtU16 DtDeferedEntityId = ((1<<16)-1);

const DtU16 DtDeferredEntityId = ((1<<16)-1);

class DT_DLL_VLPROTIND DtEntityIdentifier
{
public:
   DtEntityIdentifier(const char* str);

   DtEntityIdentifier(int site, int host, DtU16 entityNum);

   DtEntityIdentifier(const DtSimulationAddress& simulationAddress, 
                      DtU16 entityNum);

   DtEntityIdentifier(const DtEntityIdentifier& orig);

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

   DtEntityIdentifier(const DtNetEntityIdentifier& netId);

   DtEntityIdentifier();

   void init(int site, int host, DtU16 entityNum);


   inline int operator==(const DtEntityIdentifier &other) const;
   inline int operator!=(const DtEntityIdentifier &other) const;
   inline operator DtNetEntityIdentifier () const;

   bool operator<( const DtEntityIdentifier &rightOperand ) const;
  
   inline void setFromNet(const DtNetEntityIdentifier &netId);

   inline void setSite(int site);

   inline int site() const ;

   inline void setHost(int host);

   inline int host() const;

   inline void setEntityNum(DtU16 entityNum);

   inline DtU16 entityNum() const;

   inline void setSimulationAddress( const DtSimulationAddress& simulationAddress);

   inline const DtSimulationAddress& simulationAddress() const;

   bool sameHost(const DtEntityIdentifier &other) const;

   bool sameEntity(const DtEntityIdentifier &other) const;

   bool matchPattern(const DtEntityIdentifier &pat) const;


   const char *string() const;

public:

   static const DtEntityIdentifier& nullId();

   static const DtEntityIdentifier& defaultId();

public:

   DtSimulationAddress DtSimulator;

   DtU16 DtEntity;

protected:
   mutable std::string myMutableStringRep;
};

DT_DLL_VLPROTIND std::ostream& operator<< (std::ostream& stream, const DtEntityIdentifier& object);

#define entityIdentifier_inl
#include "entityIdentifier.inl"
#undef entityIdentifier_inl

#endif