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) 2024 MaK Technologies, Inc.
3 ** All rights reserved.
4 *********************************************************************/
5 
6 #pragma once
7 
10 
13 #include <vrfutil/rwEntityType.h>
14 
15 #include <readerWriter/rwString.h>
16 
17 #include <vector>
18 
19 #include <vlpi/entityIdentifier.h>
20 
22 #include "vrfutil/vrfutilDefines.h"
24 {
25 public:
26 
29  {
30  UnspecifiedType = 0,
33  MarkingTextType
34  };
35 
36 public:
39 
42  DtReaderWriterRegistry* parentRegistry = NULL,
43  bool readonly = false);
44 
47  DtReaderWriterRegistry* parentRegistry = NULL,
48  bool readonly = false);
49 
52 
56  DtReaderWriterRegistry* parentRegistry = NULL);
57 
61  DtReaderWriterRegistry* parentRegistry = NULL);
62 
64  virtual ~DtRemoteConfigurationMapEntry() override;
65 
67  virtual DtRemoteConfigurationMapEntry* clone() const;
68 
71 
72 public:
73 
74  static DtRemoteConfigurationMapEntry* create();
75 
76 public:
77 
81  void setAttachByType(AttachByType atype);
83 
86  const DtString& configurationKeyName() const;
87  void setConfigurationKeyName(const DtString& keyname);
89 
92  const DtEntityIdentifier& entityIdentifier() const;
93  void setEntityIdentifier(const DtEntityIdentifier& eid);
95 
98  const std::vector<unsigned>& forceFilters() const;
99  virtual void setForceFilters(const std::vector<unsigned>& filters);
101 
104  const DtString& markingText() const;
105  void setMarkingText(const char *pStr);
106  void setMarkingText(const DtString& sStr);
108 
111  const DtEntityType& objectType() const;
112  virtual void setObjectType(const DtEntityType& otype);
114 
115 protected:
116 
118  virtual DtlObjPtr getData(DtlObjPtr args, const DtReaderWriter::SearchPaths& searchPaths,
119  const DtVariableBindingsList& variableBindings) override;
120 
123  virtual void parseAttachByField(DtlObjPtr dtlObjPtr);
124 
126  virtual void parseForceFilterField(DtlObjPtr dtlObjPtr);
127 
129  virtual void putData(std::string& fp, int indentLevel = 0) override;
130 
134  virtual void writeAttachBy(std::string& fp, int indentLevel = 0);
135 
137  virtual void writeForceFilter(std::string& fp, int indentLevel = 0);
138 
139 protected:
140 
143 
147 
149  DtEntityIdentifier myEntityIdentifier;
150 
152  std::vector<unsigned> myForceFilters;
153 
156 
159 };
160 
163 
166 
167 inline const DtEntityIdentifier& DtRemoteConfigurationMapEntry::entityIdentifier() const {return (myEntityIdentifier);}
168 inline void DtRemoteConfigurationMapEntry::setEntityIdentifier(const DtEntityIdentifier& eid) {myEntityIdentifier = eid;}
169 
170 inline const std::vector<unsigned>& DtRemoteConfigurationMapEntry::forceFilters() const {return (myForceFilters);}
171 
173 inline void DtRemoteConfigurationMapEntry::setMarkingText(const char *pStr) {myMarkingText = pStr;}
175 
176 inline const DtEntityType& DtRemoteConfigurationMapEntry::objectType() const {return (myObjectType);}
Definition: remoteConfigurationMapEntry.h:32
const DtEntityType & objectType() const
Used to identify entity by entity type enumeration.
Definition: remoteConfigurationMapEntry.h:176
const std::vector< unsigned > & forceFilters() const
Returns an array of force types to which this entry applies.
Definition: remoteConfigurationMapEntry.h:170
const DtEntityIdentifier & entityIdentifier() const
Used to identify entity by entity type enumeration.
Definition: remoteConfigurationMapEntry.h:167
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:162
Definition: remoteConfigurationMapEntry.h:31
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:164
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
DtRwEntityType myObjectType
Used to identify entity by entity type enumeration.
Definition: remoteConfigurationMapEntry.h:158
DtEntityIdentifier myEntityIdentifier
Used to identify explicity entity for attachment.
Definition: remoteConfigurationMapEntry.h:149
void setEntityIdentifier(const DtEntityIdentifier &eid)
Used to identify entity by entity type enumeration.
Definition: remoteConfigurationMapEntry.h:168
DtRwString myConfigurationKeyName
This key name must match one of the remote configuration entry keys in the OPD.
Definition: remoteConfigurationMapEntry.h:146
This file declares DtRemoteConfigurationMapEntry.
Definition: remoteConfigurationMapEntry.h:23
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:172
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:173
AttachByType
Attachment Type enumerations, used as a rule to select entities for attachment.
Definition: remoteConfigurationMapEntry.h:28
File: rwEntType.h.
Definition: rwEntityType.h:26
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:155
#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:152
AttachByType myAttachByType
Qualifier to identify entities to which attachment should be applied.
Definition: remoteConfigurationMapEntry.h:142
DtRemoteConfigurationMapEntry::AttachByType attachByType() const
Describes the rule by which entities will be identified for attachment.
Definition: remoteConfigurationMapEntry.h:161
void setConfigurationKeyName(const DtString &keyname)
Get/set component configuration filename.
Definition: remoteConfigurationMapEntry.h:165

Document ID: Generated on Thu Oct 23 22:29:17 EDT 2025 from SVN revision 280951
Copyright © 2005-2024 MAK Technologies. All Rights Reserved (www.mak.com)