VR-Forces Developer's Guide
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
remoteConfigurationMapEntry.h
Go to the documentation of this file.
1 /*********************************************************************
2 ** Copyright (c) 2008 MaK Technologies, Inc.
3 ** All rights reserved.
4 *********************************************************************/
5 /*********************************************************************
6 ** $RCSfile: remoteConfigurationMapEntry.h,v $ $Revision: 1.2 $ $State: Exp $
7 *********************************************************************/
8 
9 #ifndef DtRemoteConfigurationMapEntry_H_
10 #define DtRemoteConfigurationMapEntry_H_
11 
14 
18 
19 #include <readerWriter/rwString.h>
20 
21 #include <vector>
22 
23 #include <vlpi/entityIdentifier.h>
24 
26 #include "vrfutil/vrfutilDefines.h"
28 {
29 public:
30 
33  {
34  UnspecifiedType = 0,
37  MarkingTextType
38  };
39 
40 public:
43 
46  DtReaderWriterRegistry* parentRegistry = NULL,
47  bool readonly = false);
48 
51  DtReaderWriterRegistry* parentRegistry = NULL,
52  bool readonly = false);
53 
56 
60  DtReaderWriterRegistry* parentRegistry = NULL);
61 
65  DtReaderWriterRegistry* parentRegistry = NULL);
66 
69 
71  virtual DtRemoteConfigurationMapEntry* clone() const;
72 
75 
76 public:
77 
78  static DtRemoteConfigurationMapEntry* create();
79 
80 public:
81 
85  void setAttachByType(AttachByType atype);
87 
90  const DtString& configurationKeyName() const;
91  void setConfigurationKeyName(const DtString& keyname);
93 
96  const DtEntityIdentifier& entityIdentifier() const;
97  void setEntityIdentifier(const DtEntityIdentifier& eid);
99 
102  const std::vector<unsigned>& forceFilters() const;
103  virtual void setForceFilters(const std::vector<unsigned>& filters);
105 
108  const DtString& markingText() const;
109  void setMarkingText(const char *pStr);
110  void setMarkingText(const DtString& sStr);
112 
115  const DtObjectType& objectType() const;
116  virtual void setObjectType(const DtObjectType& otype);
118 
119 protected:
120 
122  virtual DtlObjPtr getData(DtlObjPtr args, const DtReaderWriter::SearchPaths& searchPaths,
123  const DtVariableBindingsList& variableBindings);
124 
127  virtual void parseAttachByField(DtlObjPtr dtlObjPtr);
128 
130  virtual void parseForceFilterField(DtlObjPtr dtlObjPtr);
131 
133  virtual void putData(std::string& fp, int indentLevel = 0);
134 
138  virtual void writeAttachBy(std::string& fp, int indentLevel = 0);
139 
141  virtual void writeForceFilter(std::string& fp, int indentLevel = 0);
142 
143 protected:
144 
147 
151 
153  DtEntityIdentifier myEntityIdentifier;
154 
156  std::vector<unsigned> myForceFilters;
157 
160 
163 };
164 
167 
170 
171 inline const DtEntityIdentifier& DtRemoteConfigurationMapEntry::entityIdentifier() const {return (myEntityIdentifier);}
172 inline void DtRemoteConfigurationMapEntry::setEntityIdentifier(const DtEntityIdentifier& eid) {myEntityIdentifier = eid;}
173 
174 inline const std::vector<unsigned>& DtRemoteConfigurationMapEntry::forceFilters() const {return (myForceFilters);}
175 
177 inline void DtRemoteConfigurationMapEntry::setMarkingText(const char *pStr) {myMarkingText = pStr;}
179 
181 
182 #endif /* DtRemoteConfigurationMapEntry_H_ */
Definition: remoteConfigurationMapEntry.h:36
const std::vector< unsigned > & forceFilters() const
Returns an array of force types to which this entry applies.
Definition: remoteConfigurationMapEntry.h:174
const DtEntityIdentifier & entityIdentifier() const
Used to identify entity by entity type enumeration.
Definition: remoteConfigurationMapEntry.h:171
This class allows one to collect and compare strings using an index number instead of having to do st...
Definition: symbolString.h:27
void setAttachByType(AttachByType atype)
Describes the rule by which entities will be identified for attachment.
Definition: remoteConfigurationMapEntry.h:166
class DtRwObjectType:
Definition: rwObjectType.h:18
Definition: remoteConfigurationMapEntry.h:35
virtual DtlObjPtr getData(DtlObjPtr args, const SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)
Deriving class overrides these to get/put class specific data.
const DtString & configurationKeyName() const
Get/set component configuration filename.
Definition: remoteConfigurationMapEntry.h:168
Definition: readerWriter.h:85
Description: Readable, Writable DtString Variable substitutions are done on this object when it is re...
Definition: rwString.h:20
Definition: readerWriterRegistry.h:39
Definition: objectType.h:27
DtEntityIdentifier myEntityIdentifier
Used to identify explicity entity for attachment.
Definition: remoteConfigurationMapEntry.h:153
void setEntityIdentifier(const DtEntityIdentifier &eid)
Used to identify entity by entity type enumeration.
Definition: remoteConfigurationMapEntry.h:172
DtRwString myConfigurationKeyName
This key name must match one of the remote configuration entry keys in the OPD.
Definition: remoteConfigurationMapEntry.h:150
This file declares DtRemoteConfigurationMapEntry.
Definition: remoteConfigurationMapEntry.h:27
std::list< const DtRwVariableBindings * > DtVariableBindingsList
Definition: readerWriterRegistry.h:29
const DtString & markingText() const
Used to explicitly identify an entity by marking text.
Definition: remoteConfigurationMapEntry.h:176
DtRwObjectType myObjectType
Used to identify entity by entity type enumeration.
Definition: remoteConfigurationMapEntry.h:162
std::vector< DtFilename > SearchPaths
Definition: readerWriter.h:92
void setMarkingText(const char *pStr)
Used to explicitly identify an entity by marking text.
Definition: remoteConfigurationMapEntry.h:177
AttachByType
Attachment Type enumerations, used as a rule to select entities for attachment.
Definition: remoteConfigurationMapEntry.h:32
class DT_DLL_vrfutil DtRemoteConfigurationMapEntry
This file declares DtRemoteConfigurationMapper.
Definition: remoteConfigurationMapper.h:22
virtual void putData(std::string &fp, int indentLevel=0)
Deriving class overrides these to get/put class specific data.
DtString myMarkingText
Used to explicitly identify an entity by marking text.
Definition: remoteConfigurationMapEntry.h:159
const DtObjectType & objectType() const
Used to identify entity by entity type enumeration.
Definition: remoteConfigurationMapEntry.h:180
#define DT_DLL_vrfutil
This file is used to determine how to build Disable inconsistent dll linkage warning Visual Studio 6...
Definition: vrfutilDefines.h:34
const DtReaderWriter & operator=(const DtReaderWriter &orig)
assignment operator
std::vector< unsigned > myForceFilters
An array of force types to which this entry applies.
Definition: remoteConfigurationMapEntry.h:156
AttachByType myAttachByType
Qualifier to identify entities to which attachment should be applied.
Definition: remoteConfigurationMapEntry.h:146
DtRemoteConfigurationMapEntry::AttachByType attachByType() const
Describes the rule by which entities will be identified for attachment.
Definition: remoteConfigurationMapEntry.h:165
void setConfigurationKeyName(const DtString &keyname)
Get/set component configuration filename.
Definition: remoteConfigurationMapEntry.h:169

Document ID: Generated on Wed Mar 27 22:49:11 EDT 2024 from SVN revision 264633
Copyright © 2005-2024 MAK Technologies. All Rights Reserved (www.mak.com)