include/tdbutil/symStr.h

Go to the documentation of this file.

/*********************************************************************
** Copyright (c) 2004 MAK Technologies, Inc.
** All rights reserved.
*********************************************************************/
/*********************************************************************
** $RCSfile: symStr.h,v $ $Revision: 1.2 $ $State: Exp $
*********************************************************************/
#ifndef symStr_H_
#define symStr_H_

#include "tdbutil/tdbUtilDefines.h"
#include <vlutil/vlString.h>
#include "tdbutil/cstringHashKey.h"
#include "tdbutil/symbolStore.h"

//
// This class allows one to collect and compare strings using an index 
// number instead of having to do string compares. It is not virtual
// and is effectively 4 bytes meaning you can pass these by value as easily
// as passing a pointer
class DT_DLL_tdbutil DtSymbolString
{
public:
   // default constructor
   DtSymbolString();

   // additional constructors
//   DtSymbolString(const char* str);
   DtSymbolString(const DtString& str);
   DtSymbolString(unsigned int i);

   // destructor
   ~DtSymbolString();

   // copy constructor
   DtSymbolString(const DtSymbolString& orig);

   // assignment operators
   DtSymbolString& operator=(const DtString& orig);
   DtSymbolString& operator=(const char* orig);

   // cast operator
   // \deprecated This function is deprecated as of VRF 3.9, and should *not* be used.
   operator const char*() const;
  
   // @return The string, in char form, associated with the symbol.
   const char* c_str() const;

   // @return The string, in char form, associated with the symbol.
   // \deprecated This function is deprecated as of VRF 3.9, and should *not* be used.
   const char* string() const;

   const unsigned int symbol() const { return mySymbol; };

   // clone operator
   DtSymbolString* clone();

   // comparison operators
   bool operator==(const DtString& str) const; // string compare
   bool operator!=(const DtString& str) const;

   bool operator==(const char* str) const; // string compare
   bool operator!=(const char* str) const;

   bool operator==(const DtSymbolString& str) const; // int compare
   bool operator!=(const DtSymbolString& str) const;

   // @note This is necessary because, unlike .Net, VC 6.0 can't auto-generate 
   // the operator when an instance of these is placed into a std::map.  
   bool operator<(const DtSymbolString& str) const;

protected:

   unsigned int mySymbol;
};


#endif