include/vrfutil/remoteConfigurationMapper.h

Go to the documentation of this file.

/*********************************************************************
** Copyright (c) 2008 MaK Technologies, Inc.
** All rights reserved.
*********************************************************************/
/*********************************************************************
** $RCSfile: remoteConfigurationMapper.h,v $ $Revision: 1.2 $ $State: Exp $
*********************************************************************/

#ifndef DtRemoteConfigurationMapper_H_
#define DtRemoteConfigurationMapper_H_


#include "vrfutil/rdrWritr.h"

#include <list>
#include <map>
#include <string>

class DT_DLL_vrfutil DtRemoteConfigurationMapEntry;
class DtObjectType;
class DtEntityIdentifier;

#include "vrfutil/vrfutilDefines.h"
class DT_DLL_vrfutil DtRemoteConfigurationMapper : public DtReaderWriter
{
public:

   typedef std::list< std::pair<DtObjectType,DtRemoteConfigurationMapEntry*> > ObjTypeList;
   typedef ObjTypeList::iterator ObjTypeIterator;
   typedef ObjTypeList::const_iterator const_ObjTypeIterator;

   typedef std::map<DtEntityIdentifier,DtRemoteConfigurationMapEntry*> EntIdMap;
   typedef EntIdMap::iterator EntIdIterator;
   typedef EntIdMap::const_iterator const_EntIdIterator;

   typedef std::map<std::string,DtRemoteConfigurationMapEntry*> MarkingTextMap;
   typedef MarkingTextMap::iterator MarkingTextIterator;
   typedef MarkingTextMap::const_iterator const_MarkingTextIterator;

   typedef DtRemoteConfigurationMapEntry* (*CreatorFcn)();

public:
   DtRemoteConfigurationMapper();

   DtRemoteConfigurationMapper(const DtString& name, 
      DtReaderWriterRegistry* parentRegistry = NULL, 
      bool readonly = false);

   DtRemoteConfigurationMapper(const DtSymbolString& name, 
      DtReaderWriterRegistry* parentRegistry = NULL, 
      bool readonly = false);

   DtRemoteConfigurationMapper(const DtString& name, 
      const DtRemoteConfigurationMapper& orig,
      DtReaderWriterRegistry* parentRegistry = NULL);

   DtRemoteConfigurationMapper(const DtSymbolString& name, 
      const DtRemoteConfigurationMapper& orig,
      DtReaderWriterRegistry* parentRegistry = NULL);

   DtRemoteConfigurationMapper& operator=(const DtRemoteConfigurationMapper& orig);

   virtual ~DtRemoteConfigurationMapper();

public:

   virtual bool add(DtRemoteConfigurationMapEntry* pEntry);

   virtual void clear();
   
   virtual unsigned count() const;

   virtual void copyLists(const DtRemoteConfigurationMapper& orig);

   DtRemoteConfigurationMapper::EntIdMap& entityIdentifierMap();
   const DtRemoteConfigurationMapper::EntIdMap& entityIdentifierMap() const;

   virtual DtRemoteConfigurationMapEntry* find(const DtEntityIdentifier& id);
   virtual const DtRemoteConfigurationMapEntry* find(const DtEntityIdentifier& id) const;

   virtual DtRemoteConfigurationMapEntry* find(const DtObjectType& objType); 
   virtual const DtRemoteConfigurationMapEntry* find(const DtObjectType& objType) const; 

   virtual DtRemoteConfigurationMapEntry* find(const char* pMarkingText);
   virtual const DtRemoteConfigurationMapEntry* find(const char* pMarkingText) const;

   DtRemoteConfigurationMapper::ObjTypeList& objectTypeList();
   const DtRemoteConfigurationMapper::ObjTypeList& objectTypeList() const;
   
   DtRemoteConfigurationMapper::MarkingTextMap& markingTextMap();
   const DtRemoteConfigurationMapper::MarkingTextMap& markingTextMap() const;

   virtual bool readFile(const DtFilename& fname, const DtFilename& searchPath,
      const DtVariableBindingsList& variableBindings);

   virtual void remove(DtRemoteConfigurationMapEntry* pEntry,
      bool bDelete=true);

   DtRemoteConfigurationMapper::CreatorFcn creatorFcn() const;
   void setCreatorFcn(DtRemoteConfigurationMapper::CreatorFcn fcn);

protected:
   virtual bool addByEntityId(DtRemoteConfigurationMapEntry* pEntry);

   virtual bool addByObjectType(DtRemoteConfigurationMapEntry* pEntry);

   virtual bool addByMarkingText(DtRemoteConfigurationMapEntry* pEntry);

   virtual bool addByOther(DtRemoteConfigurationMapEntry* pEntry);

   virtual const DtRemoteConfigurationMapEntry* findBestMatch(const DtObjectType& objtype) const;

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

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

   virtual void removeByEntityId(DtRemoteConfigurationMapEntry* pEntry,
      bool bDelete=true);

   virtual void removeByObjectType(DtRemoteConfigurationMapEntry* pEntry,
      bool bDelete=true);

   virtual void removeByMarkingText(DtRemoteConfigurationMapEntry* pEntry,
      bool bDelete=true);

   virtual void removeByOther(DtRemoteConfigurationMapEntry* pEntry,
      bool bDelete=true);

protected:
   EntIdMap    myEntityIdMap;

   CreatorFcn  myEntryCreatorFcn;

   ObjTypeList myObjTypeList;

   MarkingTextMap myMarkingTextMap;
};

inline DtRemoteConfigurationMapper::CreatorFcn DtRemoteConfigurationMapper::creatorFcn() const{return (myEntryCreatorFcn);}
inline void DtRemoteConfigurationMapper::setCreatorFcn(DtRemoteConfigurationMapper::CreatorFcn fcn){myEntryCreatorFcn = fcn;}

inline DtRemoteConfigurationMapper::EntIdMap& DtRemoteConfigurationMapper::entityIdentifierMap()
{
   return (myEntityIdMap);
}

inline const DtRemoteConfigurationMapper::EntIdMap& DtRemoteConfigurationMapper::entityIdentifierMap() const
{
   return (myEntityIdMap);
}

inline DtRemoteConfigurationMapper::ObjTypeList& DtRemoteConfigurationMapper::objectTypeList()
{
   return (myObjTypeList);
}

inline const DtRemoteConfigurationMapper::ObjTypeList& DtRemoteConfigurationMapper::objectTypeList() const
{
   return (myObjTypeList);
}

inline DtRemoteConfigurationMapper::MarkingTextMap& DtRemoteConfigurationMapper::markingTextMap()
{
   return (myMarkingTextMap);
}

inline const DtRemoteConfigurationMapper::MarkingTextMap& DtRemoteConfigurationMapper::markingTextMap() const
{
   return (myMarkingTextMap);
}

#endif /* DtRemoteConfigurationMapper_H_ */