remoteConfigurationEntry.h

Go to the documentation of this file.

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

#ifndef DtRemoteConfigurationEntry_H_
#define DtRemoteConfigurationEntry_H_


#include "vrfutil/readerWriter.h"

#include "vrfutil/rwString.h"
#include "vrfutil/rwVariableBindings.h"

#include <map>

#include "vrfutil/vrfutilDefines.h"
class DT_DLL_vrfutil DtRemoteConfigurationEntry : public DtReaderWriter
{
public:
   typedef DtRemoteConfigurationEntry* (*CreatorFcn)(const DtString& name, 
      DtReaderWriterRegistry* parentRegistry);

   typedef std::map<std::string, DtReaderWriter*> SharedParameterPartsMap;
   typedef SharedParameterPartsMap::iterator SharedPartsIterator;
   typedef SharedParameterPartsMap::const_iterator const_SharedPartsIterator;

public:
   DtRemoteConfigurationEntry();

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

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

   DtRemoteConfigurationEntry(const DtRemoteConfigurationEntry& orig);

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

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

   virtual ~DtRemoteConfigurationEntry();

   virtual DtRemoteConfigurationEntry* clone() const;

   DtRemoteConfigurationEntry& operator=(const DtRemoteConfigurationEntry& orig);

public:

   static DtRemoteConfigurationEntry* create(const DtString& name, 
      DtReaderWriterRegistry* parentRegistry);

public:

   virtual bool addSharedParameterPart(DtReaderWriter *pParamPart);

   virtual void clearSharedParameterParts();

   const DtString& componentConfigurationFilename() const;
   void setComponentConfigurationFilename(const DtString& fn);

   virtual DtReaderWriter* findSharedParameterPart(const char *pKeyName);

   const DtString& keyName() const;
   void setKeyName(const DtString& kname);

   virtual void setVariableBindings(const DtVariableBindingsSharedPtr& bindings);
   virtual DtVariableBindingsSharedPtr variableBindings();

   SharedParameterPartsMap& sharedParameterParts();
   const SharedParameterPartsMap& sharedParameterParts() const;

protected:

   DtRwString myConfigurationFilePath;

   DtRwString myKeyName;

   SharedParameterPartsMap mySharedParameterParts;

   DtVariableBindingsSharedPtr myVariableBindings;
};

inline const DtString& DtRemoteConfigurationEntry::componentConfigurationFilename() const {return (myConfigurationFilePath);}
inline void DtRemoteConfigurationEntry::setComponentConfigurationFilename(const DtString& fn) {myConfigurationFilePath = fn;}

inline const DtString& DtRemoteConfigurationEntry::keyName() const {return (myKeyName);}
inline void DtRemoteConfigurationEntry::setKeyName(const DtString& kname){myKeyName = kname;}

inline DtRemoteConfigurationEntry::SharedParameterPartsMap& DtRemoteConfigurationEntry::sharedParameterParts() {return (mySharedParameterParts);}
inline const DtRemoteConfigurationEntry::SharedParameterPartsMap& DtRemoteConfigurationEntry::sharedParameterParts() const {return (mySharedParameterParts);}

#endif /* DtRemoteConfigurationEntry_H_ */