rwKeyValueList.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2010 MAK Technologies, Inc.
** All rights reserved.
*******************************************************************************/



#pragma once

#include "vrfutil/vrfutilDefines.h"
#include "vrfutil/rwStringList.h"
#include <map>
#include <vlutil/vlString.h>

class DT_DLL_vrfutil DtRwKeyValueList : public DtRwStringList
{
private:
public:
   DtRwKeyValueList();

   DtRwKeyValueList(const DtString& name, DtReaderWriterRegistry* const parentRegistry = NULL);
   DtRwKeyValueList(const DtSymbolString& name, DtReaderWriterRegistry* const parentRegistry = NULL);

   virtual ~DtRwKeyValueList();

   DtRwKeyValueList(const DtRwKeyValueList& orig, DtReaderWriterRegistry* const parentRegistry = NULL);

   DtRwKeyValueList& operator=(const DtRwKeyValueList& orig);

   virtual void add(const DtString& key, const DtString& value);
   virtual void remove(const DtString& key);
   virtual void clear();

   virtual bool contains(const DtString& key) const;
   virtual DtString find(const DtString& key) const;

   virtual std::map<DtString, DtString> convertToMap() const; 

   virtual void setFromMap(const std::map<DtString, DtString> sourceMap);

   static const char* theXmlType();

   virtual const char* xmlType() const
   {
      return theXmlType();
   }
   virtual const char* readerWriterType() const;

   virtual void populateListByType(
      boost::function<void (DtReaderWriter*)> addFunction, 
      DtEnvironmentSP env, DtEnvValueSP node, const DtString& bindingType,
      const DtReaderWriter::SearchPaths& searchPaths, const DtVariableBindingsList& bindings);

   virtual bool isUserEditable() const;

protected:

   bool myIsUserEditable;
};

namespace DtBufferSerialize
{
   DT_DLL_vrfutil char *encode(const DtRwKeyValueList& val, char *buffer);
   DT_DLL_vrfutil const char *decode(DtRwKeyValueList& val, const char *buffer) ;
   DT_DLL_vrfutil int getSize(const DtRwKeyValueList& val);

}