include/vrfutil/remoteConfigurationMapEntry.h

Go to the documentation of this file.

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

#ifndef DtRemoteConfigurationMapEntry_H_
#define DtRemoteConfigurationMapEntry_H_


#include "vrfutil/rdrWritr.h"
#include "vrfutil/rwObjType.h"

#include "vrfutil/rwString.h"

#include <vector>

#include <vlpi/entityIdentifier.h>

#include "vrfutil/vrfutilDefines.h"
class DT_DLL_vrfutil DtRemoteConfigurationMapEntry : public DtReaderWriter
{
public: 
   
   enum AttachByType
   {
      UnspecifiedType = 0,
      ObjectType,
      EntityIdType,
      MarkingTextType
   };

public:
   DtRemoteConfigurationMapEntry();

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

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

   DtRemoteConfigurationMapEntry(const DtRemoteConfigurationMapEntry& orig);

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

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

   virtual ~DtRemoteConfigurationMapEntry();

   virtual DtRemoteConfigurationMapEntry* clone() const;

   DtRemoteConfigurationMapEntry& operator=(const DtRemoteConfigurationMapEntry& orig);

public:

   static DtRemoteConfigurationMapEntry* create();

public:

   DtRemoteConfigurationMapEntry::AttachByType attachByType() const;
   void setAttachByType(AttachByType atype);

   const DtString& configurationKeyName() const;
   void setConfigurationKeyName(const DtString& keyname);

   const DtEntityIdentifier& entityIdentifier() const;
   void setEntityIdentifier(const DtEntityIdentifier& eid);

   const std::vector<unsigned>& forceFilters() const;
   virtual void setForceFilters(const std::vector<unsigned>& filters);

   const DtString& markingText() const;
   void setMarkingText(const char *pStr);
   void setMarkingText(const DtString& sStr);

   const DtObjectType& objectType() const;
   virtual void setObjectType(const DtObjectType& otype);

protected:

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

   virtual void parseAttachByField(DtlObjPtr dtlObjPtr);

   virtual void parseForceFilterField(DtlObjPtr dtlObjPtr);

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

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

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

protected:

   AttachByType myAttachByType;

   DtRwString myConfigurationKeyName;

   DtEntityIdentifier myEntityIdentifier;

   std::vector<unsigned> myForceFilters;

   DtString myMarkingText;

   DtRwObjectType myObjectType;
};

inline DtRemoteConfigurationMapEntry::AttachByType DtRemoteConfigurationMapEntry::attachByType() const{return (myAttachByType);}
inline void DtRemoteConfigurationMapEntry::setAttachByType(AttachByType atype){myAttachByType = atype;}

inline const DtString& DtRemoteConfigurationMapEntry::configurationKeyName() const {return (myConfigurationKeyName);}
inline void DtRemoteConfigurationMapEntry::setConfigurationKeyName(const DtString& keyname) {myConfigurationKeyName = keyname;}

inline const DtEntityIdentifier& DtRemoteConfigurationMapEntry::entityIdentifier() const {return (myEntityIdentifier);}
inline void DtRemoteConfigurationMapEntry::setEntityIdentifier(const DtEntityIdentifier& eid) {myEntityIdentifier = eid;}

inline const std::vector<unsigned>& DtRemoteConfigurationMapEntry::forceFilters() const {return (myForceFilters);}

inline const DtString& DtRemoteConfigurationMapEntry::markingText() const {return (myMarkingText);}
inline void DtRemoteConfigurationMapEntry::setMarkingText(const char *pStr) {myMarkingText = pStr;}
inline void DtRemoteConfigurationMapEntry::setMarkingText(const DtString& sStr) {myMarkingText = sStr;}

inline const DtObjectType& DtRemoteConfigurationMapEntry::objectType() const {return (myObjectType);}

#endif /* DtRemoteConfigurationMapEntry_H_ */